Skip to content

Commit fbd4603

Browse files
Don't render nested properties in top level required arguments section in dcl resources doc (#13712) (#22397)
[upstream:9b072985f63e92ad9c67dc865a8ff71c3dafde71] Signed-off-by: Modular Magician <[email protected]>
1 parent 29352e2 commit fbd4603

7 files changed

+96
-96
lines changed

website/docs/r/apikeys_key.html.markdown

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -130,16 +130,6 @@ The following arguments are supported:
130130

131131

132132

133-
The `allowed_applications` block supports:
134-
135-
* `package_name` -
136-
(Required)
137-
The package name of the application.
138-
139-
* `sha1_fingerprint` -
140-
(Required)
141-
The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
142-
143133
- - -
144134

145135
* `display_name` -
@@ -184,6 +174,16 @@ The `android_key_restrictions` block supports:
184174
(Required)
185175
A list of Android applications that are allowed to make API calls with this key.
186176

177+
The `allowed_applications` block supports:
178+
179+
* `package_name` -
180+
(Required)
181+
The package name of the application.
182+
183+
* `sha1_fingerprint` -
184+
(Required)
185+
The SHA1 fingerprint of the application. For example, both sha1 formats are acceptable : DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 or DA39A3EE5E6B4B0D3255BFEF95601890AFD80709. Output format is the latter.
186+
187187
The `api_targets` block supports:
188188

189189
* `methods` -

website/docs/r/clouddeploy_delivery_pipeline.html.markdown

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -257,32 +257,6 @@ The following arguments are supported:
257257

258258

259259

260-
The `phase_configs` block supports:
261-
262-
* `percentage` -
263-
(Required)
264-
Required. Percentage deployment for the phase.
265-
266-
* `phase_id` -
267-
(Required)
268-
Required. The ID to assign to the `Rollout` phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
269-
270-
* `postdeploy` -
271-
(Optional)
272-
Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.
273-
274-
* `predeploy` -
275-
(Optional)
276-
Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.
277-
278-
* `profiles` -
279-
(Optional)
280-
Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
281-
282-
* `verify` -
283-
(Optional)
284-
Whether to run verify tests after the deployment.
285-
286260
- - -
287261

288262
* `annotations` -
@@ -411,6 +385,32 @@ The `custom_canary_deployment` block supports:
411385
(Required)
412386
Required. Configuration for each phase in the canary deployment in the order executed.
413387

388+
The `phase_configs` block supports:
389+
390+
* `percentage` -
391+
(Required)
392+
Required. Percentage deployment for the phase.
393+
394+
* `phase_id` -
395+
(Required)
396+
Required. The ID to assign to the `Rollout` phase. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
397+
398+
* `postdeploy` -
399+
(Optional)
400+
Optional. Configuration for the postdeploy job of this phase. If this is not configured, postdeploy job will not be present for this phase.
401+
402+
* `predeploy` -
403+
(Optional)
404+
Optional. Configuration for the predeploy job of this phase. If this is not configured, predeploy job will not be present for this phase.
405+
406+
* `profiles` -
407+
(Optional)
408+
Skaffold profiles to use when rendering the manifest for this phase. These are in addition to the profiles list specified in the `DeliveryPipeline` stage.
409+
410+
* `verify` -
411+
(Optional)
412+
Whether to run verify tests after the deployment.
413+
414414
The `postdeploy` block supports:
415415

416416
* `actions` -

website/docs/r/container_aws_cluster.html.markdown

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -351,12 +351,6 @@ The `authorization` block supports:
351351
(Required)
352352
Users to perform operations as a cluster admin. A managed ClusterRoleBinding will be created to grant the `cluster-admin` ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles
353353

354-
The `admin_users` block supports:
355-
356-
* `username` -
357-
(Required)
358-
The name of the user, e.g. `[email protected]`.
359-
360354
The `control_plane` block supports:
361355

362356
* `aws_services_authentication` -
@@ -415,28 +409,6 @@ The `control_plane` block supports:
415409
(Required)
416410
The Kubernetes version to run on control plane replicas (e.g. `1.19.10-gke.1000`). You can list all supported versions on a given Google Cloud region by calling .
417411

418-
The `aws_services_authentication` block supports:
419-
420-
* `role_arn` -
421-
(Required)
422-
The Amazon Resource Name (ARN) of the role that the Anthos Multi-Cloud API will assume when managing AWS resources on your account.
423-
424-
* `role_session_name` -
425-
(Optional)
426-
Optional. An identifier for the assumed role session. When unspecified, it defaults to `multicloud-service-agent`.
427-
428-
The `config_encryption` block supports:
429-
430-
* `kms_key_arn` -
431-
(Required)
432-
The ARN of the AWS KMS key used to encrypt cluster configuration.
433-
434-
The `database_encryption` block supports:
435-
436-
* `kms_key_arn` -
437-
(Required)
438-
The ARN of the AWS KMS key used to encrypt cluster secrets.
439-
440412
The `fleet` block supports:
441413

442414
* `membership` -
@@ -497,12 +469,40 @@ The `admin_groups` block supports:
497469
(Required)
498470
The name of the group, e.g. `[email protected]`.
499471

472+
The `admin_users` block supports:
473+
474+
* `username` -
475+
(Required)
476+
The name of the user, e.g. `[email protected]`.
477+
500478
The `binary_authorization` block supports:
501479

502480
* `evaluation_mode` -
503481
(Optional)
504482
Mode of operation for Binary Authorization policy evaluation. Possible values: DISABLED, PROJECT_SINGLETON_POLICY_ENFORCE
505483

484+
The `aws_services_authentication` block supports:
485+
486+
* `role_arn` -
487+
(Required)
488+
The Amazon Resource Name (ARN) of the role that the Anthos Multi-Cloud API will assume when managing AWS resources on your account.
489+
490+
* `role_session_name` -
491+
(Optional)
492+
Optional. An identifier for the assumed role session. When unspecified, it defaults to `multicloud-service-agent`.
493+
494+
The `config_encryption` block supports:
495+
496+
* `kms_key_arn` -
497+
(Required)
498+
The ARN of the AWS KMS key used to encrypt cluster configuration.
499+
500+
The `database_encryption` block supports:
501+
502+
* `kms_key_arn` -
503+
(Required)
504+
The ARN of the AWS KMS key used to encrypt cluster secrets.
505+
506506
The `instance_placement` block supports:
507507

508508
* `tenancy` -

website/docs/r/container_aws_node_pool.html.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -618,12 +618,6 @@ The `config` block supports:
618618
(Optional)
619619
Optional. The initial taints assigned to nodes of this node pool.
620620

621-
The `config_encryption` block supports:
622-
623-
* `kms_key_arn` -
624-
(Required)
625-
The ARN of the AWS KMS key used to encrypt node pool configuration.
626-
627621
The `max_pods_constraint` block supports:
628622

629623
* `max_pods_per_node` -
@@ -667,6 +661,12 @@ The `autoscaling_metrics_collection` block supports:
667661
(Optional)
668662
The metrics to enable. For a list of valid metrics, see https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_EnableMetricsCollection.html. If you specify granularity and don't specify any metrics, all metrics are enabled.
669663

664+
The `config_encryption` block supports:
665+
666+
* `kms_key_arn` -
667+
(Required)
668+
The ARN of the AWS KMS key used to encrypt node pool configuration.
669+
670670
The `instance_placement` block supports:
671671

672672
* `tenancy` -

website/docs/r/container_azure_cluster.html.markdown

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -194,12 +194,6 @@ The `authorization` block supports:
194194
(Required)
195195
Users that can perform operations as a cluster admin. A new ClusterRoleBinding will be created to grant the cluster-admin ClusterRole to the users. Up to ten admin users can be provided. For more info on RBAC, see https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles
196196

197-
The `admin_users` block supports:
198-
199-
* `username` -
200-
(Required)
201-
The name of the user, e.g. `[email protected]`.
202-
203197
The `control_plane` block supports:
204198

205199
* `database_encryption` -
@@ -242,12 +236,6 @@ The `control_plane` block supports:
242236
(Optional)
243237
Optional. The Azure VM size name. Example: `Standard_DS2_v2`. For available VM sizes, see https://docs.microsoft.com/en-us/azure/virtual-machines/vm-naming-conventions. When unspecified, it defaults to `Standard_DS2_v2`.
244238

245-
The `ssh_config` block supports:
246-
247-
* `authorized_key` -
248-
(Required)
249-
The SSH public key data for VMs managed by Anthos. This accepts the authorized_keys file format used in OpenSSH according to the sshd(8) manual page.
250-
251239
The `fleet` block supports:
252240

253241
* `membership` -
@@ -308,6 +296,12 @@ The `admin_groups` block supports:
308296
(Required)
309297
The name of the group, e.g. `[email protected]`.
310298

299+
The `admin_users` block supports:
300+
301+
* `username` -
302+
(Required)
303+
The name of the user, e.g. `[email protected]`.
304+
311305
The `azure_services_authentication` block supports:
312306

313307
* `application_id` -
@@ -356,6 +350,12 @@ The `root_volume` block supports:
356350
(Optional)
357351
Optional. The size of the disk, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource.
358352

353+
The `ssh_config` block supports:
354+
355+
* `authorized_key` -
356+
(Required)
357+
The SSH public key data for VMs managed by Anthos. This accepts the authorized_keys file format used in OpenSSH according to the sshd(8) manual page.
358+
359359
The `logging_config` block supports:
360360

361361
* `component_config` -

website/docs/r/container_azure_node_pool.html.markdown

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -211,12 +211,6 @@ The `config` block supports:
211211
(Optional)
212212
Optional. The Azure VM size name. Example: `Standard_DS2_v2`. See (/anthos/clusters/docs/azure/reference/supported-vms) for options. When unspecified, it defaults to `Standard_DS2_v2`.
213213

214-
The `ssh_config` block supports:
215-
216-
* `authorized_key` -
217-
(Required)
218-
The SSH public key data for VMs managed by Anthos. This accepts the authorized_keys file format used in OpenSSH according to the sshd(8) manual page.
219-
220214
The `max_pods_constraint` block supports:
221215

222216
* `max_pods_per_node` -
@@ -262,6 +256,12 @@ The `root_volume` block supports:
262256
(Optional)
263257
Optional. The size of the disk, in GiBs. When unspecified, a default value is provided. See the specific reference in the parent resource.
264258

259+
The `ssh_config` block supports:
260+
261+
* `authorized_key` -
262+
(Required)
263+
The SSH public key data for VMs managed by Anthos. This accepts the authorized_keys file format used in OpenSSH according to the sshd(8) manual page.
264+
265265
The `management` block supports:
266266

267267
* `auto_repair` -

website/docs/r/firebaserules_ruleset.html.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,14 @@ The `source` block supports:
8080
(Optional)
8181
`Language` of the `Source` bundle. If unspecified, the language will default to `FIREBASE_RULES`. Possible values: LANGUAGE_UNSPECIFIED, FIREBASE_RULES, EVENT_FLOW_TRIGGERS
8282

83+
- - -
84+
85+
* `project` -
86+
(Optional)
87+
The project for the resource
88+
89+
90+
8391
The `files` block supports:
8492

8593
* `content` -
@@ -94,14 +102,6 @@ The `files` block supports:
94102
(Required)
95103
File name.
96104

97-
- - -
98-
99-
* `project` -
100-
(Optional)
101-
The project for the resource
102-
103-
104-
105105
## Attributes Reference
106106

107107
In addition to the arguments listed above, the following computed attributes are exported:

0 commit comments

Comments
 (0)