Document Beta Features in index.html (#280)

* First pass of Beta docs.

* Updated new docs to link as well.

* Updated new Beta resources with Beta link.
This commit is contained in:
Riley Karson 2017-08-10 13:28:52 -07:00 committed by GitHub
parent ff8bdc9b52
commit 7625ad3375
7 changed files with 42 additions and 47 deletions

View File

@ -95,3 +95,13 @@ the process more straightforwarded, it is documented here:
dropdown, and select "JSON" as the key type. dropdown, and select "JSON" as the key type.
4. Clicking "Create" will download your `credentials`. 4. Clicking "Create" will download your `credentials`.
## Beta Features
Some Google Provider resources contain Beta features; 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 a GCP feature
is publicly announced, and is when they generally become publicly available.
Resources will automatically be provisioned using Beta APIs when you specify a feature
marked Beta in your Terraform config file.

View File

@ -61,14 +61,14 @@ The following arguments are supported:
- - - - - -
* `deny` - (Optional, Beta) Can be specified multiple times for each deny * `deny` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) Can be specified multiple times for each deny
rule. Each deny block supports fields documented below. Can be specified rule. Each deny block supports fields documented below. Can be specified
instead of allow. instead of allow.
* `direction` - (Optional, Beta) Direction of traffic to which this firewall applies; * `direction` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) Direction of traffic to which this firewall applies;
One of `INGRESS` or `EGRESS`. Defaults to `INGRESS`. One of `INGRESS` or `EGRESS`. Defaults to `INGRESS`.
* `destination_ranges` - (Optional, Beta) A list of destination CIDR ranges that this * `destination_ranges` - (Optional, [Beta](/docs/providers/google/index.html#beta-features)) A list of destination CIDR ranges that this
firewall applies to. Can't be used for `INGRESS`. firewall applies to. Can't be used for `INGRESS`.
The `allow` block supports: The `allow` block supports:

View File

@ -35,8 +35,8 @@ is not provided, the provider project is used.
- - - - - -
* `ip_version` - (Optional, Beta) The IP Version that will be used by this address. * `ip_version` - (Optional, [Beta](/docs/providers/google/index.html#beta-features))
One of `"IPV4"` or `"IPV6"`. The IP Version that will be used by this address. One of `"IPV4"` or `"IPV6"`.
## Attributes Reference ## Attributes Reference

View File

@ -98,8 +98,8 @@ The following arguments are supported:
- - - - - -
* `ip_version` - (Optional, Beta) The IP Version that will be used by this address. * `ip_version` - (Optional, [Beta](/docs/providers/google/index.html#beta-features))
One of `"IPV4"` or `"IPV6"`. The IP Version that will be used by this resource's address. One of `"IPV4"` or `"IPV6"`.
## Attributes Reference ## Attributes Reference

View File

@ -83,7 +83,7 @@ The following arguments are supported:
--- ---
* `auto_healing_policies` - (Optional, Beta) 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. group. You can specify only one value. Structure is documented below.
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).

View File

@ -8,7 +8,10 @@ description: |-
# google\_sql\_database # google\_sql\_database
Creates a new Google SQL Database on a Google SQL Database Instance. For more information, see the [official documentation](https://cloud.google.com/sql/), or the [JSON API](https://cloud.google.com/sql/docs/admin-api/v1beta4/databases). Creates a new Google SQL Database on a Google SQL Database Instance. For more information, see
the [official documentation](https://cloud.google.com/sql/),
or the [JSON API](https://cloud.google.com/sql/docs/admin-api/v1beta4/databases).
Postgres support for `google_sql_database` is in [Beta](/docs/providers/google/index.html#beta-features).
## Example Usage ## Example Usage
@ -44,23 +47,17 @@ The following arguments are supported:
* `project` - (Optional) The project in which the resource belongs. If it * `project` - (Optional) 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.
* `charset` - (Optional) The charset value. See MySQL's [Supported Character * `charset` - (Optional) The charset value. See MySQL's
Sets and [Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)
Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) and Postgres' [Character Set Support](https://www.postgresql.org/docs/9.6/static/multibyte.html)
and PostgreSQL's [Character Set for more details and supported values. Postgres databases are in [Beta](/docs/providers/google/index.html#beta-features),
Support](https://www.postgresql.org/docs/9.6/static/multibyte.html) and have limited `charset` support; they only support a value of `UTF8` at creation time.
for more details and supported values. Note that Cloud SQL's beta
offering for PostgreSQL databases currently only supports the charset value
`UTF8`.
* `collation` - (Optional) The collation value. See MySQL's [Supported Character * `collation` - (Optional) The collation value. See MySQL's
Sets and [Supported Character Sets and Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html)
Collations](https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html) and Postgres' [Collation Support](https://www.postgresql.org/docs/9.6/static/collation.html)
and PostgreSQL's [Collation for more details and supported values. Postgres databases are in [Beta](/docs/providers/google/index.html#beta-features),
Support](https://www.postgresql.org/docs/9.6/static/collation.html) for and have limited `collation` support; they only support a value of `en_US.UTF8` at creation time.
more details and supported values. Note that Cloud SQL's beta
offering for PostgreSQL databases currently only supports the collation
value `en_US.UTF8`.
## Attributes Reference ## Attributes Reference

View File

@ -8,19 +8,15 @@ description: |-
# google\_sql\_database\_instance # google\_sql\_database\_instance
Creates a new Google SQL Database Instance. For more information, see the [official documentation](https://cloud.google.com/sql/), or the [JSON API](https://cloud.google.com/sql/docs/admin-api/v1beta4/instances). Creates a new Google SQL Database Instance. For more information, see the [official documentation](https://cloud.google.com/sql/),
or the [JSON API](https://cloud.google.com/sql/docs/admin-api/v1beta4/instances). Postgres support
for `google_sql_database_instance` is in [Beta](/docs/providers/google/index.html#beta-features).
~> **NOTE on `google_sql_database_instance`:** - Second-generation instances include a ~> **NOTE on `google_sql_database_instance`:** - Second-generation instances include a
default 'root'@'%' user with no password. This user will be deleted by Terraform on default 'root'@'%' user with no password. This user will be deleted by Terraform on
instance creation. You should use a `google_sql_user` to define a customer user with instance creation. You should use `google_sql_user` to define a custom user with
a restricted host and strong password. a restricted host and strong password.
~> **NOTE on Postgres support:** Configuring Postgres instances is reported to work well with this
Terraform resource however the corresponding Google-API is currently still in BETA which means it
can change in backwards-incompatible ways at any point in time which might also affect the way this
Terraform resource works when configuring Postgres instances.
## Example Usage ## Example Usage
Example creating a SQL Database. Example creating a SQL Database.
@ -51,9 +47,8 @@ The following arguments are supported:
* `database_version` - (Optional, Default: `MYSQL_5_6`) The MySQL version to * `database_version` - (Optional, Default: `MYSQL_5_6`) The MySQL version to
use. Can be `MYSQL_5_6`, `MYSQL_5_7` or `POSTGRES_9_6` for second-generation use. Can be `MYSQL_5_6`, `MYSQL_5_7` or `POSTGRES_9_6` for second-generation
instances, or `MYSQL_5_5` or `MYSQL_5_6` for first-generation instances. instances, or `MYSQL_5_5` or `MYSQL_5_6` for first-generation instances.
See Google's [Second Generation Capabilities](https://cloud.google.com/sql/docs/1st-2nd-gen-differences) See [Second Generation Capabilities](https://cloud.google.com/sql/docs/1st-2nd-gen-differences)
for more information. for more information. `POSTGRES_9_6` support is in [Beta](/docs/providers/google/index.html#beta-features).
Note that Google's Postgres support is currently still in BETA.
* `name` - (Optional, Computed) The name of the instance. If the name is left * `name` - (Optional, Computed) The name of the instance. If the name is left
blank, Terraform will randomly generate one when the instance is first blank, Terraform will randomly generate one when the instance is first
@ -74,17 +69,10 @@ The required `settings` block supports:
* `tier` - (Required) The machine tier (First Generation) or type (Second Generation) to use. See * `tier` - (Required) The machine tier (First Generation) or type (Second Generation) to use. See
[tiers](https://cloud.google.com/sql/docs/admin-api/v1beta4/tiers) for more details and [tiers](https://cloud.google.com/sql/docs/admin-api/v1beta4/tiers) for more details and
supported versions. supported versions. Postgres supports only shared-core machine types such as `db-f1-micro`, and custom
Postgres only supports shared-core machine types (i.e. `db-f1-micro`, `db-g1-small`) and custom machine types such as `db-custom-2-13312`. See the
machine types (see Google's [Postgres Pricing [Custom Machine Type Documentation](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create)
Page](https://cloud.google.com/sql/docs/postgres/pricing)). to learn about specifying custom machine types.
For custom machine types the number of CPUs and the amount of memory (expressed in `MiB = GB *
1024`) is encoded in the tier as: `db-custom-{CPUS}-{MEMORY}`. For a machine with 1 CPU and
4GB of memory the tier would be `db-custom-1-4096`, for 2 CPUs and 13GB of ram it would be
`db-custom-2-13312`.
Only certain combinations of CPU and memory are allowed, see Google's [Custom Machine Type
Documentation](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create).
Note that Google's Postgres support is currently still in BETA.
* `activation_policy` - (Optional) This specifies when the instance should be * `activation_policy` - (Optional) This specifies when the instance should be
active. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`. active. Can be either `ALWAYS`, `NEVER` or `ON_DEMAND`.