From 9c8bea96d805bf0dc5d63a895d53009f417ce4bc Mon Sep 17 00:00:00 2001 From: The Magician Date: Fri, 1 Feb 2019 13:26:59 -0800 Subject: [PATCH] Refresh provider docs in anticipation of 2.0.0 (#2981) /cc @rileykarson --- website/docs/getting_started.html.markdown | 2 ++ website/docs/index.html.markdown | 4 +-- website/docs/provider_reference.html.markdown | 6 ++--- website/docs/provider_versions.html.markdown | 27 ++++++++++++------- .../docs/r/container_cluster.html.markdown | 9 +++++-- .../docs/r/container_node_pool.html.markdown | 15 +++++++++++ 6 files changed, 45 insertions(+), 18 deletions(-) diff --git a/website/docs/getting_started.html.markdown b/website/docs/getting_started.html.markdown index 953784d6..fea66ac4 100644 --- a/website/docs/getting_started.html.markdown +++ b/website/docs/getting_started.html.markdown @@ -227,5 +227,7 @@ You can also check out the [GCP Community tutorials](https://cloud.google.com/co such as: * [Getting started with Terraform on Google Cloud Platform](https://cloud.google.com/community/tutorials/getting-started-on-gcp-with-terraform) + * [Managing GCP Projects with Terraform](https://cloud.google.com/community/tutorials/managing-gcp-projects-with-terraform) + * [Modular Load Balancing with Terraform](https://cloud.google.com/community/tutorials/modular-load-balancing-with-terraform) diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown index b87e20eb..ae989a07 100644 --- a/website/docs/index.html.markdown +++ b/website/docs/index.html.markdown @@ -8,9 +8,7 @@ description: |- # Google Cloud Platform Provider --> We recently introduced the `google-beta` provider. See [Provider Versions](https://terraform.io/docs/providers/google/provider_versions.html) -for more details on how to use `google-beta`. The documentation in this site is shared between both `google` and `google-beta`; fields or -resources only present in `google-beta` will be marked as such. +-> Want more information about upgrading from `1.X` of the provider to `2.0.0`? Check out the [2.0.0 Upgrade Guide](https://terraform.io/docs/providers/google/version_2_upgrade.html). The Google provider is used to configure your [Google Cloud Platform](https://cloud.google.com/) infrastructure. See the [Getting Started](/docs/providers/google/getting_started.html) page for an introduction to using the provider. diff --git a/website/docs/provider_reference.html.markdown b/website/docs/provider_reference.html.markdown index 07b8b870..b155232e 100644 --- a/website/docs/provider_reference.html.markdown +++ b/website/docs/provider_reference.html.markdown @@ -8,9 +8,7 @@ description: |- # `google` provider reference --> We recently introduced the `google-beta` provider. See [Provider Versions](https://terraform.io/docs/providers/google/provider_versions.html) -for more details on how to use `google-beta`. The documentation in this site is shared between both `google` and `google-beta`; fields or -resources only present in `google-beta` will be marked as such. +-> Want more information about upgrading from `1.X` of the provider to `2.0.0`? Check out the [2.0.0 Upgrade Guide](https://terraform.io/docs/providers/google/version_2_upgrade.html). The `google` and `google-beta` provider blocks are used to configure default values for your GCP project and location (`zone` and `region`), and add your credentials. @@ -58,6 +56,8 @@ resource "google_compute_instance" "beta-instance" { # ... } + +provider "google-beta" {} ``` diff --git a/website/docs/provider_versions.html.markdown b/website/docs/provider_versions.html.markdown index 21bce8f6..0ced84e9 100644 --- a/website/docs/provider_versions.html.markdown +++ b/website/docs/provider_versions.html.markdown @@ -11,27 +11,34 @@ description: |- Starting with version `1.19.0`, there are two versions of the Google provider: * `google` + * `google-beta` This documentation (https://www.terraform.io/docs/providers/google/) is shared -between both providers. Fields and resources that are only present in -`google-beta` will be marked as such. +between both providers, and all generally available (GA) products and features +are available in both versions of the provider. -All GA (generally available) products and features are available in both -versions of the provider, and from the `2.0.0` release onwards beta GCP features -are only available in the `google-beta` provider. +The `google-beta` provider is distinct from the `google` provider in that it +supports GCP products and features that are in beta, while `google` does not. +Fields and resources that are only present in `google-beta` will be marked as +such in the shared provider documentation. + +`1.X` versions of the `google` provider supported beta features; from `2.0.0` +onwards, beta features are only supported in `google-beta`. Beta GCP features have no deprecation policy and no SLA, but are otherwise considered to be feature-complete with only minor outstanding issues after their Alpha period. Beta is when GCP features are publicly announced, and is when they generally become publicly available. For more information see [the official documentation on GCP launch stages](https://cloud.google.com/terms/launch-stages). -The beta provider sends all requests to the beta endpoint for GCP if one exists -for that product, regardless of whether the request contains any beta features. +The `google-beta` provider sends all requests to the beta endpoint for GCP if +one exists for that product, regardless of whether the request contains any beta +features. --> Using `google-beta` over `google` is similar to using `gcloud beta` over `gcloud`. -Features that are exclusively available in `google-beta` are GCP features that -are not yet GA, and they will be made available in `google` after their GA launch. +-> In short, using `google-beta` over `google` is similar to using `gcloud beta` +over `gcloud`. Features that are exclusively available in `google-beta` are GCP +features that are not yet GA, and they will be made available in `google` after +their GA launch. ## Using the `google-beta` provider diff --git a/website/docs/r/container_cluster.html.markdown b/website/docs/r/container_cluster.html.markdown index 08c77cb0..d1c380d0 100644 --- a/website/docs/r/container_cluster.html.markdown +++ b/website/docs/r/container_cluster.html.markdown @@ -113,6 +113,11 @@ resource "google_container_cluster" "primary" { tags = ["foo", "bar"] } + + timeouts { + create = "30m" + update = "40m" + } } # The following outputs allow authentication and connectivity to the GKE Cluster @@ -559,8 +564,8 @@ exported: [Timeouts](/docs/configuration/resources.html#timeouts) configuration options: - `create` - (Default `30 minutes`) Used for clusters -- `update` - (Default `10 minutes`) Used for updates to clusters -- `delete` - (Default `10 minutes`) Used for destroying clusters. +- `update` - (Default `30 minutes`) Used for updates to clusters +- `delete` - (Default `30 minutes`) Used for destroying clusters. ## Import diff --git a/website/docs/r/container_node_pool.html.markdown b/website/docs/r/container_node_pool.html.markdown index 3b50b485..3694f72d 100644 --- a/website/docs/r/container_node_pool.html.markdown +++ b/website/docs/r/container_node_pool.html.markdown @@ -54,6 +54,11 @@ resource "google_container_node_pool" "np" { zone = "us-central1-a" cluster = "${google_container_cluster.primary.name}" node_count = 3 + + timeouts { + create = "30m" + update = "20m" + } } resource "google_container_cluster" "primary" { @@ -144,6 +149,16 @@ The `management` block supports: * `auto_upgrade` - (Optional) Whether the nodes will be automatically upgraded. + +## Timeouts + +`google_container_node_pool` provides the following +[Timeouts](/docs/configuration/resources.html#timeouts) configuration options: + +- `create` - (Default `30 minutes`) Used for adding node pools +- `update` - (Default `10 minutes`) Used for updates to node pools +- `delete` - (Default `10 minutes`) Used for removing node pools. + ## Import Node pools can be imported using the `project`, `zone`, `cluster` and `name`. If