Skip to content

Commit e6b70dc

Browse files
toga4toga4
authored
Add http_target field to google_cloud_tasks_queue (#11544)
1 parent cf7fa9d commit e6b70dc

File tree

4 files changed

+411
-0
lines changed

4 files changed

+411
-0
lines changed

‎mmv1/products/cloudtasks/Queue.yaml

+174
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,16 @@ examples:
4545
- 'app_engine_routing_override.0.instance'
4646
vars:
4747
name: 'instance-name'
48+
- !ruby/object:Provider::Terraform::Examples
49+
name: 'cloud_tasks_queue_http_target_oidc'
50+
primary_resource_id: 'http_target_oidc'
51+
vars:
52+
name: 'cloud-tasks-queue-http-target-oidc'
53+
- !ruby/object:Provider::Terraform::Examples
54+
name: 'cloud_tasks_queue_http_target_oauth'
55+
primary_resource_id: 'http_target_oauth'
56+
vars:
57+
name: 'cloud-tasks-queue-http-target-oauth'
4858
parameters:
4959
- !ruby/object:Api::Type::String
5060
name: 'location'
@@ -195,3 +205,167 @@ properties:
195205
Specifies the fraction of operations to write to Stackdriver Logging.
196206
This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the
197207
default and means that no operations are logged.
208+
- !ruby/object:Api::Type::NestedObject
209+
name: 'httpTarget'
210+
description: Modifies HTTP target for HTTP tasks.
211+
properties:
212+
- !ruby/object:Api::Type::Enum
213+
name: 'httpMethod'
214+
description: |
215+
The HTTP method to use for the request.
216+
217+
When specified, it overrides HttpRequest for the task.
218+
Note that if the value is set to GET the body of the task will be ignored at execution time.
219+
values:
220+
- HTTP_METHOD_UNSPECIFIED
221+
- POST
222+
- GET
223+
- HEAD
224+
- PUT
225+
- DELETE
226+
- PATCH
227+
- OPTIONS
228+
default_from_api: true
229+
- !ruby/object:Api::Type::NestedObject
230+
name: 'uriOverride'
231+
description: |
232+
URI override.
233+
234+
When specified, overrides the execution URI for all the tasks in the queue.
235+
properties:
236+
- !ruby/object:Api::Type::Enum
237+
name: 'scheme'
238+
description: |
239+
Scheme override.
240+
241+
When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).
242+
values:
243+
- 'HTTP'
244+
- 'HTTPS'
245+
default_from_api: true
246+
- !ruby/object:Api::Type::String
247+
name: 'host'
248+
description: |
249+
Host override.
250+
251+
When specified, replaces the host part of the task URL.
252+
For example, if the task URL is "https://www.google.com", and host value
253+
is set to "example.net", the overridden URI will be changed to "https://example.net".
254+
Host value cannot be an empty string (INVALID_ARGUMENT).
255+
- !ruby/object:Api::Type::String
256+
name: 'port'
257+
description: |
258+
Port override.
259+
260+
When specified, replaces the port part of the task URI.
261+
For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo.
262+
Note that the port value must be a positive integer.
263+
Setting the port to 0 (Zero) clears the URI port.
264+
- !ruby/object:Api::Type::NestedObject
265+
name: 'pathOverride'
266+
description: |
267+
URI path.
268+
269+
When specified, replaces the existing path of the task URL.
270+
Setting the path value to an empty string clears the URI path segment.
271+
properties:
272+
- !ruby/object:Api::Type::String
273+
name: 'path'
274+
description: The URI path (e.g., /users/1234). Default is an empty string.
275+
default_from_api: true
276+
- !ruby/object:Api::Type::NestedObject
277+
name: 'queryOverride'
278+
description: |
279+
URI query.
280+
281+
When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment.
282+
properties:
283+
- !ruby/object:Api::Type::String
284+
name: 'queryParams'
285+
description: The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.
286+
default_from_api: true
287+
- !ruby/object:Api::Type::Enum
288+
name: 'uriOverrideEnforceMode'
289+
description: |
290+
URI Override Enforce Mode
291+
292+
When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.
293+
values:
294+
- ALWAYS
295+
- IF_NOT_EXISTS
296+
default_from_api: true
297+
- !ruby/object:Api::Type::Array
298+
name: 'headerOverrides'
299+
description: |
300+
HTTP target headers.
301+
302+
This map contains the header field names and values.
303+
Headers will be set when running the CreateTask and/or BufferTask.
304+
305+
These headers represent a subset of the headers that will be configured for the task's HTTP request.
306+
Some HTTP request headers will be ignored or replaced.
307+
308+
Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values.
309+
310+
The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue.
311+
item_type: !ruby/object:Api::Type::NestedObject
312+
properties:
313+
- !ruby/object:Api::Type::NestedObject
314+
name: 'header'
315+
description: |
316+
Header embodying a key and a value.
317+
required: true
318+
properties:
319+
- !ruby/object:Api::Type::String
320+
name: 'key'
321+
required: true
322+
description: The Key of the header.
323+
- !ruby/object:Api::Type::String
324+
name: 'value'
325+
required: true
326+
description: The Value of the header.
327+
- !ruby/object:Api::Type::NestedObject
328+
name: 'oauthToken'
329+
description: |
330+
If specified, an OAuth token is generated and attached as the Authorization header in the HTTP request.
331+
332+
This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com.
333+
Note that both the service account email and the scope MUST be specified when using the queue-level authorization override.
334+
conflicts:
335+
- 'oidcToken'
336+
properties:
337+
- !ruby/object:Api::Type::String
338+
name: 'serviceAccountEmail'
339+
description: |
340+
Service account email to be used for generating OAuth token.
341+
The service account must be within the same project as the queue.
342+
The caller must have iam.serviceAccounts.actAs permission for the service account.
343+
required: true
344+
- !ruby/object:Api::Type::String
345+
name: 'scope'
346+
description: |
347+
OAuth scope to be used for generating OAuth access token.
348+
If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.
349+
default_from_api: true
350+
- !ruby/object:Api::Type::NestedObject
351+
name: 'oidcToken'
352+
description: |
353+
If specified, an OIDC token is generated and attached as an Authorization header in the HTTP request.
354+
355+
This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
356+
Note that both the service account email and the audience MUST be specified when using the queue-level authorization override.
357+
conflicts:
358+
- 'oauthToken'
359+
properties:
360+
- !ruby/object:Api::Type::String
361+
name: 'serviceAccountEmail'
362+
description: |
363+
Service account email to be used for generating OIDC token.
364+
The service account must be within the same project as the queue.
365+
The caller must have iam.serviceAccounts.actAs permission for the service account.
366+
required: true
367+
- !ruby/object:Api::Type::String
368+
name: 'audience'
369+
description: |
370+
Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.
371+
default_from_api: true

‎mmv1/templates/terraform/examples/cloud_tasks_queue_http_target_oauth.tf.erb

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
resource "google_cloud_tasks_queue" "<%= ctx[:primary_resource_id] %>" {
2+
name = "<%= ctx[:vars]["name"] %>"
3+
location = "us-central1"
4+
5+
http_target {
6+
http_method = "POST"
7+
uri_override {
8+
scheme = "HTTPS"
9+
host = "oauth.example.com"
10+
port = 8443
11+
path_override {
12+
path = "/users/1234"
13+
}
14+
query_override {
15+
query_params = "qparam1=123&qparam2=456"
16+
}
17+
uri_override_enforce_mode = "IF_NOT_EXISTS"
18+
}
19+
header_overrides {
20+
header {
21+
key = "AddSomethingElse"
22+
value = "MyOtherValue"
23+
}
24+
}
25+
header_overrides {
26+
header {
27+
key = "AddMe"
28+
value = "MyValue"
29+
}
30+
}
31+
oauth_token {
32+
service_account_email = google_service_account.oauth_service_account.email
33+
scope = "openid https://www.googleapis.com/auth/userinfo.email"
34+
}
35+
}
36+
}
37+
38+
resource "google_service_account" "oauth_service_account" {
39+
account_id = "example-oauth"
40+
display_name = "Tasks Queue OAuth Service Account"
41+
}

‎mmv1/templates/terraform/examples/cloud_tasks_queue_http_target_oidc.tf.erb

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
resource "google_cloud_tasks_queue" "<%= ctx[:primary_resource_id] %>" {
2+
name = "<%= ctx[:vars]["name"] %>"
3+
location = "us-central1"
4+
5+
http_target {
6+
http_method = "POST"
7+
uri_override {
8+
scheme = "HTTPS"
9+
host = "oidc.example.com"
10+
port = 8443
11+
path_override {
12+
path = "/users/1234"
13+
}
14+
query_override {
15+
query_params = "qparam1=123&qparam2=456"
16+
}
17+
uri_override_enforce_mode = "IF_NOT_EXISTS"
18+
}
19+
header_overrides {
20+
header {
21+
key = "AddSomethingElse"
22+
value = "MyOtherValue"
23+
}
24+
}
25+
header_overrides {
26+
header {
27+
key = "AddMe"
28+
value = "MyValue"
29+
}
30+
}
31+
oidc_token {
32+
service_account_email = google_service_account.oidc_service_account.email
33+
audience = "https://oidc.example.com"
34+
}
35+
}
36+
}
37+
38+
resource "google_service_account" "oidc_service_account" {
39+
account_id = "example-oidc"
40+
display_name = "Tasks Queue OIDC Service Account"
41+
}

0 commit comments

Comments
 (0)