Add notes to docs about deprecated beta fields. (#2171)

* Add notes to docs about deprecated beta fields.

* Remove comma
This commit is contained in:
Riley Karson 2018-10-04 13:20:35 -07:00 committed by GitHub
parent d5308e5119
commit 742b6933a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 40 additions and 7 deletions

View File

@ -33,11 +33,12 @@ resource "google_container_cluster" "foo" {
The following arguments are supported: The following arguments are supported:
* `zone` (optional) - Zone to list available cluster versions for. Should match the zone the cluster will be deployed in. * `zone` (optional) - Zone to list available cluster versions for. Should match the zone the cluster will be deployed in.
If not specified, the provider-level zone is used. One of zone, region, or provider-level zone is required. If not specified, the provider-level zone is used. One of zone or provider-level zone is required.
* `region` (optional) - Region to list available cluster versions for. Should match the region the cluster will be deployed in. * `region` (optional) - Region to list available cluster versions for. Should match the region the cluster will be deployed in.
For regional clusters, this value must be specified and cannot be inferred from provider-level region. One of zone, For regional clusters, this value must be specified and cannot be inferred from provider-level region. One of zone,
region, or provider-level zone is required. region, or provider-level zone is required. This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `project` (optional) - ID of the project to list available cluster versions for. Should match the project the cluster will be deployed to. * `project` (optional) - ID of the project to list available cluster versions for. Should match the project the cluster will be deployed to.
Defaults to the project that the provider is authenticated with. Defaults to the project that the provider is authenticated with.

View File

@ -86,6 +86,8 @@ but still work to finish started ones). Defaults to `300`.
* `custom_request_headers` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) Headers that the * `custom_request_headers` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) Headers that the
HTTP/S load balancer should add to proxied requests. See [guide](https://cloud.google.com/compute/docs/load-balancing/http/backend-service#user-defined-request-headers) for details. HTTP/S load balancer should add to proxied requests. See [guide](https://cloud.google.com/compute/docs/load-balancing/http/backend-service#user-defined-request-headers) for details.
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `description` - (Optional) The textual description for the backend service. * `description` - (Optional) The textual description for the backend service.

View File

@ -106,7 +106,8 @@ The IP Version that will be used by this resource's address. One of `"IPV4"` or
- - - - - -
* `labels` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) * `labels` - (Optional, [Beta](/docs/providers/google/index.html#beta-features))
A set of key/value label pairs to assign to the resource. A set of key/value label pairs to assign to the resource. This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
## Attributes Reference ## Attributes Reference

View File

@ -98,6 +98,8 @@ The following arguments are supported:
exactly one version must not specify a target size. It means that versions with exactly one version must not specify a target size. It means that versions with
a target size will respect the setting, and the one without target size will a target size will respect the setting, and the one without target size will
be applied to all remaining Instances (top level target_size - each version target_size). be applied to all remaining Instances (top level target_size - each version target_size).
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `name` - (Required) The name of the instance group manager. Must be 1-63 * `name` - (Required) The name of the instance group manager. Must be 1-63
characters long and comply with characters long and comply with
@ -140,8 +142,12 @@ The following arguments are supported:
* `auto_healing_policies` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) The autohealing policies for this managed instance * `auto_healing_policies` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) 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. For more information, see the [official documentation](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances#monitoring_groups).
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `rolling_update_policy` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) 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/instanceGroupManagers/patch) * `rolling_update_policy` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) 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/instanceGroupManagers/patch)
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
- - - - - -
The **rolling_update_policy** block supports: The **rolling_update_policy** block supports:

View File

@ -8,6 +8,9 @@ description: |-
# IAM policy for GCE subnetwork # IAM policy for GCE subnetwork
~> **Warning:** These resources are in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta resources.
Three different resources help you manage your IAM policy for GCE subnetwork. Each of these resources serves a different use case: Three different resources help you manage your IAM policy for GCE subnetwork. Each of these resources serves a different use case:
* `google_compute_subnetwork_iam_policy`: Authoritative. Sets the IAM policy for the subnetwork and replaces any existing policy already attached. * `google_compute_subnetwork_iam_policy`: Authoritative. Sets the IAM policy for the subnetwork and replaces any existing policy already attached.

View File

@ -80,6 +80,8 @@ output "cluster_ca_certificate" {
[Regional Clusters](https://cloud.google.com/kubernetes-engine/docs/concepts/multi-zone-and-regional-clusters#regional). [Regional Clusters](https://cloud.google.com/kubernetes-engine/docs/concepts/multi-zone-and-regional-clusters#regional).
In a Regional Cluster, the number of nodes specified in `initial_node_count` is In a Regional Cluster, the number of nodes specified in `initial_node_count` is
created in three zones of the region (this can be changed by setting `additional_zones`). created in three zones of the region (this can be changed by setting `additional_zones`).
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `additional_zones` - (Optional) The list of additional Google Compute Engine * `additional_zones` - (Optional) The list of additional Google Compute Engine
locations in which the cluster's nodes should be located. If additional zones are locations in which the cluster's nodes should be located. If additional zones are
@ -96,6 +98,8 @@ output "cluster_ca_certificate" {
* `enable_binary_authorization` - (Optional) Enable Binary Authorization for this cluster. * `enable_binary_authorization` - (Optional) Enable Binary Authorization for this cluster.
If enabled, all container images will be validated by Google Binary Authorization. If enabled, all container images will be validated by Google Binary Authorization.
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `enable_kubernetes_alpha` - (Optional) Whether to enable Kubernetes Alpha features for * `enable_kubernetes_alpha` - (Optional) Whether to enable Kubernetes Alpha features for
this cluster. Note that when this option is enabled, the cluster cannot be upgraded this cluster. Note that when this option is enabled, the cluster cannot be upgraded
@ -103,6 +107,8 @@ output "cluster_ca_certificate" {
* `enable_tpu` - (Optional) Whether to enable Cloud TPU resources in this cluster. * `enable_tpu` - (Optional) Whether to enable Cloud TPU resources in this cluster.
See the [official documentation](https://cloud.google.com/tpu/docs/kubernetes-engine-setup). See the [official documentation](https://cloud.google.com/tpu/docs/kubernetes-engine-setup).
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `enable_legacy_abac` - (Optional) Whether the ABAC authorizer is enabled for this cluster. * `enable_legacy_abac` - (Optional) Whether the ABAC authorizer is enabled for this cluster.
When enabled, identities in the system, including service accounts, nodes, and controllers, When enabled, identities in the system, including service accounts, nodes, and controllers,
@ -133,6 +139,8 @@ output "cluster_ca_certificate" {
* `master_ipv4_cidr_block` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) Specifies a private * `master_ipv4_cidr_block` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) Specifies a private
[RFC1918](https://tools.ietf.org/html/rfc1918) block for the master's VPC. The master range must not overlap with any subnet in your cluster's VPC. [RFC1918](https://tools.ietf.org/html/rfc1918) block for the master's VPC. The master range must not overlap with any subnet in your cluster's VPC.
The master and your cluster use VPC peering. Must be specified in CIDR notation and must be `/28` subnet. The master and your cluster use VPC peering. Must be specified in CIDR notation and must be `/28` subnet.
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `min_master_version` - (Optional) The minimum version of the master. GKE * `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 will auto-update the master to new versions, so this does not guarantee the
@ -169,11 +177,15 @@ output "cluster_ca_certificate" {
* `pod_security_policy_config` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) Configuration for the * `pod_security_policy_config` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) Configuration for the
[PodSecurityPolicy](https://cloud.google.com/kubernetes-engine/docs/how-to/pod-security-policies) feature. [PodSecurityPolicy](https://cloud.google.com/kubernetes-engine/docs/how-to/pod-security-policies) feature.
Structure is documented below. Structure is documented below.
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `private_cluster` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) If true, a * `private_cluster` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) If true, a
[private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters) will be created, meaning [private cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters) will be created, meaning
nodes do not get public IP addresses. It is mandatory to specify `master_ipv4_cidr_block` and nodes do not get public IP addresses. It is mandatory to specify `master_ipv4_cidr_block` and
`ip_allocation_policy` with this option. `ip_allocation_policy` with this option.
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `project` - (Optional) The ID of the project in which the resource belongs. If it * `project` - (Optional) The ID of the project in which the resource belongs. If it
is not provided, the provider project is used. is not provided, the provider project is used.
@ -355,10 +367,13 @@ The `node_config` block supports:
* `taint` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) List of * `taint` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) List of
[kubernetes taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/) [kubernetes taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)
to apply to each node. Structure is documented below. to apply to each node. Structure is documented below. This property is in beta, and should be
used with the terraform-provider-google-beta provider. See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html)
for more details on beta fields.
* `workload_metadata_config` - (Optional) Metadata configuration to expose to workloads on the node pool. * `workload_metadata_config` - (Optional) Metadata configuration to expose to workloads on the node pool.
Structure is documented below. Structure is documented below. This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
The `guest_accelerator` block supports: The `guest_accelerator` block supports:
@ -426,8 +441,9 @@ exported:
## Import ## Import
GKE clusters can be imported using the `project` , `zone` or `region`, and `name`. If GKE clusters can be imported using the `project` , `zone` or `region` (`region`
the project is omitted, the default provider value will be used. Examples: is deprecated, see above), and `name`. If the project is omitted, the default
provider value will be used. Examples:
``` ```
$ terraform import google_container_cluster.mycluster my-gcp-project/us-east1-a/my-cluster $ terraform import google_container_cluster.mycluster my-gcp-project/us-east1-a/my-cluster

View File

@ -113,6 +113,8 @@ resource "google_container_node_pool" "regional-np" {
* `zone` - (Optional) The zone in which the cluster resides. * `zone` - (Optional) The zone in which the cluster resides.
* `region` - (Optional) The region in which the cluster resides (for regional clusters). * `region` - (Optional) The region in which the cluster resides (for regional clusters).
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `cluster` - (Required) The cluster to create the node pool for. Cluster must be present in `zone` provided for zonal clusters. * `cluster` - (Required) The cluster to create the node pool for. Cluster must be present in `zone` provided for zonal clusters.
@ -132,6 +134,8 @@ Note: You must be provide region for regional clusters and zone for zonal cluste
* `max_pods_per_node` - (Optional) The maximum number of pods per node in this node pool. * `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 Note that this does not work on node pools which are "route-based" - that is, node
pools belonging to clusters that do not have IP Aliasing enabled. pools belonging to clusters that do not have IP Aliasing enabled.
This property is in beta, and should be used with the terraform-provider-google-beta provider.
See [Provider Versions](https://terraform.io/docs/provider/google/provider_versions.html) for more details on beta fields.
* `name` - (Optional) The name of the node pool. If left blank, Terraform will * `name` - (Optional) The name of the node pool. If left blank, Terraform will
auto-generate a unique name. auto-generate a unique name.