From a446b6ef7c441742d99646eb08b486181d64978e Mon Sep 17 00:00:00 2001 From: Modular Magician Date: Fri, 15 Oct 2021 15:16:09 +0000 Subject: [PATCH] Align manually generated documentation with #5192 (#5279) * Align manually generated documentation with #5192 This commit add internal links for nested types to manually generated pages, similar to #5192. * Fix broken documentation links Signed-off-by: Modular Magician --- .changelog/5279.txt | 3 + ...ud_identity_group_membership.html.markdown | 16 +- .../d/cloud_identity_groups.html.markdown | 8 +- .../d/cloudfunctions_function.html.markdown | 12 +- website/docs/d/compute_instance.html.markdown | 48 +++--- .../d/compute_instance_template.html.markdown | 42 ++--- .../docs/d/compute_subnetwork.html.markdown | 4 +- website/docs/d/dns_keys.html.markdown | 4 +- ...me_server_deployment_rollout.html.markdown | 8 +- website/docs/d/iam_policy.html.markdown | 4 +- .../d/iam_testable_permissions.html.markdown | 4 +- .../d/kms_crypto_key_version.html.markdown | 4 +- website/docs/d/projects.html.markdown | 4 +- website/docs/r/bigquery_table.html.markdown | 38 ++--- .../docs/r/bigtable_instance.html.markdown | 4 +- .../r/cloudbuild_worker_pool.html.markdown | 8 +- .../r/cloudfunctions_function.html.markdown | 12 +- .../docs/r/composer_environment.html.markdown | 40 ++--- ...compute_firewall_policy_rule.html.markdown | 8 +- website/docs/r/compute_instance.html.markdown | 72 ++++----- .../r/compute_instance_group.html.markdown | 4 +- ...mpute_instance_group_manager.html.markdown | 24 +-- .../r/compute_instance_template.html.markdown | 56 +++---- ...egion_instance_group_manager.html.markdown | 20 +-- .../r/compute_security_policy.html.markdown | 24 +-- .../docs/r/container_cluster.html.markdown | 152 +++++++++--------- .../docs/r/container_node_pool.html.markdown | 12 +- website/docs/r/dataproc_cluster.html.markdown | 52 +++--- website/docs/r/dataproc_job.html.markdown | 24 +-- .../gke_hub_feature_membership.html.markdown | 24 +-- .../docs/r/google_folder_iam.html.markdown | 10 +- ...e_folder_organization_policy.html.markdown | 12 +- .../r/google_kms_crypto_key_iam.html.markdown | 4 +- .../r/google_kms_key_ring_iam.html.markdown | 4 +- .../r/google_organization_iam.html.markdown | 10 +- .../google_organization_policy.html.markdown | 13 +- .../docs/r/google_project_iam.html.markdown | 8 +- ..._project_organization_policy.html.markdown | 12 +- .../google_service_account_iam.html.markdown | 4 +- ...logging_billing_account_sink.html.markdown | 8 +- .../docs/r/logging_folder_sink.html.markdown | 8 +- .../r/logging_organization_sink.html.markdown | 8 +- .../docs/r/logging_project_sink.html.markdown | 8 +- website/docs/r/storage_bucket.html.markdown | 36 ++--- .../r/storage_bucket_object.html.markdown | 4 +- .../docs/r/storage_transfer_job.html.markdown | 46 +++--- 46 files changed, 468 insertions(+), 462 deletions(-) create mode 100644 .changelog/5279.txt diff --git a/.changelog/5279.txt b/.changelog/5279.txt new file mode 100644 index 00000000000..a5733712e82 --- /dev/null +++ b/.changelog/5279.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +provider: Added links to nested types documentation for manually generated pages +``` diff --git a/website/docs/d/cloud_identity_group_membership.html.markdown b/website/docs/d/cloud_identity_group_membership.html.markdown index 197f4eec177..e90975a810a 100644 --- a/website/docs/d/cloud_identity_group_membership.html.markdown +++ b/website/docs/d/cloud_identity_group_membership.html.markdown @@ -29,29 +29,29 @@ data "google_cloud_identity_group_memberships" "members" { In addition to the arguments listed above, the following attributes are exported: -* `memberships` - The list of memberships under the given group. Structure is documented below. +* `memberships` - The list of memberships under the given group. Structure is [documented below](#nested_memberships). -The `memberships` block contains: +The `memberships` block contains: * `name` - The resource name of the Membership, of the form groups/{group_id}/memberships/{membership_id}. -* `roles` - The MembershipRoles that apply to the Membership. Structure is documented below. +* `roles` - The MembershipRoles that apply to the Membership. Structure is [documented below](#nested_roles). * `member_key` - (Optional) - EntityKey of the member. Structure is documented below. + EntityKey of the member. Structure is [documented below](#nested_member_key). * `preferred_member_key` - (Optional) - EntityKey of the member. Structure is documented below. + EntityKey of the member. Structure is [documented below](#nested_preferred_member_key). -The `roles` block supports: +The `roles` block supports: * `name` - The name of the MembershipRole. One of OWNER, MANAGER, MEMBER. -The `member_key` block supports: +The `member_key` block supports: * `id` - The ID of the entity. For Google-managed entities, the id is the email address of an existing group or user. For external-identity-mapped entities, the id is a string conforming @@ -62,7 +62,7 @@ The `member_key` block supports: such as a Google user or a Google Group. If populated, the EntityKey represents an external-identity-mapped group. -The `preferred_member_key` block supports: +The `preferred_member_key` block supports: * `id` - The ID of the entity. For Google-managed entities, the id is the email address of an existing group or user. For external-identity-mapped entities, the id is a string conforming diff --git a/website/docs/d/cloud_identity_groups.html.markdown b/website/docs/d/cloud_identity_groups.html.markdown index 3c65b1c2b1f..864d1b21263 100644 --- a/website/docs/d/cloud_identity_groups.html.markdown +++ b/website/docs/d/cloud_identity_groups.html.markdown @@ -29,15 +29,15 @@ data "google_cloud_identity_groups" "groups" { In addition to the arguments listed above, the following attributes are exported: -* `groups` - The list of groups under the provided customer or namespace. Structure is documented below. +* `groups` - The list of groups under the provided customer or namespace. Structure is [documented below](#nested_groups). -The `groups` block contains: +The `groups` block contains: * `name` - Resource name of the Group in the format: groups/{group_id}, where `group_id` is the unique ID assigned to the Group. * `group_key` - - EntityKey of the Group. Structure is documented below. + EntityKey of the Group. Structure is [documented below](#nested_group_key). * `display_name` - The display name of the Group. @@ -49,7 +49,7 @@ The `groups` block contains: Contains 'cloudidentity.googleapis.com/groups.discussion_forum': '' if the Group is a Google Group or 'system/groups/external': '' if the Group is an external-identity-mapped group. -The `group_key` block supports: +The `group_key` block supports: * `id` - The ID of the entity. diff --git a/website/docs/d/cloudfunctions_function.html.markdown b/website/docs/d/cloudfunctions_function.html.markdown index 783b26f3d24..429dffafab9 100644 --- a/website/docs/d/cloudfunctions_function.html.markdown +++ b/website/docs/d/cloudfunctions_function.html.markdown @@ -49,7 +49,7 @@ exported: * `runtime` - The runtime in which the function is running. * `entry_point` - Name of a JavaScript function that will be executed when the Google Cloud Function is triggered. * `trigger_http` - If function is triggered by HTTP, this boolean is set. -* `event_trigger` - A source that fires events in response to a condition in another service. Structure is documented below. +* `event_trigger` - A source that fires events in response to a condition in another service. Structure is [documented below](#nested_event_trigger). * `https_trigger_url` - If function is triggered by HTTP, trigger URL is set here. * `ingress_settings` - Controls what traffic can reach the function. * `labels` - A map of labels applied to this function. @@ -57,9 +57,9 @@ exported: * `vpc_connector` - The VPC Network Connector that this cloud function can connect to. * `vpc_connector_egress_settings` - The egress settings for the connector, controlling what traffic is diverted through it. * `max_instances` - The limit on the maximum number of function instances that may coexist at a given time. -* `source_repository` - The URL of the Cloud Source Repository that the function is deployed from. Structure is documented below. +* `source_repository` - The URL of the Cloud Source Repository that the function is deployed from. Structure is [documented below](#nested_source_repository). -The `event_trigger` block contains: +The `event_trigger` block contains: * `event_type` - The type of event to observe. For example: `"google.storage.object.finalize"`. See the documentation on [calling Cloud Functions](https://cloud.google.com/functions/docs/calling/) @@ -67,13 +67,13 @@ for a full reference of accepted triggers. * `resource` - The name of the resource whose events are being observed, for example, `"myBucket"` -* `failure_policy` - Policy for failed executions. Structure is documented below. +* `failure_policy` - Policy for failed executions. Structure is [documented below](#nested_failure_policy). -The `failure_policy` block supports: +The `failure_policy` block contains: * `retry` - Whether the function should be retried on failure. -The `source_repository` block contains: +The `source_repository` block contains: * `url` - The URL pointing to the hosted repository where the function is defined. diff --git a/website/docs/d/compute_instance.html.markdown b/website/docs/d/compute_instance.html.markdown index a71e051d322..03c9e9bb1b1 100644 --- a/website/docs/d/compute_instance.html.markdown +++ b/website/docs/d/compute_instance.html.markdown @@ -44,13 +44,13 @@ The following arguments are supported: ## Attributes Reference -* `boot_disk` - The boot disk for the instance. Structure is documented below. +* `boot_disk` - The boot disk for the instance. Structure is [documented below](#nested_boot_disk). * `machine_type` - The machine type to create. -* `network_interface` - The networks attached to the instance. Structure is documented below. +* `network_interface` - The networks attached to the instance. Structure is [documented below](#nested_network_interface). -* `attached_disk` - List of disks attached to the instance. Structure is documented below. +* `attached_disk` - List of disks attached to the instance. Structure is [documented below](#nested_attached_disk). * `can_ip_forward` - Whether sending and receiving of packets with non-matching source or destination IPs is allowed. @@ -58,7 +58,7 @@ The following arguments are supported: * `deletion_protection` - Whether deletion protection is enabled on this instance. -* `guest_accelerator` - List of the type and count of accelerator cards attached to the instance. Structure is documented below. +* `guest_accelerator` - List of the type and count of accelerator cards attached to the instance. Structure is [documented below](#nested_guest_accelerator). * `labels` - A set of key/value label pairs assigned to the instance. @@ -66,11 +66,11 @@ The following arguments are supported: * `min_cpu_platform` - The minimum CPU platform specified for the VM instance. -* `scheduling` - The scheduling strategy being used by the instance. +* `scheduling` - The scheduling strategy being used by the instance. Structure is [documented below](#nested_scheduling) -* `scratch_disk` - The scratch disks attached to the instance. Structure is documented below. +* `scratch_disk` - The scratch disks attached to the instance. Structure is [documented below](#nested_scratch_disk). -* `service_account` - The service account to attach to the instance. Structure is documented below. +* `service_account` - The service account to attach to the instance. Structure is [documented below](#nested_service_account). * `tags` - The list of tags attached to the instance. @@ -86,7 +86,7 @@ The following arguments are supported: * `cpu_platform` - The CPU platform used by this instance. -* `shielded_instance_config` - The shielded vm config being used by the instance. Structure is documented below. +* `shielded_instance_config` - The shielded vm config being used by the instance. Structure is [documented below](#nested_shielded_instance_config). * `enable_display` -- Whether the instance has virtual displays enabled. @@ -94,7 +94,7 @@ The following arguments are supported: * `network_interface.0.access_config.0.nat_ip` - If the instance has an access config, either the given external ip (in the `nat_ip` field) or the ephemeral (generated) ip (if you didn't provide one). -* `network_performance_config` - The network performance configuration setting for the instance, if set. Structure is documented below. +* `network_performance_config` - The network performance configuration setting for the instance, if set. Structure is [documented below](#nested_network_performance_config). * `attached_disk.0.disk_encryption_key_sha256` - The [RFC 4648 base64](https://tools.ietf.org/html/rfc4648#section-4) encoded SHA-256 hash of the [customer-supplied encryption key] @@ -110,19 +110,19 @@ The following arguments are supported: --- -The `boot_disk` block supports: +The `boot_disk` block supports: * `auto_delete` - Whether the disk will be auto-deleted when the instance is deleted. * `device_name` - Name with which attached disk will be accessible under `/dev/disk/by-id/` * `initialize_params` - Parameters with which a disk was created alongside the instance. - Structure is documented below. + Structure is [documented below](#nested_initialize_params). * `source` - The name or self_link of an existing disk (such as those managed by `google_compute_disk`) that was attached to the instance. -The `initialize_params` block supports: +The `initialize_params` block supports: * `size` - The size of the image in gigabytes. @@ -130,11 +130,11 @@ The `initialize_params` block supports: * `image` - The image from which this disk was initialised. -The `scratch_disk` block supports: +The `scratch_disk` block supports: * `interface` - The disk interface used for attaching this disk. One of `SCSI` or `NVME`. -The `attached_disk` block supports: +The `attached_disk` block supports: * `source` - The name or self_link of the disk attached to this instance. @@ -143,7 +143,7 @@ The `attached_disk` block supports: * `mode` - Read/write mode for the disk. One of `"READ_ONLY"` or `"READ_WRITE"`. -The `network_interface` block supports: +The `network_interface` block supports: * `network` - The name or self_link of the network attached to this interface. @@ -154,11 +154,11 @@ The `network_interface` block supports: * `network_ip` - The private IP address assigned to the instance. * `access_config` - Access configurations, i.e. IPs via which this - instance can be accessed via the Internet. Structure documented below. + instance can be accessed via the Internet. Structure [documented below](#nested_access_config). -* `alias_ip_range` - An array of alias IP ranges for this network interface. Structure documented below. +* `alias_ip_range` - An array of alias IP ranges for this network interface. Structure [documented below](#nested_alias_ip_range). -The `access_config` block supports: +The `access_config` block supports: * `nat_ip` - The IP address that is be 1:1 mapped to the instance's network ip. @@ -167,7 +167,7 @@ The `access_config` block supports: * `network_tier` - The [networking tier][network-tier] used for configuring this instance. One of `PREMIUM` or `STANDARD`. -The `alias_ip_range` block supports: +The `alias_ip_range` block supports: * `ip_cidr_range` - The IP CIDR range represented by this alias IP range. @@ -175,13 +175,13 @@ The `alias_ip_range` block supports: the secondary range from which to allocate the IP CIDR range for this alias IP range. -The `service_account` block supports: +The `service_account` block supports: * `email` - The service account e-mail address. * `scopes` - A list of service scopes. -The `scheduling` block supports: +The `scheduling` block supports: * `preemptible` - Whether the instance is preemptible. @@ -192,7 +192,7 @@ The `scheduling` block supports: * `automatic_restart` - Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user). -The `guest_accelerator` block supports: +The `guest_accelerator` block supports: * `type` - The accelerator type resource exposed to this instance. E.g. `nvidia-tesla-k80`. @@ -200,7 +200,7 @@ The `guest_accelerator` block supports: [network-tier]: https://cloud.google.com/network-tiers/docs/overview -The `shielded_instance_config` block supports: +The `shielded_instance_config` block supports: * `enable_secure_boot` -- Whether secure boot is enabled for the instance. @@ -208,6 +208,6 @@ The `shielded_instance_config` block supports: * `enable_integrity_monitoring` -- Whether integrity monitoring is enabled for the instance. -The `network_performance_config` block supports: +The `network_performance_config` block supports: * `total_egress_bandwidth_tier` - The egress bandwidth tier for the instance. diff --git a/website/docs/d/compute_instance_template.html.markdown b/website/docs/d/compute_instance_template.html.markdown index 7ea8183904f..20240613bf4 100644 --- a/website/docs/d/compute_instance_template.html.markdown +++ b/website/docs/d/compute_instance_template.html.markdown @@ -50,7 +50,7 @@ The following arguments are supported: * `disk` - Disks to attach to instances created from this template. This can be specified multiple times for multiple disks. Structure is - documented below. + [documented below](#nested_disk). * `machine_type` - The machine type to create. @@ -83,10 +83,10 @@ The following arguments are supported: * `network_interface` - Networks to attach to instances created from this template. This can be specified multiple times for multiple networks. - Structure is documented below. + Structure is [documented below](#nested_network_interface). * `network_performance_config` - The network performance configuration setting - for the instance, if set. Structure is documented below. + for the instance, if set. Structure is [documented below](#nested_network_performance_config). * `project` - The ID of the project in which the resource belongs. If it is not provided, the provider project is used. @@ -101,24 +101,24 @@ The following arguments are supported: * `scheduling` - The scheduling strategy to use. More details about this configuration option are detailed below. -* `service_account` - Service account to attach to the instance. Structure is documented below. +* `service_account` - Service account to attach to the instance. Structure is [documented below](#nested_service_account). * `tags` - Tags to attach to the instance. -* `guest_accelerator` - List of the type and count of accelerator cards attached to the instance. Structure documented below. +* `guest_accelerator` - List of the type and count of accelerator cards attached to the instance. Structure [documented below](#nested_guest_accelerator). * `min_cpu_platform` - Specifies a minimum CPU platform. Applicable values are the friendly names of CPU platforms, such as `Intel Haswell` or `Intel Skylake`. See the complete list [here](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). -* `shielded_instance_config` - Enable [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm) on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. +* `shielded_instance_config` - Enable [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm) on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is [documented below](#nested_shielded_instance_config). **Note**: [`shielded_instance_config`](#shielded_instance_config) can only be used with boot images with shielded vm support. See the complete list [here](https://cloud.google.com/compute/docs/images#shielded-images). * `enable_display` - Enable [Virtual Displays](https://cloud.google.com/compute/docs/instances/enable-instance-virtual-display#verify_display_driver) on this instance. **Note**: [`allow_stopping_for_update`](#allow_stopping_for_update) must be set to true in order to update this field. -* `confidential_instance_config` - Enable [Confidential Mode](https://cloud.google.com/compute/confidential-vm/docs/about-cvm) on this VM. +* `confidential_instance_config` - Enable [Confidential Mode](https://cloud.google.com/compute/confidential-vm/docs/about-cvm) on this VM. Structure is [documented below](#nested_confidential_instance_config) -The `disk` block supports: +The `disk` block supports: * `auto_delete` - Whether or not the disk should be auto-deleted. This defaults to true. @@ -182,7 +182,7 @@ The `disk_encryption_key` block supports: * `kms_key_self_link` - The self link of the encryption key that is stored in Google Cloud KMS -The `network_interface` block supports: +The `network_interface` block supports: * `network` - The name or self_link of the network to attach this interface to. Use `network` attribute for Legacy or Auto subnetted networks and @@ -203,13 +203,13 @@ The `network_interface` block supports: is not accessible from the Internet (this means that ssh provisioners will not work unless you are running Terraform can send traffic to the instance's network (e.g. via tunnel or because it is running on another cloud instance - on that network). This block can be repeated multiple times. Structure documented below. + on that network). This block can be repeated multiple times. Structure [documented below](#nested_access_config). * `alias_ip_range` - An array of alias IP ranges for this network interface. Can only be specified for network - interfaces on subnet-mode networks. Structure documented below. + interfaces on subnet-mode networks. Structure [documented below](#nested_alias_ip_range). -The `access_config` block supports: +The `access_config` block supports: * `nat_ip` - The IP address that will be 1:1 mapped to the instance's network ip. If not given, one will be generated. @@ -218,7 +218,7 @@ The `access_config` block supports: this instance template. This field can take the following values: PREMIUM or STANDARD. If this field is not specified, it is assumed to be PREMIUM. -The `alias_ip_range` block supports: +The `alias_ip_range` block supports: * `ip_cidr_range` - The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by @@ -230,7 +230,7 @@ The `alias_ip_range` block supports: the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. -The `service_account` block supports: +The `service_account` block supports: * `email` - The service account e-mail address. If not given, the default Google Compute Engine service account is used. @@ -244,7 +244,7 @@ The `service_account` block supports: If you are following best practices and using IAM roles to grant permissions to service accounts, then you can define this field as an empty list. -The `scheduling` block supports: +The `scheduling` block supports: * `automatic_restart` - Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not @@ -261,15 +261,15 @@ The `scheduling` block supports: to determine which sole-tenant nodes your instances and managed instance groups will use as host systems. Read more on sole-tenant node creation [here](https://cloud.google.com/compute/docs/nodes/create-nodes). - Structure documented below. + Structure [documented below](#nested_node_affinities). -The `guest_accelerator` block supports: +The `guest_accelerator` block supports: * `type` - The accelerator type resource to expose to this instance. E.g. `nvidia-tesla-k80`. * `count` - The number of the guest accelerator cards exposed to this instance. -The `node_affinities` block supports: +The `node_affinities` block supports: * `key` - The key for the node affinity label. @@ -278,7 +278,7 @@ The `node_affinities` block supports: * `value` - The values for the node affinity label. -The `shielded_instance_config` block supports: +The `shielded_instance_config` block supports: * `enable_secure_boot` -- Verify the digital signature of all boot components, and halt the boot process if signature verification fails. Defaults to false. @@ -286,11 +286,11 @@ The `shielded_instance_config` block supports: * `enable_integrity_monitoring` -- Compare the most recent boot measurements to the integrity policy baseline and return a pair of pass/fail results depending on whether they match or not. Defaults to true. -The `confidential_instance_config` block supports: +The `confidential_instance_config` block supports: * `enable_confidential_compute` Defines whether the instance should have confidential compute enabled. [`on_host_maintenance`](#on_host_maintenance) has to be set to TERMINATE or this will fail to create the VM. -The `network_performance_config` block supports: +The `network_performance_config` block supports: * `total_egress_bandwidth_tier` - The egress bandwidth tier for the instance. diff --git a/website/docs/d/compute_subnetwork.html.markdown b/website/docs/d/compute_subnetwork.html.markdown index f39649411b3..529d0efc0ec 100644 --- a/website/docs/d/compute_subnetwork.html.markdown +++ b/website/docs/d/compute_subnetwork.html.markdown @@ -55,9 +55,9 @@ In addition to the arguments listed above, the following attributes are exported addresses. * `secondary_ip_range` - An array of configurations for secondary IP ranges for - VM instances contained in this subnetwork. Structure is documented below. + VM instances contained in this subnetwork. Structure is [documented below](#nested_secondary_ip_range). -The `secondary_ip_range` block supports: +The `secondary_ip_range` block supports: * `range_name` - The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. diff --git a/website/docs/d/dns_keys.html.markdown b/website/docs/d/dns_keys.html.markdown index 54c529f29a4..88388f61812 100644 --- a/website/docs/d/dns_keys.html.markdown +++ b/website/docs/d/dns_keys.html.markdown @@ -49,7 +49,7 @@ The following arguments are supported: The following attributes are exported: -* `key_signing_keys` - A list of Key-signing key (KSK) records. Structure is documented below. Additionally, the DS record is provided: +* `key_signing_keys` - A list of Key-signing key (KSK) records. Structure is [documented below](#nested_key_signing_keys). Additionally, the DS record is provided: * `ds_record` - The DS record based on the KSK record. This is used when [delegating](https://cloud.google.com/dns/docs/dnssec-advanced#subdelegation) DNSSEC-signed subdomains. @@ -57,7 +57,7 @@ The following attributes are exported: --- -The `key_signing_keys` and `zone_signing_keys` block supports: +The `key_signing_keys` and `zone_signing_keys` block supports: * `algorithm` - String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. Possible values are `ecdsap256sha256`, `ecdsap384sha384`, `rsasha1`, `rsasha256`, and `rsasha512`. diff --git a/website/docs/d/game_services_game_server_deployment_rollout.html.markdown b/website/docs/d/game_services_game_server_deployment_rollout.html.markdown index b4ea0329427..6eb11afd799 100644 --- a/website/docs/d/game_services_game_server_deployment_rollout.html.markdown +++ b/website/docs/d/game_services_game_server_deployment_rollout.html.markdown @@ -45,21 +45,21 @@ In addition to the arguments listed above, the following attributes are exported The game_server_config_overrides contains the per game server config overrides. The overrides are processed in the order they are listed. As soon as a match is found for a cluster, the rest of the list is not - processed. Structure is documented below. + processed. Structure is [documented below](#nested_game_server_config_overrides). * `project` - The ID of the project in which the resource belongs. If it is not provided, the provider project is used. -The `game_server_config_overrides` block contains: +The `game_server_config_overrides` block contains: * `realms_selector` - - Selection by realms. Structure is documented below. + Selection by realms. Structure is [documented below](#nested_realms_selector). * `config_version` - Version of the configuration. -The `realms_selector` block contains: +The `realms_selector` block contains: * `realms` - List of realms to match against. diff --git a/website/docs/d/iam_policy.html.markdown b/website/docs/d/iam_policy.html.markdown index 209f00d8196..fd241a1abd0 100644 --- a/website/docs/d/iam_policy.html.markdown +++ b/website/docs/d/iam_policy.html.markdown @@ -85,9 +85,9 @@ each accept the following arguments: * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com. * **domain:{domain}**: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com. -* `condition` - (Optional) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. Structure is documented below. +* `condition` - (Optional) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. Structure is [documented below](#nested_condition). -The `condition` block supports: +The `condition` block supports: * `expression` - (Required) Textual representation of an expression in Common Expression Language syntax. diff --git a/website/docs/d/iam_testable_permissions.html.markdown b/website/docs/d/iam_testable_permissions.html.markdown index 6c37065b44f..5b3e650b021 100644 --- a/website/docs/d/iam_testable_permissions.html.markdown +++ b/website/docs/d/iam_testable_permissions.html.markdown @@ -34,9 +34,9 @@ The following arguments are supported: The following attributes are exported: -* `permissions` - A list of permissions matching the provided input. Structure is defined below. +* `permissions` - A list of permissions matching the provided input. Structure is [defined below](#nested_permissions). -The `permissions` block supports: +The `permissions` block supports: * `name` - Name of the permission. * `title` - Human readable title of the permission. diff --git a/website/docs/d/kms_crypto_key_version.html.markdown b/website/docs/d/kms_crypto_key_version.html.markdown index 396507a971f..08f18293931 100644 --- a/website/docs/d/kms_crypto_key_version.html.markdown +++ b/website/docs/d/kms_crypto_key_version.html.markdown @@ -58,9 +58,9 @@ exported: * `algorithm` - The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. See the [algorithm reference](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) for possible outputs. -* `public_key` - If the enclosing CryptoKey has purpose `ASYMMETRIC_SIGN` or `ASYMMETRIC_DECRYPT`, this block contains details about the public key associated to this CryptoKeyVersion. Structure is documented below. +* `public_key` - If the enclosing CryptoKey has purpose `ASYMMETRIC_SIGN` or `ASYMMETRIC_DECRYPT`, this block contains details about the public key associated to this CryptoKeyVersion. Structure is [documented below](#nested_public_key). -The `public_key` block, if present, contains: +The `public_key` block, if present, contains: * `pem` - The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info. diff --git a/website/docs/d/projects.html.markdown b/website/docs/d/projects.html.markdown index 0b556b40abc..82a3f0c061a 100644 --- a/website/docs/d/projects.html.markdown +++ b/website/docs/d/projects.html.markdown @@ -36,9 +36,9 @@ The following arguments are supported: The following attributes are exported: -* `projects` - A list of projects matching the provided filter. Structure is defined below. +* `projects` - A list of projects matching the provided filter. Structure is [defined below](#nested_projects). -The `projects` block supports: +The `projects` block supports: * `project_id` - The project id of the project. diff --git a/website/docs/r/bigquery_table.html.markdown b/website/docs/r/bigquery_table.html.markdown index 25f4120c252..3ec504de311 100644 --- a/website/docs/r/bigquery_table.html.markdown +++ b/website/docs/r/bigquery_table.html.markdown @@ -106,13 +106,13 @@ The following arguments are supported: * `external_data_configuration` - (Optional) Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as - if it were a standard BigQuery table. Structure is documented below. + if it were a standard BigQuery table. Structure is [documented below](#nested_external_data_configuration). * `friendly_name` - (Optional) A descriptive name for the table. * `encryption_configuration` - (Optional) Specifies how the table should be encrypted. If left blank, the table will be encrypted with a Google-managed key; that process - is transparent to the user. Structure is documented below. + is transparent to the user. Structure is [documented below](#nested_encryption_configuration). * `labels` - (Optional) A mapping of labels to assign to the resource. @@ -125,25 +125,25 @@ The following arguments are supported: As a workaround, we recommend using the schema as returned by the API. * `time_partitioning` - (Optional) If specified, configures time-based - partitioning for this table. Structure is documented below. + partitioning for this table. Structure is [documented below](#nested_time_partitioning). * `range_partitioning` - (Optional) If specified, configures range-based - partitioning for this table. Structure is documented below. + partitioning for this table. Structure is [documented below](#nested_range_partitioning). * `clustering` - (Optional) Specifies column names to use for data clustering. Up to four top-level columns are allowed, and should be specified in descending priority order. * `view` - (Optional) If specified, configures this table as a view. - Structure is documented below. + Structure is [documented below](#nested_view). * `materialized_view` - (Optional) If specified, configures this table as a materialized view. - Structure is documented below. + Structure is [documented below](#nested_materialized_view). * `deletion_protection` - (Optional) Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a `terraform destroy` or `terraform apply` that would delete the instance will fail. -The `external_data_configuration` block supports: +The `external_data_configuration` block supports: * `autodetect` - (Required) - Let BigQuery try to autodetect the schema and format of the table. @@ -152,16 +152,16 @@ The `external_data_configuration` block supports: Valid values are "NONE" or "GZIP". * `csv_options` (Optional) - Additional properties to set if - `source_format` is set to "CSV". Structure is documented below. + `source_format` is set to "CSV". Structure is [documented below](#nested_csv_options). * `google_sheets_options` (Optional) - Additional options if `source_format` is set to "GOOGLE_SHEETS". Structure is - documented below. + [documented below](#nested_google_sheets_options). * `hive_partitioning_options` (Optional) - When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing - an invalid specification. + an invalid specification. Structure is [documented below](#nested_hive_partitioning_options). * `ignore_unknown_values` (Optional) - Indicates if BigQuery should allow extra values that are not represented in the table schema. @@ -194,7 +194,7 @@ The `external_data_configuration` block supports: * `source_uris` - (Required) A list of the fully-qualified URIs that point to your data in Google Cloud. -The `csv_options` block supports: +The `csv_options` block supports: * `quote` (Required) - The value that is used to quote data sections in a CSV file. If your data does not contain quoted sections, set the @@ -219,7 +219,7 @@ The `csv_options` block supports: * `skip_leading_rows` (Optional) - The number of rows at the top of a CSV file that BigQuery will skip when reading the data. -The `google_sheets_options` block supports: +The `google_sheets_options` block supports: * `range` (Optional) - Range of a sheet to query from. Only used when non-empty. At least one of `range` or `skip_leading_rows` must be set. @@ -230,7 +230,7 @@ The `google_sheets_options` block supports: that BigQuery will skip when reading the data. At least one of `range` or `skip_leading_rows` must be set. -The `hive_partitioning_options` block supports: +The `hive_partitioning_options` block supports: * `mode` (Optional) - When set, what mode of hive partitioning to use when reading data. The following modes are supported. @@ -254,7 +254,7 @@ The `hive_partitioning_options` block supports: can be either of `gs://bucket/path_to_table` or `gs://bucket/path_to_table/`. Note that when `mode` is set to `CUSTOM`, you must encode the partition key schema within the `source_uri_prefix` by setting `source_uri_prefix` to `gs://bucket/path_to_table/{key1:TYPE1}/{key2:TYPE2}/{key3:TYPE3}`. -The `time_partitioning` block supports: +The `time_partitioning` block supports: * `expiration_ms` - (Optional) Number of milliseconds for which to keep the storage for a partition. @@ -270,15 +270,15 @@ The `time_partitioning` block supports: require a partition filter that can be used for partition elimination to be specified. -The `range_partitioning` block supports: +The `range_partitioning` block supports: * `field` - (Required) The field used to determine how to create a range-based partition. * `range` - (Required) Information required to partition based on ranges. - Structure is documented below. + Structure is [documented below](#nested_range). -The `range` block supports: +The `range` block supports: * `start` - (Required) Start of the range partitioning, inclusive. @@ -286,7 +286,7 @@ The `range` block supports: * `interval` - (Required) The width of each range within the partition. -The `view` block supports: +The `view` block supports: * `query` - (Required) A query that BigQuery executes when the view is referenced. @@ -303,7 +303,7 @@ The `materialized_view` block supports: * `refresh_interval_ms` - (Optional) The maximum frequency at which this materialized view will be refreshed. The default value is 1800000 -The `encryption_configuration` block supports the following arguments: +The `encryption_configuration` block supports the following arguments: * `kms_key_name` - (Required) The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have diff --git a/website/docs/r/bigtable_instance.html.markdown b/website/docs/r/bigtable_instance.html.markdown index 33169fe1fe4..8c25f825fe3 100644 --- a/website/docs/r/bigtable_instance.html.markdown +++ b/website/docs/r/bigtable_instance.html.markdown @@ -52,7 +52,7 @@ The following arguments are supported: * `name` - (Required) The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. * `cluster` - (Required) A block of cluster configuration options. This can be specified at least once, and up to 4 times. -See structure below. +See [structure below](#nested_cluster). ----- @@ -75,7 +75,7 @@ in Terraform state, a `terraform destroy` or `terraform apply` that would delete ----- -The `cluster` block supports the following arguments: +The `cluster` block supports the following arguments: * `cluster_id` - (Required) The ID of the Cloud Bigtable cluster. diff --git a/website/docs/r/cloudbuild_worker_pool.html.markdown b/website/docs/r/cloudbuild_worker_pool.html.markdown index 6616d4ef8b0..639b102e03e 100644 --- a/website/docs/r/cloudbuild_worker_pool.html.markdown +++ b/website/docs/r/cloudbuild_worker_pool.html.markdown @@ -92,7 +92,7 @@ The following arguments are supported: * `network_config` - (Optional) - Network configuration for the `WorkerPool`. + Network configuration for the `WorkerPool`. Structure is [documented below](#nested_network_config). * `project` - (Optional) @@ -100,17 +100,17 @@ The following arguments are supported: * `worker_config` - (Optional) - Configuration to be used for a creating workers in the `WorkerPool`. + Configuration to be used for a creating workers in the `WorkerPool`. Structure is [documented below](#nested_worker_config). -The `network_config` block supports: +The `network_config` block supports: * `peered_network` - (Required) Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See (https://cloud.google.com/cloud-build/docs/custom-workers/set-up-custom-worker-pool-environment#understanding_the_network_configuration_options) -The `worker_config` block supports: +The `worker_config` block supports: * `disk_size_gb` - (Optional) diff --git a/website/docs/r/cloudfunctions_function.html.markdown b/website/docs/r/cloudfunctions_function.html.markdown index 20d9df68b77..b42cf513d6b 100644 --- a/website/docs/r/cloudfunctions_function.html.markdown +++ b/website/docs/r/cloudfunctions_function.html.markdown @@ -121,7 +121,7 @@ Eg. `"nodejs10"`, `"nodejs12"`, `"nodejs14"`, `"python37"`, `"python38"`, `"pyth * `entry_point` - (Optional) Name of the function that will be executed when the Google Cloud Function is triggered. -* `event_trigger` - (Optional) A source that fires events in response to a condition in another service. Structure is documented below. Cannot be used with `trigger_http`. +* `event_trigger` - (Optional) A source that fires events in response to a condition in another service. Structure is [documented below](#nested_event_trigger). Cannot be used with `trigger_http`. * `trigger_http` - (Optional) Boolean variable. Any HTTP request (of a supported type) to the endpoint will trigger function execution. Supported HTTP request types are: POST, PUT, GET, DELETE, and OPTIONS. Endpoint is returned as `https_trigger_url`. Cannot be used with `event_trigger`. @@ -144,11 +144,11 @@ Eg. `"nodejs10"`, `"nodejs12"`, `"nodejs14"`, `"python37"`, `"python38"`, `"pyth * `source_archive_object` - (Optional) The source archive object (file) in archive bucket. * `source_repository` - (Optional) Represents parameters related to source repository where a function is hosted. - Cannot be set alongside `source_archive_bucket` or `source_archive_object`. Structure is documented below. + Cannot be set alongside `source_archive_bucket` or `source_archive_object`. Structure is [documented below](#nested_source_repository). * `max_instances` - (Optional) The limit on the maximum number of function instances that may coexist at a given time. -The `event_trigger` block supports: +The `event_trigger` block supports: * `event_type` - (Required) The type of event to observe. For example: `"google.storage.object.finalize"`. See the documentation on [calling Cloud Functions](https://cloud.google.com/functions/docs/calling/) for a @@ -157,13 +157,13 @@ full reference of accepted triggers. * `resource` - (Required) Required. The name or partial URI of the resource from which to observe events. For example, `"myBucket"` or `"projects/my-project/topics/my-topic"` -* `failure_policy` - (Optional) Specifies policy for failed executions. Structure is documented below. +* `failure_policy` - (Optional) Specifies policy for failed executions. Structure is [documented below](#nested_failure_policy). -The `failure_policy` block supports: +The `failure_policy` block supports: * `retry` - (Required) Whether the function should be retried on failure. Defaults to `false`. -The `source_repository` block supports: +The `source_repository` block supports: * `url` - (Required) The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: diff --git a/website/docs/r/composer_environment.html.markdown b/website/docs/r/composer_environment.html.markdown index 226bb8373c2..c0a426962ea 100644 --- a/website/docs/r/composer_environment.html.markdown +++ b/website/docs/r/composer_environment.html.markdown @@ -128,7 +128,7 @@ The following arguments are supported: - - - * `config` - (Optional) - Configuration parameters for this environment Structure is documented below. + Configuration parameters for this environment Structure is [documented below](#nested_config). * `labels` - (Optional) @@ -148,7 +148,7 @@ The following arguments are supported: * `project` - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used. -The `config` block supports: +The `config` block supports: * `node_count` - (Optional) @@ -159,15 +159,15 @@ The `config` block supports: * `node_config` - (Optional) - The configuration used for the Kubernetes Engine cluster. Structure is documented below. + The configuration used for the Kubernetes Engine cluster. Structure is [documented below](#nested_node_config). * `software_config` - (Optional) - The configuration settings for software inside the environment. Structure is documented below. + The configuration settings for software inside the environment. Structure is [documented below](#nested_software_config). * `private_environment_config` - (Optional) - The configuration used for the Private IP Cloud Composer environment. Structure is documented below. + The configuration used for the Private IP Cloud Composer environment. Structure is [documented below](#nested_private_environment_config). * `web_server_network_access_control` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) @@ -180,23 +180,23 @@ The `config` block supports: (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) The configuration settings for Cloud SQL instance used internally by Apache Airflow software. This field is supported for Cloud - Composer environments in versions composer-1.*.*-airflow-*.*.*. + Composer environments in versions composer-1.*.*-airflow-*.*.*. Structure is [documented below](#nested_database_config). * `web_server_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions - composer-1.*.*-airflow-*.*.*. + composer-1.*.*-airflow-*.*.*. Structure is [documented below](#nested_web_server_config). * `encryption_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) The encryption options for the Cloud Composer environment and its dependencies. This field is supported for Cloud Composer environments in - versions composer-1.*.*-airflow-*.*.*. + versions composer-1.*.*-airflow-*.*.*. Structure is [documented below](#nested_encryption_config). * `maintenance_window` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) - The configuration settings for Cloud Composer maintenance window. + The configuration settings for Cloud Composer maintenance window. Structure is [documented below](#nested_maintenance_window). * `workloads_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) @@ -204,7 +204,7 @@ The `config` block supports: Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. -The `node_config` block supports: +The `node_config` block supports: * `zone` - (Required) @@ -273,7 +273,7 @@ The `node_config` block supports: * `ip_allocation_policy` - (Optional) Configuration for controlling how IPs are allocated in the GKE cluster. - Structure is documented below. + Structure is [documented below](#nested_ip_allocation_policy). Cannot be updated. * `max_pods_per_node` - @@ -292,7 +292,7 @@ The `node_config` block supports: all destination addresses, except between pods traffic. See the [documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent). -The `software_config` block supports: +The `software_config` block supports: * `airflow_config_overrides` - (Optional) Apache Airflow configuration properties to override. Property keys contain the section and property names, @@ -353,7 +353,7 @@ The `software_config` block supports: * `scheduler_count` (Optional) - The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-2.*.*.` -See [documentation](https://cloud.google.com/composer/docs/how-to/managing/configuring-private-ip) for setting up private environments. The `private_environment_config` block supports: +See [documentation](https://cloud.google.com/composer/docs/how-to/managing/configuring-private-ip) for setting up private environments. The `private_environment_config` block supports: * `enable_private_endpoint` - If true, access to the public endpoint of the GKE cluster is denied. @@ -389,9 +389,9 @@ See [documentation](https://cloud.google.com/composer/docs/how-to/managing/confi The `web_server_network_access_control` supports: * `allowed_ip_range` - - A collection of allowed IP ranges with descriptions. Structure is documented below. + A collection of allowed IP ranges with descriptions. Structure is [documented below](#nested_allowed_ip_range). -The `allowed_ip_range` supports: +The `allowed_ip_range` supports: * `value` - (Required) @@ -404,7 +404,7 @@ The `allowed_ip_range` supports: (Optional) A description of this ip range. -The `ip_allocation_policy` block supports: +The `ip_allocation_policy` block supports: * `use_ip_aliases` - (Required) @@ -450,14 +450,14 @@ The `ip_allocation_policy` block supports: (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either `services_secondary_range_name` or `services_ipv4_cidr_block` but not both. -The `database_config` block supports: +The `database_config` block supports: * `machine_type` - (Required) Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. -The `web_server_config` block supports: +The `web_server_config` block supports: * `machine_type` - (Required) @@ -466,7 +466,7 @@ The `web_server_config` block supports: Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values. -The `encryption_config` block supports: +The `encryption_config` block supports: * `kms_key_name` - (Required) @@ -474,7 +474,7 @@ The `encryption_config` block supports: be the fully qualified resource name, i.e. projects/project-id/locations/location/keyRings/keyring/cryptoKeys/key. Cannot be updated. -The `maintenance_window` block supports: +The `maintenance_window` block supports: * `start_time` - (Required) diff --git a/website/docs/r/compute_firewall_policy_rule.html.markdown b/website/docs/r/compute_firewall_policy_rule.html.markdown index f3d99f85eae..f308196fe33 100644 --- a/website/docs/r/compute_firewall_policy_rule.html.markdown +++ b/website/docs/r/compute_firewall_policy_rule.html.markdown @@ -72,7 +72,7 @@ The following arguments are supported: * `match` - (Required) - A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. Structure is [documented below](#nested_match). * `priority` - (Required) @@ -80,7 +80,7 @@ The following arguments are supported: -The `match` block supports: +The `match` block supports: * `dest_ip_ranges` - (Optional) @@ -88,13 +88,13 @@ The `match` block supports: * `layer4_configs` - (Required) - Pairs of IP protocols and ports that the rule should match. + Pairs of IP protocols and ports that the rule should match. Structure is [documented below](#nested_layer4_configs). * `src_ip_ranges` - (Optional) CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256. -The `layer4_configs` block supports: +The `layer4_configs` block supports: * `ip_protocol` - (Required) diff --git a/website/docs/r/compute_instance.html.markdown b/website/docs/r/compute_instance.html.markdown index 84370791eef..0ef367216aa 100644 --- a/website/docs/r/compute_instance.html.markdown +++ b/website/docs/r/compute_instance.html.markdown @@ -67,7 +67,7 @@ resource "google_compute_instance" "default" { The following arguments are supported: * `boot_disk` - (Required) The boot disk for the instance. - Structure is documented below. + Structure is [documented below](#nested_boot_disk). * `machine_type` - (Required) The machine type to create. @@ -83,14 +83,14 @@ The following arguments are supported: * `zone` - (Optional) The zone that the machine should be created in. If it is not provided, the provider zone is used. * `network_interface` - (Required) Networks to attach to the instance. This can - be specified multiple times. Structure is documented below. + be specified multiple times. Structure is [documented below](#nested_network_interface). - - - * `allow_stopping_for_update` - (Optional) If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail. -* `attached_disk` - (Optional) Additional disks to attach to the instance. Can be repeated multiple times for multiple disks. Structure is documented below. +* `attached_disk` - (Optional) Additional disks to attach to the instance. Can be repeated multiple times for multiple disks. Structure is [documented below](#nested_attached_disk). * `can_ip_forward` - (Optional) Whether to allow sending and receiving of packets with non-matching source or destination IPs. @@ -108,7 +108,7 @@ The following arguments are supported: Valid format is a series of labels 1-63 characters long matching the regular expression `[a-z]([-a-z0-9]*[a-z0-9])`, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created. -* `guest_accelerator` - (Optional) List of the type and count of accelerator cards attached to the instance. Structure documented below. +* `guest_accelerator` - (Optional) List of the type and count of accelerator cards attached to the instance. Structure [documented below](#nested_guest_accelerator). **Note:** GPU accelerators can only be used with [`on_host_maintenance`](#on_host_maintenance) option set to TERMINATE. **Note**: This field uses [attr-as-block mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html) to avoid breaking users during the 0.12 upgrade. To explicitly send a list @@ -151,18 +151,18 @@ The following arguments are supported: is not provided, the provider project is used. * `scheduling` - (Optional) The scheduling strategy to use. More details about - this configuration option are detailed below. + this configuration option are [detailed below](#nested_scheduling). * `scratch_disk` - (Optional) Scratch disks to attach to the instance. This can be - specified multiple times for multiple scratch disks. Structure is documented below. + specified multiple times for multiple scratch disks. Structure is [documented below](#nested_scratch_disk). * `service_account` - (Optional) Service account to attach to the instance. - Structure is documented below. + Structure is [documented below](#nested_service_account). **Note**: [`allow_stopping_for_update`](#allow_stopping_for_update) must be set to true or your instance must have a `desired_status` of `TERMINATED` in order to update this field. * `tags` - (Optional) A list of network tags to attach to the instance. -* `shielded_instance_config` - (Optional) Enable [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm) on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. +* `shielded_instance_config` - (Optional) Enable [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm) on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is [documented below](#nested_shielded_instance_config). **Note**: [`shielded_instance_config`](#shielded_instance_config) can only be used with boot images with shielded vm support. See the complete list [here](https://cloud.google.com/compute/docs/images#shielded-images). **Note**: [`allow_stopping_for_update`](#allow_stopping_for_update) must be set to true or your instance must have a `desired_status` of `TERMINATED` in order to update this field. @@ -172,22 +172,22 @@ The following arguments are supported: * `resource_policies` (Optional) -- A list of short names or self_links of resource policies to attach to the instance. Modifying this list will cause the instance to recreate. Currently a max of 1 resource policy is supported. * `reservation_affinity` - (Optional) Specifies the reservations that this instance can consume from. - Structure is documented below. + Structure is [documented below](#nested_reservation_affinity). -* `confidential_instance_config` (Optional) - Enable [Confidential Mode](https://cloud.google.com/compute/confidential-vm/docs/about-cvm) on this VM. +* `confidential_instance_config` (Optional) - Enable [Confidential Mode](https://cloud.google.com/compute/confidential-vm/docs/about-cvm) on this VM. Structure is [documented below](#nested_confidential_instance_config) -* `advanced_machine_features` (Optional) - Configure Nested Virtualisation and Simultaneous Hyper Threading on this VM. +* `advanced_machine_features` (Optional) - Configure Nested Virtualisation and Simultaneous Hyper Threading on this VM. Structure is [documented below](#nested_advanced_machine_features) * `network_performance_config` (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) Configures network performance settings for the instance. Structure is - documented below. **Note**: [`machine_type`](#machine_type) must be a [supported type](https://cloud.google.com/compute/docs/networking/configure-vm-with-high-bandwidth-configuration), + [documented below](#nested_network_performance_config). **Note**: [`machine_type`](#machine_type) must be a [supported type](https://cloud.google.com/compute/docs/networking/configure-vm-with-high-bandwidth-configuration), the [`image`](#image) used must include the [`GVNIC`](https://cloud.google.com/compute/docs/networking/using-gvnic#create-instance-gvnic-image) in `guest-os-features`, and `network_interface.0.nic-type` must be `GVNIC` in order for this setting to take effect. --- -The `boot_disk` block supports: +The `boot_disk` block supports: * `auto_delete` - (Optional) Whether the disk will be auto-deleted when the instance is deleted. Defaults to true. @@ -210,13 +210,13 @@ The `boot_disk` block supports: * `initialize_params` - (Optional) Parameters for a new disk that will be created alongside the new instance. Either `initialize_params` or `source` must be set. - Structure is documented below. + Structure is [documented below](#nested_initialize_params). * `source` - (Optional) The name or self_link of the existing disk (such as those managed by `google_compute_disk`) or disk image. To create an instance from a snapshot, first create a `google_compute_disk` from a snapshot and reference it here. -The `initialize_params` block supports: +The `initialize_params` block supports: * `size` - (Optional) The size of the image in gigabytes. If not specified, it will inherit the size of its base image. @@ -233,11 +233,11 @@ The `initialize_params` block supports: For instance, the image `centos-6-v20180104` includes its family name `centos-6`. These images can be referred by family name here. -The `scratch_disk` block supports: +The `scratch_disk` block supports: * `interface` - (Required) The disk interface to use for attaching this disk; either SCSI or NVME. -The `attached_disk` block supports: +The `attached_disk` block supports: * `source` - (Required) The name or self_link of the disk to attach to this instance. @@ -258,12 +258,12 @@ The `attached_disk` block supports: stored in Google Cloud KMS to encrypt this disk. Only one of `kms_key_self_link` and `disk_encryption_key_raw` may be set. -The `network_performance_config` block supports: +The `network_performance_config` block supports: * `total_egress_bandwidth_tier` - (Optional) The egress bandwidth tier to enable. Possible values: TIER_1, DEFAULT -The `network_interface` block supports: +The `network_interface` block supports: * `network` - (Optional) The name or self_link of the network to attach this interface to. Either `network` or `subnetwork` must be provided. If network isn't provided it will @@ -290,11 +290,11 @@ The `network_interface` block supports: is not accessible from the Internet. If omitted, ssh provisioners will not work unless Terraform can send traffic to the instance's network (e.g. via tunnel or because it is running on another cloud instance on that network). - This block can be repeated multiple times. Structure documented below. + This block can be repeated multiple times. Structure [documented below](#nested_access_config). * `alias_ip_range` - (Optional) An array of alias IP ranges for this network interface. Can only be specified for network - interfaces on subnet-mode networks. Structure documented below. + interfaces on subnet-mode networks. Structure [documented below](#nested_alias_ip_range). * `nic_type` - (Optional) The type of vNIC to be used on this interface. Possible values: GVNIC, VIRTIO_NET. @@ -302,10 +302,10 @@ The `network_interface` block supports: * `ipv6_access_config` - (Optional) An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig -specified, then this instance will have no external IPv6 Internet access. Structure documented below. +specified, then this instance will have no external IPv6 Internet access. Structure [documented below](#nested_ipv6_access_config). -The `access_config` block supports: +The `access_config` block supports: * `nat_ip` - (Optional) The IP address that will be 1:1 mapped to the instance's network ip. If not given, one will be generated. @@ -319,7 +319,7 @@ The `access_config` block supports: This field can take the following values: PREMIUM or STANDARD. If this field is not specified, it is assumed to be PREMIUM. -The `ipv6_access_config` block supports: +The `ipv6_access_config` block supports: * `public_ptr_domain_name` - (Optional) The domain name to be used when creating DNSv6 records for the external IPv6 ranges.. @@ -327,7 +327,7 @@ The `ipv6_access_config` block supports: * `network_tier` - (Optional) The service-level to be provided for IPv6 traffic when the subnet has an external subnet. Only PREMIUM tier is valid for IPv6. -The `alias_ip_range` block supports: +The `alias_ip_range` block supports: * `ip_cidr_range` - The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by @@ -338,7 +338,7 @@ The `alias_ip_range` block supports: the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. -The `service_account` block supports: +The `service_account` block supports: * `email` - (Optional) The service account e-mail address. If not given, the default Google Compute Engine service account is used. @@ -349,7 +349,7 @@ The `service_account` block supports: `cloud-platform` scope. See a complete list of scopes [here](https://cloud.google.com/sdk/gcloud/reference/alpha/compute/instances/set-scopes#--scopes). **Note**: [`allow_stopping_for_update`](#allow_stopping_for_update) must be set to true or your instance must have a `desired_status` of `TERMINATED` in order to update this field. -The `scheduling` block supports: +The `scheduling` block supports: * `preemptible` - (Optional) Specifies if the instance is preemptible. If this field is set to true, then `automatic_restart` must be @@ -367,17 +367,17 @@ The `scheduling` block supports: to determine which sole-tenant nodes your instances and managed instance groups will use as host systems. Read more on sole-tenant node creation [here](https://cloud.google.com/compute/docs/nodes/create-nodes). - Structure documented below. + Structure [documented below](#nested_node_affinities). * `min_node_cpus` - (Optional) The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. -The `guest_accelerator` block supports: +The `guest_accelerator` block supports: * `type` (Required) - The accelerator type resource to expose to this instance. E.g. `nvidia-tesla-k80`. * `count` (Required) - The number of the guest accelerator cards exposed to this instance. -The `node_affinities` block supports: +The `node_affinities` block supports: * `key` (Required) - The key for the node affinity label. @@ -386,7 +386,7 @@ The `node_affinities` block supports: * `values` (Required) - The values for the node affinity label. -The `shielded_instance_config` block supports: +The `shielded_instance_config` block supports: * `enable_secure_boot` (Optional) -- Verify the digital signature of all boot components, and halt the boot process if signature verification fails. Defaults to false. **Note**: [`allow_stopping_for_update`](#allow_stopping_for_update) must be set to true or your instance must have a `desired_status` of `TERMINATED` in order to update this field. @@ -397,24 +397,24 @@ The `shielded_instance_config` block supports: * `enable_integrity_monitoring` (Optional) -- Compare the most recent boot measurements to the integrity policy baseline and return a pair of pass/fail results depending on whether they match or not. Defaults to true. **Note**: [`allow_stopping_for_update`](#allow_stopping_for_update) must be set to true or your instance must have a `desired_status` of `TERMINATED` in order to update this field. -The `confidential_instance_config` block supports: +The `confidential_instance_config` block supports: * `enable_confidential_compute` (Optional) Defines whether the instance should have confidential compute enabled. [`on_host_maintenance`](#on_host_maintenance) has to be set to TERMINATE or this will fail to create the VM. -The `advanced_machine_features` block supports: +The `advanced_machine_features` block supports: * `enable_nested_virtualization` (Optional) Defines whether the instance should have [nested virtualization](#on_host_maintenance) enabled. Defaults to false. * `threads_per_core` (Optional) he number of threads per physical core. To disable [simultaneous multithreading (SMT)](https://cloud.google.com/compute/docs/instances/disabling-smt) set this to 1. -The `reservation_affinity` block supports: +The `reservation_affinity` block supports: * `type` - (Required) The type of reservation from which this instance can consume resources. * `specific_reservation` - (Optional) Specifies the label selector for the reservation to use.. - Structure is documented below. + Structure is [documented below](#nested_specific_reservation). -The `specific_reservation` block supports: +The `specific_reservation` block supports: * `key` - (Required) Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify compute.googleapis.com/reservation-name as the key and specify the name of your reservation as the only value. diff --git a/website/docs/r/compute_instance_group.html.markdown b/website/docs/r/compute_instance_group.html.markdown index 7ad90378ba0..671659dd15f 100644 --- a/website/docs/r/compute_instance_group.html.markdown +++ b/website/docs/r/compute_instance_group.html.markdown @@ -140,7 +140,7 @@ The following arguments are supported: network and zone as the instance group. * `named_port` - (Optional) The named port configuration. See the section below - for details on configuration. + for details on configuration. Structure is [documented below](#nested_named_port). * `project` - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used. @@ -150,7 +150,7 @@ The following arguments are supported: fails. Defaults to the network where the instances are in (if neither `network` nor `instances` is specified, this field will be blank). -The `named_port` block supports: +The `named_port` block supports: * `name` - (Required) The name which the port will be mapped to. diff --git a/website/docs/r/compute_instance_group_manager.html.markdown b/website/docs/r/compute_instance_group_manager.html.markdown index a81006d6d00..173e6ebd843 100644 --- a/website/docs/r/compute_instance_group_manager.html.markdown +++ b/website/docs/r/compute_instance_group_manager.html.markdown @@ -96,7 +96,7 @@ The following arguments are supported: * `version` - (Required) Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. - Structure is documented below. + Structure is [documented below](#nested_version). * `name` - (Required) The name of the instance group manager. Must be 1-63 characters long and comply with @@ -111,7 +111,7 @@ The following arguments are supported: * `description` - (Optional) An optional textual description of the instance group manager. -* `named_port` - (Optional) The named port configuration. See the section below +* `named_port` - (Optional) The named port configuration. See the [section below](#nested_named_port) for details on configuration. * `project` - (Optional) The ID of the project in which the resource belongs. If it @@ -137,15 +137,15 @@ The following arguments are supported: --- * `auto_healing_policies` - (Optional) The autohealing policies for this managed instance -group. You can specify only one value. Structure is documented below. For more information, see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances#monitoring_groups). +group. You can specify only one value. Structure is [documented below](#nested_auto_healing_policies). For more information, see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances#monitoring_groups). -* `stateful_disk` - (Optional)) Disks created on the instances that will be preserved on instance delete, update, etc. Structure is documented below. For more information see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/configuring-stateful-disks-in-migs). +* `stateful_disk` - (Optional)) Disks created on the instances that will be preserved on instance delete, update, etc. Structure is [documented below](#nested_stateful_disk). For more information see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/configuring-stateful-disks-in-migs). -* `update_policy` - (Optional) The update policy for this managed instance group. Structure is documented below. For more information, see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/updating-managed-instance-groups) and [API](https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/patch) +* `update_policy` - (Optional) The update policy for this managed instance group. Structure is [documented below](#nested_update_policy). For more information, see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/updating-managed-instance-groups) and [API](https://cloud.google.com/compute/docs/reference/rest/v1/instanceGroupManagers/patch) - - - -The `update_policy` block supports: +The `update_policy` block supports: ```hcl update_policy { @@ -175,21 +175,21 @@ update_policy { * `replacement_method` - (Optional), The instance replacement method for managed instance groups. Valid values are: "RECREATE", "SUBSTITUTE". If SUBSTITUTE (default), the group replaces VM instances with new instances that have randomly generated names. If RECREATE, instance names are preserved. You must also set max_unavailable_fixed or max_unavailable_percent to be greater than 0. - - - -The `named_port` block supports: (Include a `named_port` block for each named-port required). +The `named_port` block supports: (Include a `named_port` block for each named-port required). * `name` - (Required) The name of the port. * `port` - (Required) The port number. - - - -The `auto_healing_policies` block supports: +The `auto_healing_policies` block supports: * `health_check` - (Required) The health check resource that signals autohealing. * `initial_delay_sec` - (Required) The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. Between 0 and 3600. -The `version` block supports: +The `version` block supports: ```hcl version { @@ -217,13 +217,13 @@ version { * `instance_template` - (Required) - The full URL to an instance template from which all new instances of this version will be created. -* `target_size` - (Optional) - The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below. +* `target_size` - (Optional) - The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is [documented below](#nested_target_size). -> Exactly one `version` you specify must not have a `target_size` specified. During a rolling update, the instance group manager will fulfill the `target_size` constraints of every other `version`, and any remaining instances will be provisioned with the version where `target_size` is unset. -The `target_size` block supports: +The `target_size` block supports: * `fixed` - (Optional), The number of instances which are managed for this version. Conflicts with `percent`. @@ -231,7 +231,7 @@ The `target_size` block supports: Note that when using `percent`, rounding will be in favor of explicitly set `target_size` values; a managed instance group with 2 instances and 2 `version`s, one of which has a `target_size.percent` of `60` will create 2 instances of that `version`. -The `stateful_disk` block supports: (Include a `stateful_disk` block for each stateful disk required). +The `stateful_disk` block supports: (Include a `stateful_disk` block for each stateful disk required). * `device_name` - (Required), The device name of the disk to be attached. diff --git a/website/docs/r/compute_instance_template.html.markdown b/website/docs/r/compute_instance_template.html.markdown index fd55fd5fc1c..9248c105390 100644 --- a/website/docs/r/compute_instance_template.html.markdown +++ b/website/docs/r/compute_instance_template.html.markdown @@ -205,7 +205,7 @@ The following arguments are supported: * `disk` - (Required) Disks to attach to instances created from this template. This can be specified multiple times for multiple disks. Structure is - documented below. + [documented below](#nested_disk). * `machine_type` - (Required) The machine type to create. @@ -239,11 +239,11 @@ The following arguments are supported: * `network_interface` - (Required) Networks to attach to instances created from this template. This can be specified multiple times for multiple networks. - Structure is documented below. + Structure is [documented below](#nested_network_interface). * `network_performance_config` (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html) Configures network performance settings for the instance created from the - template. Structure is documented below. **Note**: [`machine_type`](#machine_type) + template. Structure is [documented below](#nested_network_performance_config). **Note**: [`machine_type`](#machine_type) must be a [supported type](https://cloud.google.com/compute/docs/networking/configure-vm-with-high-bandwidth-configuration), the [`image`](#image) used must include the [`GVNIC`](https://cloud.google.com/compute/docs/networking/using-gvnic#create-instance-gvnic-image) in `guest-os-features`, and `network_interface.0.nic-type` must be `GVNIC` @@ -260,31 +260,31 @@ The following arguments are supported: Provider if no value is given. * `reservation_affinity` - (Optional) Specifies the reservations that this instance can consume from. - Structure is documented below. + Structure is [documented below](#nested_reservation_affinity). * `scheduling` - (Optional) The scheduling strategy to use. More details about - this configuration option are detailed below. + this configuration option are [detailed below](#nested_scheduling). -* `service_account` - (Optional) Service account to attach to the instance. Structure is documented below. +* `service_account` - (Optional) Service account to attach to the instance. Structure is [documented below](#nested_service_account). * `tags` - (Optional) Tags to attach to the instance. -* `guest_accelerator` - (Optional) List of the type and count of accelerator cards attached to the instance. Structure documented below. +* `guest_accelerator` - (Optional) List of the type and count of accelerator cards attached to the instance. Structure [documented below](#nested_guest_accelerator). * `min_cpu_platform` - (Optional) Specifies a minimum CPU platform. Applicable values are the friendly names of CPU platforms, such as `Intel Haswell` or `Intel Skylake`. See the complete list [here](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). -* `shielded_instance_config` - (Optional) Enable [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm) on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. +* `shielded_instance_config` - (Optional) Enable [Shielded VM](https://cloud.google.com/security/shielded-cloud/shielded-vm) on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is [documented below](#nested_shielded_instance_config). **Note**: [`shielded_instance_config`](#shielded_instance_config) can only be used with boot images with shielded vm support. See the complete list [here](https://cloud.google.com/compute/docs/images#shielded-images). * `enable_display` - (Optional)) Enable [Virtual Displays](https://cloud.google.com/compute/docs/instances/enable-instance-virtual-display#verify_display_driver) on this instance. **Note**: [`allow_stopping_for_update`](#allow_stopping_for_update) must be set to true in order to update this field. Note: This attribute is currently in beta and will be removed from the google provider. Please use the google-beta provider to continue using this attribute. -* `confidential_instance_config` (Optional) - Enable [Confidential Mode](https://cloud.google.com/compute/confidential-vm/docs/about-cvm) on this VM. +* `confidential_instance_config` (Optional) - Enable [Confidential Mode](https://cloud.google.com/compute/confidential-vm/docs/about-cvm) on this VM. Structure is [documented below](#nested_confidential_instance_config) -* `advanced_machine_features` (Optional) - Configure Nested Virtualisation and Simultaneous Hyper Threading on this VM. +* `advanced_machine_features` (Optional) - Configure Nested Virtualisation and Simultaneous Hyper Threading on this VM. Structure is [documented below](#nested_advanced_machine_features) -The `disk` block supports: +The `disk` block supports: * `auto_delete` - (Optional) Whether or not the disk should be auto-deleted. This defaults to true. @@ -348,7 +348,7 @@ The `disk_encryption_key` block supports: * `kms_key_self_link` - (Required) The self link of the encryption key that is stored in Google Cloud KMS -The `network_interface` block supports: +The `network_interface` block supports: * `network` - (Optional) The name or self_link of the network to attach this interface to. Use `network` attribute for Legacy or Auto subnetted networks and @@ -369,11 +369,11 @@ The `network_interface` block supports: is not accessible from the Internet (this means that ssh provisioners will not work unless you are running Terraform can send traffic to the instance's network (e.g. via tunnel or because it is running on another cloud instance - on that network). This block can be repeated multiple times. Structure documented below. + on that network). This block can be repeated multiple times. Structure [documented below](#nested_access_config). * `alias_ip_range` - (Optional) An array of alias IP ranges for this network interface. Can only be specified for network - interfaces on subnet-mode networks. Structure documented below. + interfaces on subnet-mode networks. Structure [documented below](#nested_alias_ip_range). * `nic_type` - (Optional) The type of vNIC to be used on this interface. Possible values: GVNIC, VIRTIO_NET. @@ -381,9 +381,9 @@ The `network_interface` block supports: * `ipv6_access_config` - (Optional) An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig -specified, then this instance will have no external IPv6 Internet access. Structure documented below. +specified, then this instance will have no external IPv6 Internet access. Structure [documented below](#nested_ipv6_access_config). -The `access_config` block supports: +The `access_config` block supports: * `nat_ip` - (Optional) The IP address that will be 1:1 mapped to the instance's network ip. If not given, one will be generated. @@ -392,12 +392,12 @@ The `access_config` block supports: this instance template. This field can take the following values: PREMIUM or STANDARD. If this field is not specified, it is assumed to be PREMIUM. -The `ipv6_access_config` block supports: +The `ipv6_access_config` block supports: * `network_tier` - (Optional) The service-level to be provided for IPv6 traffic when the subnet has an external subnet. Only PREMIUM tier is valid for IPv6. -The `alias_ip_range` block supports: +The `alias_ip_range` block supports: * `ip_cidr_range` - The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by @@ -409,7 +409,7 @@ The `alias_ip_range` block supports: the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. -The `service_account` block supports: +The `service_account` block supports: * `email` - (Optional) The service account e-mail address. If not given, the default Google Compute Engine service account is used. @@ -423,7 +423,7 @@ The `service_account` block supports: If you are following best practices and using IAM roles to grant permissions to service accounts, then you can define this field as an empty list. -The `scheduling` block supports: +The `scheduling` block supports: * `automatic_restart` - (Optional) Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not @@ -440,15 +440,15 @@ The `scheduling` block supports: to determine which sole-tenant nodes your instances and managed instance groups will use as host systems. Read more on sole-tenant node creation [here](https://cloud.google.com/compute/docs/nodes/create-nodes). - Structure documented below. + Structure [documented below](#nested_node_affinities). -The `guest_accelerator` block supports: +The `guest_accelerator` block supports: * `type` (Required) - The accelerator type resource to expose to this instance. E.g. `nvidia-tesla-k80`. * `count` (Required) - The number of the guest accelerator cards exposed to this instance. -The `node_affinities` block supports: +The `node_affinities` block supports: * `key` (Required) - The key for the node affinity label. @@ -457,7 +457,7 @@ The `node_affinities` block supports: * `value` (Required) - The values for the node affinity label. -The `reservation_affinity` block supports: +The `reservation_affinity` block supports: * `type` - (Required) The type of reservation from which this instance can consume resources. @@ -470,7 +470,7 @@ The `specific_reservation` block supports: * `values` - (Required) Corresponds to the label values of a reservation resource. -The `shielded_instance_config` block supports: +The `shielded_instance_config` block supports: * `enable_secure_boot` (Optional) -- Verify the digital signature of all boot components, and halt the boot process if signature verification fails. Defaults to false. @@ -478,15 +478,15 @@ The `shielded_instance_config` block supports: * `enable_integrity_monitoring` (Optional) -- Compare the most recent boot measurements to the integrity policy baseline and return a pair of pass/fail results depending on whether they match or not. Defaults to true. -The `confidential_instance_config` block supports: +The `confidential_instance_config` block supports: * `enable_confidential_compute` (Optional) Defines whether the instance should have confidential compute enabled. [`on_host_maintenance`](#on_host_maintenance) has to be set to TERMINATE or this will fail to create the VM. -The `network_performance_config` block supports: +The `network_performance_config` block supports: * `total_egress_bandwidth_tier` - (Optional) The egress bandwidth tier to enable. Possible values: TIER_1, DEFAULT -The `advanced_machine_features` block supports: +The `advanced_machine_features` block supports: * `enable_nested_virtualization` (Optional) Defines whether the instance should have [nested virtualization](#on_host_maintenance) enabled. Defaults to false. diff --git a/website/docs/r/compute_region_instance_group_manager.html.markdown b/website/docs/r/compute_region_instance_group_manager.html.markdown index 8d9c2cf3377..70f5d7bbfc4 100644 --- a/website/docs/r/compute_region_instance_group_manager.html.markdown +++ b/website/docs/r/compute_region_instance_group_manager.html.markdown @@ -99,7 +99,7 @@ The following arguments are supported: * `version` - (Required) Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. - Structure is documented below. + Structure is [documented below](#nested_version). * `name` - (Required) The name of the instance group manager. Must be 1-63 characters long and comply with @@ -113,7 +113,7 @@ The following arguments are supported: * `description` - (Optional) An optional textual description of the instance group manager. -* `named_port` - (Optional) The named port configuration. See the section below +* `named_port` - (Optional) The named port configuration. See the [section below](#nested_named_port) for details on configuration. * `project` - (Optional) The ID of the project in which the resource belongs. If it @@ -142,7 +142,7 @@ The following arguments are supported: group. You can specify only one value. Structure is documented below. For more information, see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances#monitoring_groups). -* `update_policy` - (Optional) The update policy for this managed instance group. Structure is documented below. For more information, see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/updating-managed-instance-groups) and [API](https://cloud.google.com/compute/docs/reference/rest/beta/regionInstanceGroupManagers/patch) +* `update_policy` - (Optional) The update policy for this managed instance group. Structure is [documented below](#nested_update_policy). For more information, see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/updating-managed-instance-groups) and [API](https://cloud.google.com/compute/docs/reference/rest/beta/regionInstanceGroupManagers/patch) * `distribution_policy_zones` - (Optional) The distribution policy for this managed instance @@ -150,11 +150,11 @@ group. You can specify one or more values. For more information, see the [offici * `distribution_policy_target_shape` - (Optional) The shape to which the group converges either proactively or on resize events (depending on the value set in update_policy.0.instance_redistribution_type). For more information see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/regional-mig-distribution-shape). -* `stateful_disk` - (Optional) Disks created on the instances that will be preserved on instance delete, update, etc. Structure is documented below. For more information see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/configuring-stateful-disks-in-migs). Proactive cross zone instance redistribution must be disabled before you can update stateful disks on existing instance group managers. This can be controlled via the `update_policy`. +* `stateful_disk` - (Optional) Disks created on the instances that will be preserved on instance delete, update, etc. Structure is [documented below](#nested_stateful_disk). For more information see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/configuring-stateful-disks-in-migs). Proactive cross zone instance redistribution must be disabled before you can update stateful disks on existing instance group managers. This can be controlled via the `update_policy`. - - - -The `update_policy` block supports: +The `update_policy` block supports: ```hcl update_policy { @@ -187,7 +187,7 @@ update_policy { * `replacement_method` - (Optional), The instance replacement method for managed instance groups. Valid values are: "RECREATE", "SUBSTITUTE". If SUBSTITUTE (default), the group replaces VM instances with new instances that have randomly generated names. If RECREATE, instance names are preserved. You must also set max_unavailable_fixed or max_unavailable_percent to be greater than 0. - - - -The `named_port` block supports: (Include a `named_port` block for each named-port required). +The `named_port` block supports: (Include a `named_port` block for each named-port required). * `name` - (Required) The name of the port. @@ -201,7 +201,7 @@ The `auto_healing_policies` block supports: * `initial_delay_sec` - (Required) The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. Between 0 and 3600. -The `version` block supports: +The `version` block supports: ```hcl version { @@ -229,12 +229,12 @@ version { * `instance_template` - (Required) - The full URL to an instance template from which all new instances of this version will be created. -* `target_size` - (Optional) - The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below. +* `target_size` - (Optional) - The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is [documented below](#nested_target_size). -> Exactly one `version` you specify must not have a `target_size` specified. During a rolling update, the instance group manager will fulfill the `target_size` constraints of every other `version`, and any remaining instances will be provisioned with the version where `target_size` is unset. -The `target_size` block supports: +The `target_size` block supports: * `fixed` - (Optional), The number of instances which are managed for this version. Conflicts with `percent`. @@ -242,7 +242,7 @@ The `target_size` block supports: Note that when using `percent`, rounding will be in favor of explicitly set `target_size` values; a managed instance group with 2 instances and 2 `version`s, one of which has a `target_size.percent` of `60` will create 2 instances of that `version`. -The `stateful_disk` block supports: (Include a `stateful_disk` block for each stateful disk required). +The `stateful_disk` block supports: (Include a `stateful_disk` block for each stateful disk required). * `device_name` - (Required), The device name of the disk to be attached. diff --git a/website/docs/r/compute_security_policy.html.markdown b/website/docs/r/compute_security_policy.html.markdown index 55a5a650b74..ce6a1d2623c 100644 --- a/website/docs/r/compute_security_policy.html.markdown +++ b/website/docs/r/compute_security_policy.html.markdown @@ -62,11 +62,11 @@ The following arguments are supported: * `rule` - (Optional) The set of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "\*"). If no rules are provided when creating a - security policy, a default rule with action "allow" will be added. Structure is documented below. + security policy, a default rule with action "allow" will be added. Structure is [documented below](#nested_rule). -* `adaptive_protection_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview?hl=en). Structure is documented below. +* `adaptive_protection_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for [Google Cloud Armor Adaptive Protection](https://cloud.google.com/armor/docs/adaptive-protection-overview?hl=en). Structure is [documented below](#nested_adaptive_protection_config). -The `rule` block supports: +The `rule` block supports: * `action` - (Required) Action to take when `match` matches the request. Valid values: * "allow" : allow access to target @@ -76,18 +76,18 @@ The `rule` block supports: Rules are evaluated from highest priority (lowest numerically) to lowest priority (highest numerically) in order. * `match` - (Required) A match condition that incoming traffic is evaluated against. - If it evaluates to true, the corresponding `action` is enforced. Structure is documented below. + If it evaluates to true, the corresponding `action` is enforced. Structure is [documented below](#nested_match). * `description` - (Optional) An optional description of this rule. Max size is 64. * `preview` - (Optional) When set to true, the `action` specified above is not enforced. Stackdriver logs for requests that trigger a preview action are annotated as such. -The `match` block supports: +The `match` block supports: * `config` - (Optional) The configuration options available when specifying `versioned_expr`. This field must be specified if `versioned_expr` is specified and cannot be specified if `versioned_expr` is not specified. - Structure is documented below. + Structure is [documented below](#nested_config). * `versioned_expr` - (Optional) Predefined rule expression. If this field is specified, `config` must also be specified. Available options: @@ -95,24 +95,24 @@ The `match` block supports: * `expr` - (Optional) User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. - Structure is documented below. + Structure is [documented below](#nested_expr). -The `config` block supports: +The `config` block supports: * `src_ip_ranges` - (Required) Set of IP addresses or ranges (IPV4 or IPV6) in CIDR notation to match against inbound traffic. There is a limit of 10 IP ranges per rule. A value of '\*' matches all IPs (can be used to override the default behavior). -The `expr` block supports: +The `expr` block supports: * `expression` - (Required) Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. -The `adaptive_protection_config` block supports: +The `adaptive_protection_config` block supports: -* `layer_7_ddos_defense_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for [Google Cloud Armor Adaptive Protection Layer 7 DDoS Defense](https://cloud.google.com/armor/docs/adaptive-protection-overview?hl=en). Structure is documented below. +* `layer_7_ddos_defense_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for [Google Cloud Armor Adaptive Protection Layer 7 DDoS Defense](https://cloud.google.com/armor/docs/adaptive-protection-overview?hl=en). Structure is [documented below](#nested_layer_7_ddos_defense_config). -The `layer_7_ddos_defense_config` block supports: +The `layer_7_ddos_defense_config` block supports: * `enable` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) If set to true, enables CAAP for L7 DDoS detection. diff --git a/website/docs/r/container_cluster.html.markdown b/website/docs/r/container_cluster.html.markdown index 320a8519c97..13dabf8a4c9 100644 --- a/website/docs/r/container_cluster.html.markdown +++ b/website/docs/r/container_cluster.html.markdown @@ -122,7 +122,7 @@ in multiple zones in the region. For that reason, regional clusters should be preferred. * `addons_config` - (Optional) The configuration for addons supported by GKE. - Structure is documented below. + Structure is [documented below](#nested_addons_config). * `cluster_ipv4_cidr` - (Optional) The IP address range of the Kubernetes pods in this cluster in CIDR notation (e.g. `10.96.0.0/14`). Leave blank to have one @@ -134,10 +134,10 @@ Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster's workload. See the [guide to using Node Auto-Provisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) -for more details. Structure is documented below. +for more details. Structure is [documented below](#nested_cluster_autoscaling). * `database_encryption` - (Optional) - Structure is documented below. + Structure is [documented below](#nested_database_encryption). * `description` - (Optional) Description of the cluster. @@ -177,33 +177,35 @@ set this to a value of at least `1`, alongside setting * `ip_allocation_policy` - (Optional) Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables [IP aliasing](https://cloud.google.com/kubernetes-engine/docs/how-to/ip-aliases), -making the cluster VPC-native instead of routes-based. Structure is documented -below. +making the cluster VPC-native instead of routes-based. Structure is [documented +below](#nested_ip_allocation_policy). * `networking_mode` - (Optional, [Beta]) Determines whether alias IPs or routes will be used for pod IPs in the cluster. Options are `VPC_NATIVE` or `ROUTES`. `VPC_NATIVE` enables [IP aliasing](https://cloud.google.com/kubernetes-engine/docs/how-to/ip-aliases), and requires the `ip_allocation_policy` block to be defined. By default when this field is unspecified, GKE will create a `ROUTES`-based cluster. * `logging_config` - (Optional) Logging configuration for the cluster. - Structure is documented below. + Structure is [documented below](#nested_logging_config). * `logging_service` - (Optional) The logging service that the cluster should write logs to. Available options include `logging.googleapis.com`(Legacy Stackdriver), `logging.googleapis.com/kubernetes`(Stackdriver Kubernetes Engine Logging), and `none`. Defaults to `logging.googleapis.com/kubernetes` * `maintenance_policy` - (Optional) The maintenance policy to use for the cluster. Structure is - documented below. + [documented below](#nested_maintenance_policy). * `master_auth` - (Optional) The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff removing a username/password or unsetting your client cert, ensure you have the `container.clusters.getCredentials` permission. -Structure is documented below. This has been deprecated as of GKE 1.19. +Structure is [documented below](#nested_master_auth). This has been deprecated as of GKE 1.19. -* `master_authorized_networks_config` - (Optional) The desired configuration options - for master authorized networks. Omit the nested `cidr_blocks` attribute to disallow - external access (except the cluster node IPs, which GKE automatically whitelists). +* `master_authorized_networks_config` - (Optional) The desired + configuration options for master authorized networks. Omit the + nested `cidr_blocks` attribute to disallow external access (except + the cluster node IPs, which GKE automatically whitelists). + Structure is [documented below](#nested_master_authorized_networks_config). * `min_master_version` - (Optional) The minimum version of the master. GKE will auto-update the master to new versions, so this does not guarantee the @@ -221,7 +223,7 @@ to the datasource. A region can have a different set of supported versions than region are guaranteed to support the same version. * `monitoring_config` - (Optional) Monitoring configuration for the cluster. - Structure is documented below. + Structure is [documented below](#nested_monitoring_config). * `monitoring_service` - (Optional) The monitoring service that the cluster should write metrics to. @@ -237,16 +239,16 @@ region are guaranteed to support the same version. * `network_policy` - (Optional) Configuration options for the [NetworkPolicy](https://kubernetes.io/docs/concepts/services-networking/networkpolicies/) - feature. Structure is documented below. + feature. Structure is [documented below](#nested_network_policy). * `node_config` - (Optional) Parameters used in creating the default node pool. Generally, this field should not be used at the same time as a `google_container_node_pool` or a `node_pool` block; this configuration manages the default node pool, which isn't recommended to be used with - Terraform. Structure is documented below. + Terraform. Structure is [documented below](#nested_node_config). * `network_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for - [Adding Pod IP address ranges](https://cloud.google.com/kubernetes-engine/docs/how-to/multi-pod-cidr)) to the node pool. + [Adding Pod IP address ranges](https://cloud.google.com/kubernetes-engine/docs/how-to/multi-pod-cidr)) to the node pool. Structure is [documented below](#nested_network_config) * `node_pool` - (Optional) List of node pools associated with this cluster. See [google_container_node_pool](container_node_pool.html) for schema. @@ -264,22 +266,22 @@ region are guaranteed to support the same version. `version_prefix` field to approximate fuzzy versions in a Terraform-compatible way. To update nodes in other node pools, use the `version` attribute on the node pool. -* `notification_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for the [cluster upgrade notifications](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-upgrade-notifications) feature. Structure is documented below. +* `notification_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for the [cluster upgrade notifications](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-upgrade-notifications) feature. Structure is [documented below](#nested_notification_config). * `pod_security_policy_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for the [PodSecurityPolicy](https://cloud.google.com/kubernetes-engine/docs/how-to/pod-security-policies) feature. - Structure is documented below. + Structure is [documented below](#nested_pod_security_policy_config). * `authenticator_groups_config` - (Optional) Configuration for the [Google Groups for GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/role-based-access-control#groups-setup-gsuite) feature. - Structure is documented below. + Structure is [documented below](#nested_authenticator_groups_config). * `private_cluster_config` - (Optional) Configuration for [private clusters](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters), -clusters with private nodes. Structure is documented below. +clusters with private nodes. Structure is [documented below](#nested_private_cluster_config). * `cluster_telemetry` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Configuration for [ClusterTelemetry](https://cloud.google.com/monitoring/kubernetes-engine/installing#controlling_the_collection_of_application_logs) feature, - Structure is documented below. + Structure is [documented below](#nested_cluster_telemetry). * `project` - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used. @@ -293,7 +295,7 @@ for more details; the `google_container_engine_versions` datasource can provide the default version for a channel. Note that removing the `release_channel` field from your config will cause Terraform to stop managing your cluster's release channel, but will not unenroll it. Instead, use the `"UNSPECIFIED"` -channel. Structure is documented below. +channel. Structure is [documented below](#nested_release_channel). * `remove_default_node_pool` - (Optional) If `true`, deletes the default node pool upon cluster creation. If you're using `google_container_node_pool` @@ -304,19 +306,19 @@ channel. Structure is documented below. * `resource_usage_export_config` - (Optional) Configuration for the [ResourceUsageExportConfig](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-usage-metering) feature. - Structure is documented below. + Structure is [documented below](#nested_resource_usage_export_config). * `subnetwork` - (Optional) The name or self_link of the Google Compute Engine subnetwork in which the cluster's instances are launched. * `vertical_pod_autoscaling` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. - Structure is documented below. + Structure is [documented below](#nested_vertical_pod_autoscaling). * `workload_identity_config` - (Optional) Workload Identity allows Kubernetes service accounts to act as a user-managed [Google IAM Service Account](https://cloud.google.com/iam/docs/service-accounts#user-managed_service_accounts). - Structure is documented below. + Structure is [documented below](#nested_workload_identity_config). * `enable_intranode_visibility` - (Optional) Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. @@ -331,20 +333,20 @@ subnetwork in which the cluster's instances are launched. The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. * `default_snat_status` - (Optional) - [GKE SNAT](https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent#how_ipmasq_works) DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster, [API doc](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters#networkconfig). + [GKE SNAT](https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent#how_ipmasq_works) DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster, [API doc](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters#networkconfig). Structure is [documented below](#nested_default_snat_status) * `dns_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) - Configuration for [Using Cloud DNS for GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/cloud-dns). Structure is documented below. + Configuration for [Using Cloud DNS for GKE](https://cloud.google.com/kubernetes-engine/docs/how-to/cloud-dns). Structure is [documented below](#nested_dns_config). -The `default_snat_status` block supports +The `default_snat_status` block supports * `disabled` - (Required) Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus is disabled.When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic -The `cluster_telemetry` block supports +The `cluster_telemetry` block supports * `type` - Telemetry integration for the cluster. Supported values (`ENABLED, DISABLED, SYSTEM_ONLY`); `SYSTEM_ONLY` (Only system components are monitored and logged) is only available in GKE versions 1.15 and later. -The `addons_config` block supports: +The `addons_config` block supports: * `horizontal_pod_autoscaling` - (Optional) The status of the Horizontal Pod Autoscaling addon, which increases or decreases the number of replica pods a replication controller @@ -363,10 +365,10 @@ The `addons_config` block supports: It can only be disabled if the nodes already do not have network policies enabled. Defaults to disabled; set `disabled = false` to enable. -* `cloudrun_config` - (Optional). Structure is documented below. +* `cloudrun_config` - (Optional). Structure is [documented below](#nested_cloudrun_config). * `istio_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)). - Structure is documented below. + Structure is [documented below](#nested_istio_config). * `dns_cache_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)). The status of the NodeLocal DNSCache addon. It is disabled by default. @@ -398,27 +400,27 @@ addons_config { } ``` -The `database_encryption` block supports: +The `database_encryption` block supports: * `state` - (Required) `ENCRYPTED` or `DECRYPTED` * `key_name` - (Required) the key to use to encrypt/decrypt secrets. See the [DatabaseEncryption definition](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters#Cluster.DatabaseEncryption) for more information. -The `cloudrun_config` block supports: +The `cloudrun_config` block supports: * `disabled` - (Optional) The status of the CloudRun addon. It is disabled by default. Set `disabled=false` to enable. * `load_balancer_type` - (Optional) The load balancer type of CloudRun ingress service. It is external load balancer by default. Set `load_balancer_type=LOAD_BALANCER_TYPE_INTERNAL` to configure it as internal load balancer. -The `istio_config` block supports: +The `istio_config` block supports: * `disabled` - (Optional) The status of the Istio addon, which makes it easy to set up Istio for services in a cluster. It is disabled by default. Set `disabled = false` to enable. * `auth` - (Optional) The authentication type between services in Istio. Available options include `AUTH_MUTUAL_TLS`. -The `cluster_autoscaling` block supports: +The `cluster_autoscaling` block supports: * `enabled` - (Required) Whether node auto-provisioning is enabled. Resource limits for `cpu` and `memory` must be defined to enable node auto-provisioning. @@ -426,17 +428,17 @@ limits for `cpu` and `memory` must be defined to enable node auto-provisioning. * `resource_limits` - (Optional) Global constraints for machine resources in the cluster. Configuring the `cpu` and `memory` types is required if node auto-provisioning is enabled. These limits will apply to node pool autoscaling -in addition to node auto-provisioning. Structure is documented below. +in addition to node auto-provisioning. Structure is [documented below](#nested_resource_limits). * `auto_provisioning_defaults` - (Optional) Contains defaults for a node pool created by NAP. -Structure is documented below. +Structure is [documented below](#nested_auto_provisioning_defaults). * `autoscaling_profile` - (Optional, [Beta](https://terraform.io/docs/providers/google/provider_versions.html)) Configuration options for the [Autoscaling profile](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-autoscaler#autoscaling_profiles) feature, which lets you choose whether the cluster autoscaler should optimize for resource utilization or resource availability when deciding to remove nodes from a cluster. Can be `BALANCED` or `OPTIMIZE_UTILIZATION`. Defaults to `BALANCED`. -The `resource_limits` block supports: +The `resource_limits` block supports: * `resource_type` - (Required) The type of the resource. For example, `cpu` and `memory`. See the [guide to using Node Auto-Provisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) @@ -446,7 +448,7 @@ for a list of types. * `maximum` - (Optional) Maximum amount of the resource in the cluster. -The `auto_provisioning_defaults` block supports: +The `auto_provisioning_defaults` block supports: * `min_cpu_platform` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the @@ -459,20 +461,20 @@ as "Intel Haswell" or "Intel Sandy Bridge". * `service_account` - (Optional) The Google Cloud Platform Service Account to be used by the node VMs. -The `authenticator_groups_config` block supports: +The `authenticator_groups_config` block supports: * `security_group` - (Required) The name of the RBAC security group for use with Google security groups in Kubernetes RBAC. Group name must be in format `gke-security-groups@yourdomain.com`. -The `logging_config` block supports: +The `logging_config` block supports: * `enable_components` - (Required) The GKE components exposing logs. Supported values include: `SYSTEM_COMPONENTS` and `WORKLOADS`. -The `monitoring_config` block supports: +The `monitoring_config` block supports: * `enable_components` - (Required) The GKE components exposing logs. `SYSTEM_COMPONENTS` and in beta provider, both `SYSTEM_COMPONENTS` and `WORKLOADS` are supported. -The `maintenance_policy` block supports: +The `maintenance_policy` block supports: * `daily_maintenance_window` - (Optional) structure documented below. * `recurring_window` - (Optional) structure documented below * `maintenance_exclusion` - (Optional) structure documented below @@ -549,7 +551,7 @@ maintenance_policy { } ``` -The `ip_allocation_policy` block supports: +The `ip_allocation_policy` block supports: * `cluster_secondary_range_name` - (Optional) The name of the existing secondary range in the cluster's subnetwork to use for pod IP addresses. Alternatively, @@ -572,7 +574,7 @@ to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10. from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. -The `master_auth` block supports: +The `master_auth` block supports: * `password` - (Optional) The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint. This has been deprecated as of GKE 1.19. @@ -593,7 +595,7 @@ master_auth { If this block is provided and both `username` and `password` are empty, basic authentication will be disabled. This block also contains several computed attributes, documented below. If this block is not provided, GKE will generate a password for you with the username `admin`. -The `master_authorized_networks_config` block supports: +The `master_authorized_networks_config` block supports: * `cidr_blocks` - (Optional) External networks that can access the Kubernetes cluster master through HTTPS. @@ -605,13 +607,13 @@ The `master_authorized_networks_config.cidr_blocks` block supports: * `display_name` - (Optional) Field for users to identify CIDR blocks. -The `network_policy` block supports: +The `network_policy` block supports: * `provider` - (Optional) The selected network policy provider. Defaults to PROVIDER_UNSPECIFIED. * `enabled` - (Required) Whether network policy is enabled on the cluster. -The `node_config` block supports: +The `node_config` block supports: * `disk_size_gb` - (Optional) Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. Defaults to 100GB. @@ -619,7 +621,7 @@ The `node_config` block supports: * `disk_type` - (Optional) Type of the disk attached to each node (e.g. 'pd-standard', 'pd-balanced' or 'pd-ssd'). If unspecified, the default disk type is 'pd-standard' -* `ephemeral_storage_config` - (Optional, [Beta]) Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. Structure is documented below. +* `ephemeral_storage_config` - (Optional, [Beta]) Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. Structure is [documented below](#nested_ephemeral_storage_config). ```hcl ephemeral_storage_config { @@ -628,7 +630,7 @@ ephemeral_storage_config { ``` * `guest_accelerator` - (Optional) List of the type and count of accelerator cards attached to the instance. - Structure documented below. + Structure [documented below](#nested_guest_accelerator). To support removal of guest_accelerators in Terraform 0.12 this field is an [Attribute as Block](/docs/configuration/attr-as-blocks.html) @@ -668,14 +670,14 @@ ephemeral_storage_config { for more information. Defaults to false. * `sandbox_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) [GKE Sandbox](https://cloud.google.com/kubernetes-engine/docs/how-to/sandbox-pods) configuration. When enabling this feature you must specify `image_type = "COS_CONTAINERD"` and `node_version = "1.12.7-gke.17"` or later to use it. - Structure is documented below. + Structure is [documented below](#nested_sandbox_config). * `boot_disk_kms_key` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption * `service_account` - (Optional) The service account to be used by the Node VMs. If not specified, the "default" service account is used. -* `shielded_instance_config` - (Optional) Shielded Instance options. Structure is documented below. +* `shielded_instance_config` - (Optional) Shielded Instance options. Structure is [documented below](#nested_shielded_instance_config). * `tags` - (Optional) The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls. @@ -687,14 +689,14 @@ as GPUs. If this field is set, any diffs on this field will cause Terraform to recreate the underlying resource. Taint values can be updated safely in Kubernetes (eg. through `kubectl`), and it's recommended that you do not use this field to manage taints. If you do, `lifecycle.ignore_changes` is -recommended. Structure is documented below. +recommended. Structure is [documented below](#nested_taint). * `workload_metadata_config` - (Optional) Metadata configuration to expose to workloads on the node pool. - Structure is documented below. + Structure is [documented below](#nested_workload_metadata_config). * `kubelet_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Kubelet configuration, currently supported attributes can be found [here](https://cloud.google.com/sdk/gcloud/reference/beta/container/node-pools/create#--system-config-from-file). -Structure is documented below. +Structure is [documented below](#nested_kubelet_config). ``` kubelet_config { @@ -707,7 +709,7 @@ kubelet_config { * `linux_node_config` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Linux node configuration, currently supported attributes can be found [here](https://cloud.google.com/sdk/gcloud/reference/beta/container/node-pools/create#--system-config-from-file). Note that validations happen all server side. All attributes are optional. -Structure is documented below. +Structure is [documented below](#nested_linux_node_config). ```hcl linux_node_config { @@ -718,7 +720,7 @@ linux_node_config { } ``` -The `network_config` block supports: +The `network_config` block supports: * `create_pod_range` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. @@ -726,17 +728,17 @@ The `network_config` block supports: * `pod_range` - (Optional, [Beta](https://terraform.io/docs/providers/google/guides/provider_versions.html)) The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. -The `ephemeral_storage_config` block supports: +The `ephemeral_storage_config` block supports: * `local_ssd_count` (Required) - Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage. -The `guest_accelerator` block supports: +The `guest_accelerator` block supports: * `type` (Required) - The accelerator type resource to expose to this instance. E.g. `nvidia-tesla-k80`. * `count` (Required) - The number of the guest accelerator cards exposed to this instance. -The `workload_identity_config` block supports: +The `workload_identity_config` block supports: * `identity_namespace` (Optional, Deprecated) - Currently, the only supported identity namespace is the project's default. @@ -748,7 +750,7 @@ workload_identity_config { } ``` -The `notification_config` block supports: +The `notification_config` block supports: * `pubsub` (Required) - The pubsub config for the cluster's upgrade notifications. @@ -767,12 +769,12 @@ notification_config { } ``` -The `pod_security_policy_config` block supports: +The `pod_security_policy_config` block supports: * `enabled` (Required) - Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created. -The `private_cluster_config` block supports: +The `private_cluster_config` block supports: * `enable_private_nodes` (Optional) - Enables the private cluster feature, creating a private endpoint on the cluster. In a private cluster, nodes only @@ -794,7 +796,7 @@ for more details. This field only applies to private clusters, when * `master_global_access_config` (Optional) - Controls cluster master global access settings. If unset, Terraform will no longer manage this field and will -not modify the previously-set value. Structure is documented below. +not modify the previously-set value. Structure is [documented below](#nested_master_global_access_config). In addition, the `private_cluster_config` allows access to the following read-only fields: @@ -808,19 +810,19 @@ In addition, the `private_cluster_config` allows access to the following read-on `private_cluster_config` when `enable_private_nodes` is `false`. It's recommended that you omit the block entirely if the field is not set to `true`. -The `private_cluster_config.master_global_access_config` block supports: +The `private_cluster_config.master_global_access_config` block supports: * `enabled` (Optional) - Whether the cluster master is accessible globally or not. -The `sandbox_config` block supports: +The `sandbox_config` block supports: * `sandbox_type` (Required) Which sandbox to use for pods in the node pool. Accepted values are: * `"gvisor"`: Pods run within a gVisor sandbox. -The `release_channel` block supports: +The `release_channel` block supports: * `channel` - (Required) The selected release channel. Accepted values are: @@ -829,7 +831,7 @@ The `release_channel` block supports: * REGULAR: Multiple per month upgrade cadence; Production users who need features not yet offered in the Stable channel. * STABLE: Every few months upgrade cadence; Production users who need stability above all else, and for whom frequent upgrades are too risky. -The `resource_usage_export_config` block supports: +The `resource_usage_export_config` block supports: * `enable_network_egress_metering` (Optional) - Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. @@ -855,7 +857,7 @@ resource_usage_export_config { } ``` -The `shielded_instance_config` block supports: +The `shielded_instance_config` block supports: * `enable_secure_boot` (Optional) - Defines if the instance has Secure Boot enabled. @@ -865,7 +867,7 @@ Secure Boot helps ensure that the system only runs authentic software by verifyi Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Defaults to `true`. -The `taint` block supports: +The `taint` block supports: * `key` (Required) Key for taint. @@ -873,7 +875,7 @@ The `taint` block supports: * `effect` (Required) Effect for taint. Accepted values are `NO_SCHEDULE`, `PREFER_NO_SCHEDULE`, and `NO_EXECUTE`. -The `workload_metadata_config` must have exactly one of `node_metadata` (deprecated) or `mode` set. This block supports: +The `workload_metadata_config` must have exactly one of `node_metadata` (deprecated) or `mode` set. This block supports: * `node_metadata` (Optional, Deprecated) How to expose the node metadata to the workload running on the node. This is deprecated in favor of `mode` Accepted values are: @@ -888,7 +890,7 @@ The `workload_metadata_config` must have exactly one of `node_metadata` (depreca * GCE_METADATA: Expose all Compute Engine metadata to pods. * GKE_METADATA: Run the GKE Metadata Server on this node. The GKE Metadata Server exposes a metadata API to workloads that is compatible with the V1 Compute Metadata APIs exposed by the Compute Engine and App Engine Metadata Servers. This feature can only be enabled if [workload identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity) is enabled at the cluster level. -The `kubelet_config` block supports: +The `kubelet_config` block supports: * `cpu_manager_policy` - (Required) The CPU management policy on the node. See [K8S CPU Management Policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/). @@ -907,17 +909,17 @@ value and accepts an invalid `default` value instead. While this remains true, not specifying the `kubelet_config` block should be the equivalent of specifying `none`. -The `linux_node_config` block supports: +The `linux_node_config` block supports: * `sysctls` - (Required) The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. Specified as a map from the key, such as `net.core.wmem_max`, to a string value. -The `vertical_pod_autoscaling` block supports: +The `vertical_pod_autoscaling` block supports: * `enabled` (Required) - Enables vertical pod autoscaling -The `dns_config` block supports: +The `dns_config` block supports: * `cluster_dns` - (Optional) Which in-cluster DNS provider should be used. `PROVIDER_UNSPECIFIED` (default) or `PLATFORM_DEFAULT` or `CLOUD_DNS`. diff --git a/website/docs/r/container_node_pool.html.markdown b/website/docs/r/container_node_pool.html.markdown index cb9823bd2c2..5d757ba3c50 100644 --- a/website/docs/r/container_node_pool.html.markdown +++ b/website/docs/r/container_node_pool.html.markdown @@ -112,7 +112,7 @@ resource "google_container_cluster" "primary" { - - - * `autoscaling` - (Optional) Configuration required by cluster autoscaler to adjust - the size of the node pool to the current cluster usage. Structure is documented below. + the size of the node pool to the current cluster usage. Structure is [documented below](#nested_autoscaling). * `initial_node_count` - (Optional) The initial number of nodes for the pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Changing @@ -123,7 +123,7 @@ resource "google_container_cluster" "primary" { ignore subsequent changes to this field](https://github.com/hashicorp/terraform-provider-google/issues/6901#issuecomment-667369691). * `management` - (Optional) Node management configuration, wherein auto-repair and - auto-upgrade is configured. Structure is documented below. + auto-upgrade is configured. Structure is [documented below](#nested_management). * `max_pods_per_node` - (Optional) The maximum number of pods per node in this node pool. Note that this does not work on node pools which are "route-based" - that is, node @@ -161,7 +161,7 @@ cluster. * `upgrade_settings` (Optional) Specify node upgrade settings to change how many nodes GKE attempts to upgrade at once. The number of nodes upgraded simultaneously is the sum of `max_surge` and `max_unavailable`. - The maximum number of nodes upgraded simultaneously is limited to 20. + The maximum number of nodes upgraded simultaneously is limited to 20. Structure is [documented below](#nested_upgrade_settings). * `version` - (Optional) The Kubernetes version for the nodes in this pool. Note that if this field and `auto_upgrade` are both specified, they will fight each other for what the node version should @@ -170,20 +170,20 @@ cluster. when fuzzy versions are used. See the `google_container_engine_versions` data source's `version_prefix` field to approximate fuzzy versions in a Terraform-compatible way. -The `autoscaling` block supports: +The `autoscaling` block supports: * `min_node_count` - (Required) Minimum number of nodes in the NodePool. Must be >=0 and <= `max_node_count`. * `max_node_count` - (Required) Maximum number of nodes in the NodePool. Must be >= min_node_count. -The `management` block supports: +The `management` block supports: * `auto_repair` - (Optional) Whether the nodes will be automatically repaired. * `auto_upgrade` - (Optional) Whether the nodes will be automatically upgraded. -The `upgrade_settings` block supports: +The `upgrade_settings` block supports: * `max_surge` - (Required) The number of additional nodes that can be added to the node pool during an upgrade. Increasing `max_surge` raises the number of nodes that can be upgraded simultaneously. diff --git a/website/docs/r/dataproc_cluster.html.markdown b/website/docs/r/dataproc_cluster.html.markdown index b414f21d068..da7d6f95add 100644 --- a/website/docs/r/dataproc_cluster.html.markdown +++ b/website/docs/r/dataproc_cluster.html.markdown @@ -137,7 +137,7 @@ resource "google_dataproc_cluster" "accelerated_cluster" { which is the name of the cluster. * `cluster_config` - (Optional) Allows you to configure various aspects of the cluster. - Structure defined below. + Structure [defined below](#nested_cluster_config). * `graceful_decommission_timeout` - (Optional) Allows graceful decomissioning when you change the number of worker nodes directly through a terraform apply. Does not affect auto scaling decomissioning from an autoscaling policy. @@ -149,7 +149,7 @@ resource "google_dataproc_cluster" "accelerated_cluster" { For more context see the [docs](https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.clusters/patch#query-parameters) - - - -The `cluster_config` block supports: +The `cluster_config` block supports: ```hcl cluster_config { @@ -180,47 +180,47 @@ The `cluster_config` block supports: Note: If you don't explicitly specify a `temp_bucket` then GCP will auto create / assign one for you. * `gce_cluster_config` (Optional) Common config settings for resources of Google Compute Engine cluster - instances, applicable to all instances in the cluster. Structure defined below. + instances, applicable to all instances in the cluster. Structure [defined below](#nested_gce_cluster_config). * `master_config` (Optional) The Google Compute Engine config settings for the master instances - in a cluster.. Structure defined below. + in a cluster. Structure [defined below](#nested_master_config). * `worker_config` (Optional) The Google Compute Engine config settings for the worker instances - in a cluster.. Structure defined below. + in a cluster. Structure [defined below](#nested_worker_config). * `preemptible_worker_config` (Optional) The Google Compute Engine config settings for the additional - instances in a cluster. Structure defined below. + instances in a cluster. Structure [defined below](#nested_preemptible_worker_config). * **NOTE** : `preemptible_worker_config` is an alias for the api's [secondaryWorkerConfig](https://cloud.google.com/dataproc/docs/reference/rest/v1/ClusterConfig#InstanceGroupConfig). The name doesn't necessarily mean it is preemptible and is named as such for legacy/compatibility reasons. * `software_config` (Optional) The config settings for software inside the cluster. - Structure defined below. + Structure [defined below](#nested_software_config). -* `security_config` (Optional) Security related configuration. Structure defined below. +* `security_config` (Optional) Security related configuration. Structure [defined below](#nested_security_config). * `autoscaling_config` (Optional) The autoscaling policy config associated with the cluster. Note that once set, if `autoscaling_config` is the only field set in `cluster_config`, it can only be removed by setting `policy_uri = ""`, rather than removing the whole block. - Structure defined below. + Structure [defined below](#nested_autoscaling_config). * `initialization_action` (Optional) Commands to execute on each node after config is completed. - You can specify multiple versions of these. Structure defined below. + You can specify multiple versions of these. Structure [defined below](#nested_initialization_action). * `encryption_config` (Optional) The Customer managed encryption keys settings for the cluster. - Structure defined below. + Structure [defined below](#nested_encryption_config). * `lifecycle_config` (Optional, Beta) The settings for auto deletion cluster schedule. - Structure defined below. + Structure [defined below](#nested_lifecycle_config). * `endpoint_config` (Optional, Beta) The config settings for port access on the cluster. - Structure defined below. + Structure [defined below](#nested_endpoint_config). * `metastore_config` (Optional, Beta) The config setting for metastore service with the cluster. - Structure defined below. + Structure [defined below](#nested_metastore_config). - - - -The `cluster_config.gce_cluster_config` block supports: +The `cluster_config.gce_cluster_config` block supports: ```hcl cluster_config { @@ -299,7 +299,7 @@ cluster_config{ - - - -The `cluster_config.master_config` block supports: +The `cluster_config.master_config` block supports: ```hcl cluster_config { @@ -358,7 +358,7 @@ if you are trying to use accelerators in a given zone. - - - -The `cluster_config.worker_config` block supports: +The `cluster_config.worker_config` block supports: ```hcl cluster_config { @@ -421,7 +421,7 @@ if you are trying to use accelerators in a given zone. - - - -The `cluster_config.preemptible_worker_config` block supports: +The `cluster_config.preemptible_worker_config` block supports: ```hcl cluster_config { @@ -458,7 +458,7 @@ will be set for you based on whatever was set for the `worker_config.machine_typ - - - -The `cluster_config.software_config` block supports: +The `cluster_config.software_config` block supports: ```hcl cluster_config { @@ -501,7 +501,7 @@ cluster_config { - - - -The `cluster_config.security_config` block supports: +The `cluster_config.security_config` block supports: ```hcl cluster_config { @@ -565,7 +565,7 @@ cluster_config { - - - -The `cluster_config.autoscaling_config` block supports: +The `cluster_config.autoscaling_config` block supports: ```hcl cluster_config { @@ -586,7 +586,7 @@ Note that the policy must be in the same project and Cloud Dataproc region. - - - -The `initialization_action` block (Optional) can be specified multiple times and supports: +The `initialization_action` block (Optional) can be specified multiple times and supports: ```hcl cluster_config { @@ -607,7 +607,7 @@ cluster_config { - - - -The `encryption_config` block supports: +The `encryption_config` block supports: ```hcl cluster_config { @@ -622,7 +622,7 @@ cluster_config { - - - -The `lifecycle_config` block supports: +The `lifecycle_config` block supports: ```hcl cluster_config { @@ -642,7 +642,7 @@ cluster_config { - - - -The `endpoint_config` block (Optional, Computed, Beta) supports: +The `endpoint_config` block (Optional, Computed, Beta) supports: ```hcl cluster_config { @@ -656,7 +656,7 @@ cluster_config { on the cluster from external sources (aka Component Gateway). Defaults to false. -The `metastore_config` block (Optional, Computed, Beta) supports: +The `metastore_config` block (Optional, Computed, Beta) supports: ```hcl cluster_config { diff --git a/website/docs/r/dataproc_job.html.markdown b/website/docs/r/dataproc_job.html.markdown index 3dcab85e00d..1c7ef3dbed7 100644 --- a/website/docs/r/dataproc_job.html.markdown +++ b/website/docs/r/dataproc_job.html.markdown @@ -84,12 +84,12 @@ output "pyspark_status" { as shown in the example above, or by setting the `count` attribute. The following job configs are supported: - * pyspark_config - Submits a PySpark job to the cluster - * spark_config - Submits a Spark job to the cluster - * hadoop_config - Submits a Hadoop job to the cluster - * hive_config - Submits a Hive job to the cluster - * hpig_config - Submits a Pig job to the cluster - * sparksql_config - Submits a Spark SQL job to the cluster + * [pyspark_config](#nested_pyspark_config) - Submits a PySpark job to the cluster + * [spark_config](#nested_spark_config) - Submits a Spark job to the cluster + * [hadoop_config](#nested_hadoop_config) - Submits a Hadoop job to the cluster + * [hive_config](#nested_hive_config) - Submits a Hive job to the cluster + * [hpig_config](#nested_hpig_config) - Submits a Pig job to the cluster + * [sparksql_config](#nested_sparksql_config) - Submits a Spark SQL job to the cluster - - - @@ -109,7 +109,7 @@ output "pyspark_status" { * `scheduling.max_failures_total` - (Required) Maximum number of times in total a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. -The `pyspark_config` block supports: +The `pyspark_config` block supports: Submitting a pyspark job to the cluster. Below is an example configuration: @@ -149,7 +149,7 @@ are generally applicable: * `logging_config.driver_log_levels`- (Required) The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' -The `spark_config` block supports: +The `spark_config` block supports: ```hcl # Submit a spark job to the cluster @@ -192,7 +192,7 @@ resource "google_dataproc_job" "spark" { * `logging_config.driver_log_levels`- (Required) The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' -The `hadoop_config` block supports: +The `hadoop_config` block supports: ```hcl # Submit a hadoop job to the cluster @@ -225,7 +225,7 @@ resource "google_dataproc_job" "hadoop" { * `logging_config.driver_log_levels`- (Required) The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' -The `hive_config` block supports: +The `hive_config` block supports: ```hcl # Submit a hive job to the cluster @@ -255,7 +255,7 @@ resource "google_dataproc_job" "hive" { * `jar_file_uris` - (Optional) HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. -The `pig_config` block supports: +The `pig_config` block supports: ```hcl # Submit a pig job to the cluster @@ -290,7 +290,7 @@ resource "google_dataproc_job" "pig" { * `logging_config.driver_log_levels`- (Required) The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' -The `sparksql_config` block supports: +The `sparksql_config` block supports: ```hcl # Submit a spark SQL job to the cluster diff --git a/website/docs/r/gke_hub_feature_membership.html.markdown b/website/docs/r/gke_hub_feature_membership.html.markdown index efa31f93ae1..4d1829f0f2f 100644 --- a/website/docs/r/gke_hub_feature_membership.html.markdown +++ b/website/docs/r/gke_hub_feature_membership.html.markdown @@ -82,7 +82,7 @@ The following arguments are supported: * `configmanagement` - (Optional) - Config Management-specific spec. + Config Management-specific spec. Structure is [documented below](#nested_configmanagement). * `feature` - (Optional) @@ -102,45 +102,45 @@ The following arguments are supported: -The `configmanagement` block supports: +The `configmanagement` block supports: * `binauthz` - (Optional) - Binauthz configuration for the cluster. + Binauthz configuration for the cluster. Structure is [documented below](#nested_binauthz). * `config_sync` - (Optional) - Config Sync configuration for the cluster. + Config Sync configuration for the cluster. Structure is [documented below](#nested_config_sync). * `hierarchy_controller` - (Optional) - Hierarchy Controller configuration for the cluster. + Hierarchy Controller configuration for the cluster. Structure is [documented below](#nested_hierarchy_controller). * `policy_controller` - (Optional) - Policy Controller configuration for the cluster. + Policy Controller configuration for the cluster. Structure is [documented below](#nested_policy_controller). * `version` - (Optional) Version of ACM installed. -The `binauthz` block supports: +The `binauthz` block supports: * `enabled` - (Optional) Whether binauthz is enabled in this cluster. -The `config_sync` block supports: +The `config_sync` block supports: * `git` - - (Optional) + (Optional) Structure is [documented below](#nested_git). * `source_format` - (Optional) Specifies whether the Config Sync Repo is in "hierarchical" or "unstructured" mode. -The `git` block supports: +The `git` block supports: * `https_proxy` - (Optional) @@ -170,7 +170,7 @@ The `git` block supports: (Optional) Period in seconds between consecutive syncs. Default: 15. -The `hierarchy_controller` block supports: +The `hierarchy_controller` block supports: * `enable_hierarchical_resource_quota` - (Optional) @@ -184,7 +184,7 @@ The `hierarchy_controller` block supports: (Optional) Whether Hierarchy Controller is enabled in this cluster. -The `policy_controller` block supports: +The `policy_controller` block supports: * `audit_interval_seconds` - (Optional) diff --git a/website/docs/r/google_folder_iam.html.markdown b/website/docs/r/google_folder_iam.html.markdown index 780f90bee59..85c07c18fc6 100644 --- a/website/docs/r/google_folder_iam.html.markdown +++ b/website/docs/r/google_folder_iam.html.markdown @@ -180,20 +180,20 @@ The following arguments are supported: * `service` - (Required only by google\_folder\_iam\_audit\_config) Service which will be enabled for audit logging. The special value `allServices` covers all services. Note that if there are google\_folder\_iam\_audit\_config resources covering both `allServices` and a specific service then the union of the two AuditConfigs is used for that service: the `log_types` specified in each `audit_log_config` are enabled, and the `exempted_members` in each `audit_log_config` are exempted. -* `audit_log_config` - (Required only by google\_folder\_iam\_audit\_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is documented below. +* `audit_log_config` - (Required only by google\_folder\_iam\_audit\_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is [documented below](#nested_audit_log_config). * `condition` - (Optional) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. - Structure is documented below. + Structure is [documented below](#nested_condition). --- -The `audit_log_config` block supports: +The `audit_log_config` block supports: * `log_type` - (Required) Permission type for which logging is to be configured. Must be one of `DATA_READ`, `DATA_WRITE`, or `ADMIN_READ`. * `exempted_members` - (Optional) Identities that do not cause logging for this type of permission. The format is the same as that for `members`. -The `condition` block supports: +The `condition` block supports: * `expression` - (Required) Textual representation of an expression in Common Expression Language syntax. @@ -240,4 +240,4 @@ terraform import google_folder_iam_audit_config.my_folder "folder foo.googleapis ``` -> **Custom Roles**: If you're importing a IAM resource with a custom role, make sure to use the - full name of the custom role, e.g. `organizations/{{org_id}}/roles/{{role_id}}`. \ No newline at end of file + full name of the custom role, e.g. `organizations/{{org_id}}/roles/{{role_id}}`. diff --git a/website/docs/r/google_folder_organization_policy.html.markdown b/website/docs/r/google_folder_organization_policy.html.markdown index 3fe7159b680..e65771b57ce 100644 --- a/website/docs/r/google_folder_organization_policy.html.markdown +++ b/website/docs/r/google_folder_organization_policy.html.markdown @@ -93,23 +93,23 @@ The following arguments are supported: * `version` - (Optional) Version of the Policy. Default version is 0. -* `boolean_policy` - (Optional) A boolean policy is a constraint that is either enforced or not. Structure is documented below. +* `boolean_policy` - (Optional) A boolean policy is a constraint that is either enforced or not. Structure is [documented below](#nested_boolean_policy). * `list_policy` - (Optional) A policy that can define specific values that are allowed or denied for the given constraint. It -can also be used to allow or deny all values. Structure is documented below. +can also be used to allow or deny all values. Structure is [documented below](#nested_list_policy). -* `restore_policy` - (Optional) A restore policy is a constraint to restore the default policy. Structure is documented below. +* `restore_policy` - (Optional) A restore policy is a constraint to restore the default policy. Structure is [documented below](#nested_restore_policy). ~> **Note:** If none of [`boolean_policy`, `list_policy`, `restore_policy`] are defined the policy for a given constraint will effectively be unset. This is represented in the UI as the constraint being 'Inherited'. - - - -The `boolean_policy` block supports: +The `boolean_policy` block supports: * `enforced` - (Required) If true, then the Policy is enforced. If false, then any configuration is acceptable. -The `list_policy` block supports: +The `list_policy` block supports: * `allow` or `deny` - (Optional) One or the other must be set. @@ -124,7 +124,7 @@ The `allow` or `deny` blocks support: * `values` - (Optional) The policy can define specific values that are allowed or denied. -The `restore_policy` block supports: +The `restore_policy` block supports: * `default` - (Required) May only be set to true. If set, then the default Policy is restored. diff --git a/website/docs/r/google_kms_crypto_key_iam.html.markdown b/website/docs/r/google_kms_crypto_key_iam.html.markdown index d802bdaf7fe..7c366b35aa0 100644 --- a/website/docs/r/google_kms_crypto_key_iam.html.markdown +++ b/website/docs/r/google_kms_crypto_key_iam.html.markdown @@ -154,11 +154,11 @@ The following arguments are supported: a `google_iam_policy` data source. * `condition` - (Optional, [Beta](https://terraform.io/docs/providers/google/provider_versions.html)) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. - Structure is documented below. + Structure is [documented below](#nested_condition). --- -The `condition` block supports: +The `condition` block supports: * `expression` - (Required) Textual representation of an expression in Common Expression Language syntax. diff --git a/website/docs/r/google_kms_key_ring_iam.html.markdown b/website/docs/r/google_kms_key_ring_iam.html.markdown index f8c521ba4ff..e04a4043868 100644 --- a/website/docs/r/google_kms_key_ring_iam.html.markdown +++ b/website/docs/r/google_kms_key_ring_iam.html.markdown @@ -157,11 +157,11 @@ The following arguments are supported: a `google_iam_policy` data source. * `condition` - (Optional, [Beta](https://terraform.io/docs/providers/google/provider_versions.html)) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. - Structure is documented below. + Structure is [documented below](#nested_condition). --- -The `condition` block supports: +The `condition` block supports: * `expression` - (Required) Textual representation of an expression in Common Expression Language syntax. diff --git a/website/docs/r/google_organization_iam.html.markdown b/website/docs/r/google_organization_iam.html.markdown index d82640ec0ff..bb45ed1dbe8 100644 --- a/website/docs/r/google_organization_iam.html.markdown +++ b/website/docs/r/google_organization_iam.html.markdown @@ -185,20 +185,20 @@ will not be inferred from the provider. * `service` - (Required only by google\_organization\_iam\_audit\_config) Service which will be enabled for audit logging. The special value `allServices` covers all services. Note that if there are google\_organization\_iam\_audit\_config resources covering both `allServices` and a specific service then the union of the two AuditConfigs is used for that service: the `log_types` specified in each `audit_log_config` are enabled, and the `exempted_members` in each `audit_log_config` are exempted. -* `audit_log_config` - (Required only by google\_organization\_iam\_audit\_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is documented below. +* `audit_log_config` - (Required only by google\_organization\_iam\_audit\_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is [documented below](#nested_audit_log_config). * `condition` - (Optional) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. - Structure is documented below. + Structure is [documented below](#nested_condition). --- -The `audit_log_config` block supports: +The `audit_log_config` block supports: * `log_type` - (Required) Permission type for which logging is to be configured. Must be one of `DATA_READ`, `DATA_WRITE`, or `ADMIN_READ`. * `exempted_members` - (Optional) Identities that do not cause logging for this type of permission. The format is the same as that for `members`. -The `condition` block supports: +The `condition` block supports: * `expression` - (Required) Textual representation of an expression in Common Expression Language syntax. @@ -245,4 +245,4 @@ terraform import google_organization_iam_audit_config.my_organization "your-orga ``` -> **Custom Roles**: If you're importing a IAM resource with a custom role, make sure to use the - full name of the custom role, e.g. `organizations/{{org_id}}/roles/{{role_id}}`. \ No newline at end of file + full name of the custom role, e.g. `organizations/{{org_id}}/roles/{{role_id}}`. diff --git a/website/docs/r/google_organization_policy.html.markdown b/website/docs/r/google_organization_policy.html.markdown index 8abf14c5705..f7e8df24aea 100644 --- a/website/docs/r/google_organization_policy.html.markdown +++ b/website/docs/r/google_organization_policy.html.markdown @@ -92,22 +92,23 @@ The following arguments are supported: * `version` - (Optional) Version of the Policy. Default version is 0. -* `boolean_policy` - (Optional) A boolean policy is a constraint that is either enforced or not. Structure is documented below. +* `boolean_policy` - (Optional) A boolean policy is a constraint that is either enforced or not. Structure is [documented +below](#nested_boolean_policy). -* `list_policy` - (Optional) A policy that can define specific values that are allowed or denied for the given constraint. It can also be used to allow or deny all values. Structure is documented below. +* `list_policy` - (Optional) A policy that can define specific values that are allowed or denied for the given constraint. It can also be used to allow or deny all values. Structure is [documented below](#nested_list_policy). -* `restore_policy` - (Optional) A restore policy is a constraint to restore the default policy. Structure is documented below. +* `restore_policy` - (Optional) A restore policy is a constraint to restore the default policy. Structure is [documented below](#nested_restore_policy). ~> **Note:** If none of [`boolean_policy`, `list_policy`, `restore_policy`] are defined the policy for a given constraint will effectively be unset. This is represented in the UI as the constraint being 'Inherited'. - - - -The `boolean_policy` block supports: +The `boolean_policy` block supports: * `enforced` - (Required) If true, then the Policy is enforced. If false, then any configuration is acceptable. -The `list_policy` block supports: +The `list_policy` block supports: * `allow` or `deny` - (Optional) One or the other must be set. @@ -122,7 +123,7 @@ The `allow` or `deny` blocks support: * `values` - (Optional) The policy can define specific values that are allowed or denied. -The `restore_policy` block supports: +The `restore_policy` block supports: * `default` - (Required) May only be set to true. If set, then the default Policy is restored. diff --git a/website/docs/r/google_project_iam.html.markdown b/website/docs/r/google_project_iam.html.markdown index 8f32e0a17d8..41231e8f372 100644 --- a/website/docs/r/google_project_iam.html.markdown +++ b/website/docs/r/google_project_iam.html.markdown @@ -181,20 +181,20 @@ will not be inferred from the provider. * `service` - (Required only by google\_project\_iam\_audit\_config) Service which will be enabled for audit logging. The special value `allServices` covers all services. Note that if there are google\_project\_iam\_audit\_config resources covering both `allServices` and a specific service then the union of the two AuditConfigs is used for that service: the `log_types` specified in each `audit_log_config` are enabled, and the `exempted_members` in each `audit_log_config` are exempted. -* `audit_log_config` - (Required only by google\_project\_iam\_audit\_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is documented below. +* `audit_log_config` - (Required only by google\_project\_iam\_audit\_config) The configuration for logging of each type of permission. This can be specified multiple times. Structure is [documented below](#nested_audit_log_config). * `condition` - (Optional) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. - Structure is documented below. + Structure is [documented below](#nested_condition). --- -The `audit_log_config` block supports: +The `audit_log_config` block supports: * `log_type` - (Required) Permission type for which logging is to be configured. Must be one of `DATA_READ`, `DATA_WRITE`, or `ADMIN_READ`. * `exempted_members` - (Optional) Identities that do not cause logging for this type of permission. The format is the same as that for `members`. -The `condition` block supports: +The `condition` block supports: * `expression` - (Required) Textual representation of an expression in Common Expression Language syntax. diff --git a/website/docs/r/google_project_organization_policy.html.markdown b/website/docs/r/google_project_organization_policy.html.markdown index 854fd05954f..417d78fac2e 100644 --- a/website/docs/r/google_project_organization_policy.html.markdown +++ b/website/docs/r/google_project_organization_policy.html.markdown @@ -93,22 +93,22 @@ The following arguments are supported: * `version` - (Optional) Version of the Policy. Default version is 0. -* `boolean_policy` - (Optional) A boolean policy is a constraint that is either enforced or not. Structure is documented below. +* `boolean_policy` - (Optional) A boolean policy is a constraint that is either enforced or not. Structure is [documented below](#nested_boolean_policy). -* `list_policy` - (Optional) A policy that can define specific values that are allowed or denied for the given constraint. It can also be used to allow or deny all values. Structure is documented below. +* `list_policy` - (Optional) A policy that can define specific values that are allowed or denied for the given constraint. It can also be used to allow or deny all values. Structure is [documented below](#nested_list_policy). -* `restore_policy` - (Optional) A restore policy is a constraint to restore the default policy. Structure is documented below. +* `restore_policy` - (Optional) A restore policy is a constraint to restore the default policy. Structure is [documented below](#nested_restore_policy). ~> **Note:** If none of [`boolean_policy`, `list_policy`, `restore_policy`] are defined the policy for a given constraint will effectively be unset. This is represented in the UI as the constraint being 'Inherited'. - - - -The `boolean_policy` block supports: +The `boolean_policy` block supports: * `enforced` - (Required) If true, then the Policy is enforced. If false, then any configuration is acceptable. -The `list_policy` block supports: +The `list_policy` block supports: * `allow` or `deny` - (Optional) One or the other must be set. @@ -123,7 +123,7 @@ The `allow` or `deny` blocks support: * `values` - (Optional) The policy can define specific values that are allowed or denied. -The `restore_policy` block supports: +The `restore_policy` block supports: * `default` - (Required) May only be set to true. If set, then the default Policy is restored. diff --git a/website/docs/r/google_service_account_iam.html.markdown b/website/docs/r/google_service_account_iam.html.markdown index 9f2cd0787f3..284e7d87d33 100644 --- a/website/docs/r/google_service_account_iam.html.markdown +++ b/website/docs/r/google_service_account_iam.html.markdown @@ -156,9 +156,9 @@ The following arguments are supported: a `google_iam_policy` data source. * `condition` - (Optional) An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. - Structure is documented below. + Structure is [documented below](#nested_condition). -The `condition` block supports: +The `condition` block supports: * `expression` - (Required) Textual representation of an expression in Common Expression Language syntax. diff --git a/website/docs/r/logging_billing_account_sink.html.markdown b/website/docs/r/logging_billing_account_sink.html.markdown index ab4f7bee205..be32db4afa7 100644 --- a/website/docs/r/logging_billing_account_sink.html.markdown +++ b/website/docs/r/logging_billing_account_sink.html.markdown @@ -69,18 +69,18 @@ The following arguments are supported: * `disabled` - (Optional) If set to True, then this sink is disabled and it does not export any log entries. -* `bigquery_options` - (Optional) Options that affect sinks exporting data to BigQuery. Structure documented below. +* `bigquery_options` - (Optional) Options that affect sinks exporting data to BigQuery. Structure [documented below](#nested_bigquery_options). -* `exclusions` - (Optional) Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is documented below. +* `exclusions` - (Optional) Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is [documented below](#nested_exclusions). -The `bigquery_options` block supports: +The `bigquery_options` block supports: * `use_partitioned_tables` - (Required) Whether to use [BigQuery's partition tables](https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and [special query syntax](https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone. -The `exclusions` block support: +The `exclusions` block supports: * `name` - (Required) A client-assigned identifier, such as `load-balancer-exclusion`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. * `description` - (Optional) A description of this exclusion. diff --git a/website/docs/r/logging_folder_sink.html.markdown b/website/docs/r/logging_folder_sink.html.markdown index 625b2a205df..75e9b6fa7d7 100644 --- a/website/docs/r/logging_folder_sink.html.markdown +++ b/website/docs/r/logging_folder_sink.html.markdown @@ -78,18 +78,18 @@ The following arguments are supported: * `include_children` - (Optional) Whether or not to include children folders in the sink export. If true, logs associated with child projects are also exported; otherwise only logs relating to the provided folder are included. -* `bigquery_options` - (Optional) Options that affect sinks exporting data to BigQuery. Structure documented below. +* `bigquery_options` - (Optional) Options that affect sinks exporting data to BigQuery. Structure [documented below](#nested_bigquery_options). -* `exclusions` - (Optional) Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is documented below. +* `exclusions` - (Optional) Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is [documented below](#nested_exclusions). -The `bigquery_options` block supports: +The `bigquery_options` block supports: * `use_partitioned_tables` - (Required) Whether to use [BigQuery's partition tables](https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and [special query syntax](https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone. -The `exclusions` block support: +The `exclusions` block supports: * `name` - (Required) A client-assigned identifier, such as `load-balancer-exclusion`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. * `description` - (Optional) A description of this exclusion. diff --git a/website/docs/r/logging_organization_sink.html.markdown b/website/docs/r/logging_organization_sink.html.markdown index 2726019fa08..4d260c9cd47 100644 --- a/website/docs/r/logging_organization_sink.html.markdown +++ b/website/docs/r/logging_organization_sink.html.markdown @@ -69,18 +69,18 @@ The following arguments are supported: * `include_children` - (Optional) Whether or not to include children organizations in the sink export. If true, logs associated with child projects are also exported; otherwise only logs relating to the provided organization are included. -* `bigquery_options` - (Optional) Options that affect sinks exporting data to BigQuery. Structure documented below. +* `bigquery_options` - (Optional) Options that affect sinks exporting data to BigQuery. Structure [documented below](#nested_bigquery_options). -* `exclusions` - (Optional) Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is documented below. +* `exclusions` - (Optional) Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is [documented below](#nested_exclusions). -The `bigquery_options` block supports: +The `bigquery_options` block supports: * `use_partitioned_tables` - (Required) Whether to use [BigQuery's partition tables](https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and [special query syntax](https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone. -The `exclusions` block support: +The `exclusions` block supports: * `name` - (Required) A client-assigned identifier, such as `load-balancer-exclusion`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. * `description` - (Optional) A description of this exclusion. diff --git a/website/docs/r/logging_project_sink.html.markdown b/website/docs/r/logging_project_sink.html.markdown index 292629b6d33..0a169c2c2ad 100644 --- a/website/docs/r/logging_project_sink.html.markdown +++ b/website/docs/r/logging_project_sink.html.markdown @@ -145,18 +145,18 @@ The following arguments are supported: then a unique service account is created and used for this sink. If you wish to publish logs across projects or utilize `bigquery_options`, you must set `unique_writer_identity` to true. -* `bigquery_options` - (Optional) Options that affect sinks exporting data to BigQuery. Structure documented below. +* `bigquery_options` - (Optional) Options that affect sinks exporting data to BigQuery. Structure [documented below](#nested_bigquery_options). -* `exclusions` - (Optional) Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is documented below. +* `exclusions` - (Optional) Log entries that match any of the exclusion filters will not be exported. If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Can be repeated multiple times for multiple exclusions. Structure is [documented below](#nested_exclusions). -The `bigquery_options` block supports: +The `bigquery_options` block supports: * `use_partitioned_tables` - (Required) Whether to use [BigQuery's partition tables](https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and [special query syntax](https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone. -The `exclusions` block support: +The `exclusions` block supports: * `name` - (Required) A client-assigned identifier, such as `load-balancer-exclusion`. Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. * `description` - (Optional) A description of this exclusion. diff --git a/website/docs/r/storage_bucket.html.markdown b/website/docs/r/storage_bucket.html.markdown index d199b6d766c..4fc2a59d7f5 100644 --- a/website/docs/r/storage_bucket.html.markdown +++ b/website/docs/r/storage_bucket.html.markdown @@ -81,21 +81,21 @@ The following arguments are supported: * `storage_class` - (Optional, Default: 'STANDARD') The [Storage Class](https://cloud.google.com/storage/docs/storage-classes) of the new bucket. Supported values include: `STANDARD`, `MULTI_REGIONAL`, `REGIONAL`, `NEARLINE`, `COLDLINE`, `ARCHIVE`. -* `lifecycle_rule` - (Optional) The bucket's [Lifecycle Rules](https://cloud.google.com/storage/docs/lifecycle#configuration) configuration. Multiple blocks of this type are permitted. Structure is documented below. +* `lifecycle_rule` - (Optional) The bucket's [Lifecycle Rules](https://cloud.google.com/storage/docs/lifecycle#configuration) configuration. Multiple blocks of this type are permitted. Structure is [documented below](#nested_lifecycle_rule). -* `versioning` - (Optional) The bucket's [Versioning](https://cloud.google.com/storage/docs/object-versioning) configuration. +* `versioning` - (Optional) The bucket's [Versioning](https://cloud.google.com/storage/docs/object-versioning) configuration. Structure is [documented below](#nested_versioning). -* `website` - (Optional) Configuration if the bucket acts as a website. Structure is documented below. +* `website` - (Optional) Configuration if the bucket acts as a website. Structure is [documented below](#nested_website). -* `cors` - (Optional) The bucket's [Cross-Origin Resource Sharing (CORS)](https://www.w3.org/TR/cors/) configuration. Multiple blocks of this type are permitted. Structure is documented below. +* `cors` - (Optional) The bucket's [Cross-Origin Resource Sharing (CORS)](https://www.w3.org/TR/cors/) configuration. Multiple blocks of this type are permitted. Structure is [documented below](#nested_cors). -* `retention_policy` - (Optional) Configuration of the bucket's data retention policy for how long objects in the bucket should be retained. Structure is documented below. +* `retention_policy` - (Optional) Configuration of the bucket's data retention policy for how long objects in the bucket should be retained. Structure is [documented below](#nested_retention_policy). * `labels` - (Optional) A map of key/value label pairs to assign to the bucket. -* `logging` - (Optional) The bucket's [Access & Storage Logs](https://cloud.google.com/storage/docs/access-logs) configuration. +* `logging` - (Optional) The bucket's [Access & Storage Logs](https://cloud.google.com/storage/docs/access-logs) configuration. Structure is [documented below](#nested_logging). -* `encryption` - (Optional) The bucket's encryption configuration. +* `encryption` - (Optional) The bucket's encryption configuration. Structure is [documented below](#nested_encryption). * `requester_pays` - (Optional, Default: false) Enables [Requester Pays](https://cloud.google.com/storage/docs/requester-pays) on a storage bucket. @@ -103,19 +103,19 @@ The following arguments are supported: * `uniform_bucket_level_access` - (Optional, Default: false) Enables [Uniform bucket-level access](https://cloud.google.com/storage/docs/uniform-bucket-level-access) access to a bucket. -The `lifecycle_rule` block supports: +The `lifecycle_rule` block supports: -* `action` - (Required) The Lifecycle Rule's action configuration. A single block of this type is supported. Structure is documented below. +* `action` - (Required) The Lifecycle Rule's action configuration. A single block of this type is supported. Structure is [documented below](#nested_action). -* `condition` - (Required) The Lifecycle Rule's condition configuration. A single block of this type is supported. Structure is documented below. +* `condition` - (Required) The Lifecycle Rule's condition configuration. A single block of this type is supported. Structure is [documented below](#nested_condition). -The `action` block supports: +The `action` block supports: * `type` - The type of the action of this Lifecycle Rule. Supported values include: `Delete` and `SetStorageClass`. * `storage_class` - (Required if action type is `SetStorageClass`) The target [Storage Class](https://cloud.google.com/storage/docs/storage-classes) of objects affected by this Lifecycle Rule. Supported values include: `STANDARD`, `MULTI_REGIONAL`, `REGIONAL`, `NEARLINE`, `COLDLINE`, `ARCHIVE`. -The `condition` block supports the following elements, and requires at least one to be defined. If you specify multiple conditions in a rule, an object has to match all of the conditions for the action to be taken: +The `condition` block supports the following elements, and requires at least one to be defined. If you specify multiple conditions in a rule, an object has to match all of the conditions for the action to be taken: * `age` - (Optional) Minimum age of an object in days to satisfy this condition. @@ -135,11 +135,11 @@ The `condition` block supports the following elements, and requires at least one * `noncurrent_time_before` - (Optional) Relevant only for versioned objects. The date in RFC 3339 (e.g. `2017-06-13`) when the object became nonconcurrent. -The `versioning` block supports: +The `versioning` block supports: * `enabled` - (Required) While set to `true`, versioning is fully enabled for this bucket. -The `website` block supports the following elements, and requires at least one to be defined: +The `website` block supports the following elements, and requires at least one to be defined: * `main_page_suffix` - (Optional) Behaves as the bucket's directory index where missing objects are treated as potential directories. @@ -147,7 +147,7 @@ The `website` block supports the following elements, and requires at least one t * `not_found_page` - (Optional) The custom object to return when a requested resource is not found. -The `cors` block supports: +The `cors` block supports: * `origin` - (Optional) The list of [Origins](https://tools.ietf.org/html/rfc6454) eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". @@ -157,20 +157,20 @@ The `cors` block supports: * `max_age_seconds` - (Optional) The value, in seconds, to return in the [Access-Control-Max-Age header](https://www.w3.org/TR/cors/#access-control-max-age-response-header) used in preflight responses. -The `retention_policy` block supports: +The `retention_policy` block supports: * `is_locked` - (Optional) If set to `true`, the bucket will be [locked](https://cloud.google.com/storage/docs/using-bucket-lock#lock-bucket) and permanently restrict edits to the bucket's retention policy. Caution: Locking a bucket is an irreversible action. * `retention_period` - (Required) The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, overwritten, or archived. The value must be less than 2,147,483,647 seconds. -The `logging` block supports: +The `logging` block supports: * `log_bucket` - (Required) The bucket that will receive log objects. * `log_object_prefix` - (Optional, Computed) The object prefix for log objects. If it's not provided, by default GCS sets this to this bucket's name. -The `encryption` block supports: +The `encryption` block supports: * `default_kms_key_name`: The `id` of a Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified. You must pay attention to whether the crypto key is available in the location that this bucket is created in. diff --git a/website/docs/r/storage_bucket_object.html.markdown b/website/docs/r/storage_bucket_object.html.markdown index d14956183c9..60bb36948d1 100644 --- a/website/docs/r/storage_bucket_object.html.markdown +++ b/website/docs/r/storage_bucket_object.html.markdown @@ -59,7 +59,7 @@ One of the following is required: * `content_type` - (Optional) [Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5) of the object data. Defaults to "application/octet-stream" or "text/plain; charset=utf-8". -* `customer_encryption` - (Optional) Enables object encryption with Customer-Supplied Encryption Key (CSEK). [Google documentation about CSEK.](https://cloud.google.com/storage/docs/encryption/customer-supplied-keys) +* `customer_encryption` - (Optional) Enables object encryption with Customer-Supplied Encryption Key (CSEK). [Google [documentation about](#nested_customer_encryption) CSEK.](https://cloud.google.com/storage/docs/encryption/customer-supplied-keys) Structure is documented below. * `storage_class` - (Optional) The [StorageClass](https://cloud.google.com/storage/docs/storage-classes) of the new bucket object. @@ -70,7 +70,7 @@ One of the following is required: --- -The `customer_encryption` block supports: +The `customer_encryption` block supports: * `encryption_algorithm` - (Optional) Encryption algorithm. Default: AES256 diff --git a/website/docs/r/storage_transfer_job.html.markdown b/website/docs/r/storage_transfer_job.html.markdown index 445f85da4f1..f0b347ad6e2 100644 --- a/website/docs/r/storage_transfer_job.html.markdown +++ b/website/docs/r/storage_transfer_job.html.markdown @@ -96,9 +96,9 @@ The following arguments are supported: * `description` - (Required) Unique description to identify the Transfer Job. -* `transfer_spec` - (Required) Transfer specification. Structure documented below. +* `transfer_spec` - (Required) Transfer specification. Structure [documented below](#nested_transfer_spec). -* `schedule` - (Required) Schedule specification defining when the Transfer Job should be scheduled to start, end and what time to run. Structure documented below. +* `schedule` - (Required) Schedule specification defining when the Transfer Job should be scheduled to start, end and what time to run. Structure [documented below](#nested_schedule). - - - @@ -107,31 +107,31 @@ The following arguments are supported: * `status` - (Optional) Status of the job. Default: `ENABLED`. **NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.** -The `transfer_spec` block supports: +The `transfer_spec` block supports: -* `gcs_data_sink` - (Required) A Google Cloud Storage data sink. Structure documented below. +* `gcs_data_sink` - (Required) A Google Cloud Storage data sink. Structure [documented below](#nested_gcs_data_sink). -* `object_conditions` - (Optional) Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `last_modification_time` do not exclude objects in a data sink. Structure documented below. +* `object_conditions` - (Optional) Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `last_modification_time` do not exclude objects in a data sink. Structure [documented below](#nested_object_conditions). -* `transfer_options` - (Optional) Characteristics of how to treat files from datasource and sink during job. If the option `delete_objects_unique_in_sink` is true, object conditions based on objects' `last_modification_time` are ignored and do not exclude objects in a data source or a data sink. Structure documented below. +* `transfer_options` - (Optional) Characteristics of how to treat files from datasource and sink during job. If the option `delete_objects_unique_in_sink` is true, object conditions based on objects' `last_modification_time` are ignored and do not exclude objects in a data source or a data sink. Structure [documented below](#nested_transfer_options). -* `gcs_data_source` - (Optional) A Google Cloud Storage data source. Structure documented below. +* `gcs_data_source` - (Optional) A Google Cloud Storage data source. Structure [documented below](#nested_gcs_data_source). -* `aws_s3_data_source` - (Optional) An AWS S3 data source. Structure documented below. +* `aws_s3_data_source` - (Optional) An AWS S3 data source. Structure [documented below](#nested_aws_s3_data_source). -* `http_data_source` - (Optional) A HTTP URL data source. Structure documented below. +* `http_data_source` - (Optional) A HTTP URL data source. Structure [documented below](#nested_http_data_source). -* `azure_blob_storage_data_source` - (Optional) An Azure Blob Storage data source. Structure documented below. +* `azure_blob_storage_data_source` - (Optional) An Azure Blob Storage data source. Structure [documented below](#nested_azure_blob_storage_data_source). -The `schedule` block supports: +The `schedule` block supports: -* `schedule_start_date` - (Required) The first day the recurring transfer is scheduled to run. If `schedule_start_date` is in the past, the transfer will run for the first time on the following day. Structure documented below. +* `schedule_start_date` - (Required) The first day the recurring transfer is scheduled to run. If `schedule_start_date` is in the past, the transfer will run for the first time on the following day. Structure [documented below](#nested_schedule_start_end_date). -* `schedule_end_date` - (Optional) The last day the recurring transfer will be run. If `schedule_end_date` is the same as `schedule_start_date`, the transfer will be executed only once. Structure documented below. +* `schedule_end_date` - (Optional) The last day the recurring transfer will be run. If `schedule_end_date` is the same as `schedule_start_date`, the transfer will be executed only once. Structure [documented below](#nested_schedule_start_end_date). -* `start_time_of_day` - (Optional) The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer's start time in a day is specified in your local timezone. Structure documented below. +* `start_time_of_day` - (Optional) The time in UTC at which the transfer will be scheduled to start in a day. Transfers may start later than this time. If not specified, recurring and one-time transfers that are scheduled to run today will run immediately; recurring transfers that are scheduled to run on a future date will start at approximately midnight UTC on that date. Note that when configuring a transfer with the Cloud Platform Console, the transfer's start time in a day is specified in your local timezone. Structure [documented below](#nested_start_time_of_day). -The `object_conditions` block supports: +The `object_conditions` block supports: * `max_time_elapsed_since_last_modification` - (Optional) A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". @@ -142,7 +142,7 @@ A duration in seconds with up to nine fractional digits, terminated by 's'. Exam * `exclude_prefixes` - (Optional) `exclude_prefixes` must follow the requirements described for `include_prefixes`. See [Requirements](https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#ObjectConditions). -The `transfer_options` block supports: +The `transfer_options` block supports: * `overwrite_objects_already_existing_in_sink` - (Optional) Whether overwriting objects that already exist in the sink is allowed. @@ -151,19 +151,19 @@ The `transfer_options` block supports: * `delete_objects_from_source_after_transfer` - (Optional) Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and `delete_objects_unique_in_sink` are mutually exclusive. -The `gcs_data_sink` block supports: +The `gcs_data_sink` block supports: * `bucket_name` - (Required) Google Cloud Storage bucket name. * `path` - (Optional) Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. -The `gcs_data_source` block supports: +The `gcs_data_source` block supports: * `bucket_name` - (Required) Google Cloud Storage bucket name. * `path` - (Optional) Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'. -The `aws_s3_data_source` block supports: +The `aws_s3_data_source` block supports: * `bucket_name` - (Required) S3 Bucket name. @@ -175,11 +175,11 @@ The `aws_access_key` block supports: * `secret_access_key` - (Required) AWS Secret Access Key. -The `http_data_source` block supports: +The `http_data_source` block supports: * `list_url` - (Required) The URL that points to the file that stores the object list entries. This file must allow public access. Currently, only URLs with HTTP and HTTPS schemes are supported. -The `azure_blob_storage_data_source` block supports: +The `azure_blob_storage_data_source` block supports: * `storage_account` - (Required) The name of the Azure Storage account. @@ -193,7 +193,7 @@ The `azure_credentials` block supports: * `sas_token` - (Required) Azure shared access signature. See [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview). -The `schedule_start_date` and `schedule_end_date` blocks support: +The `schedule_start_date` and `schedule_end_date` blocks support: * `year` - (Required) Year of date. Must be from 1 to 9999. @@ -201,7 +201,7 @@ The `schedule_start_date` and `schedule_end_date` blocks support: * `day` - (Required) Day of month. Must be from 1 to 31 and valid for the year and month. -The `start_time_of_day` blocks support: +The `start_time_of_day` blocks support: * `hours` - (Required) Hours of day in 24 hour format. Should be from 0 to 23