Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Several updates on documentation #3534

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/5103.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:none
Several updates on documentation and examples
```
2 changes: 1 addition & 1 deletion website/docs/d/compute_health_check.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Get information about a HealthCheck.
## Example Usage

```tf
data "google_compute_health_check" "health_chceck" {
data "google_compute_health_check" "health_check" {
name = "my-hc"
}
```
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/compute_instance_template.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The following arguments are supported:
---

* `project` - (Optional) The ID of the project in which the resource belongs.
If `project` is not provideded, the provider project is used.
If `project` is not provided, the provider project is used.

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/runtimeconfig_variable.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ layout: "google"
page_title: "Google: google_runtimeconfig_variable"
sidebar_current: "docs-google-datasource-runtimeconfig-variable"
description: |-
Get information about a Google Cloud RuntimeConfig varialbe.
Get information about a Google Cloud RuntimeConfig variable.
---

# google\_runtimeconfig\_variable
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/iam_deleted_members.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ After this intermediate phase, attempting to grant permissions to a principal th

## Using `*_iam_policy` resources

`_iam_policy` allows you to declare the entire IAM policy from within Terraform. Users may see diffs on `deleted:` members in some cirtumstances, but applying the policy should succeed and resolve any issues. Specifying `deleted:` members is not allowed in Terraform, so any policy entirely managed by Terraform should automatically remove any deleted members when Terraform is run.
`_iam_policy` allows you to declare the entire IAM policy from within Terraform. Users may see diffs on `deleted:` members in some circumstances, but applying the policy should succeed and resolve any issues. Specifying `deleted:` members is not allowed in Terraform, so any policy entirely managed by Terraform should automatically remove any deleted members when Terraform is run.

During the intermediate period it may be required to `taint` the `_iam_policy` resource to ensure any deleted principals are removed *before* the new principal is granted permission. This should only be necessary if you are continuing to see diffs after successful applies. For more information on using `taint` see the [official documentation](https://www.terraform.io/docs/commands/taint.html).

Expand Down
4 changes: 2 additions & 2 deletions website/docs/guides/version_2_upgrade.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ to either `terraform import` them or delete them by hand.
- [Data Sources](#data-sources)
- [Resource: `google_bigquery_dataset`](#resource-google_bigquery_dataset)
- [Resource: `google_bigtable_instance`](#resource-google_bigtable_instance)
- [Resource: `google_binary_authorizaton_attestor`](#resource-google_binary_authorization_attestor)
- [Resource: `google_binary_authorizaton_policy`](#resource-google_binary_authorization_policy)
- [Resource: `google_binary_authorization_attestor`](#resource-google_binary_authorization_attestor)
- [Resource: `google_binary_authorization_policy`](#resource-google_binary_authorization_policy)
- [Resource: `google_cloudbuild_trigger`](#resource-google_cloudbuild_trigger)
- [Resource: `google_cloudfunctions_function`](#resource-google_cloudfunctions_function)
- [Resource: `google_compute_backend_service`](#resource-google_compute_backend_service)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/version_3_upgrade.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ Previously documentation suggested Terraform could use the same range of valid
IP Address formats for `ip_address` as accepted by the API (e.g. named addresses
or URLs to GCP Address resources). However, the server returns only literal IP
addresses and thus caused diffs on re-apply (i.e. a permadiff). We amended
documenation to say Terraform only accepts literal IP addresses.
documentation to say Terraform only accepts literal IP addresses.

This is now strictly validated. While this shouldn't have a large breaking
impact as users would have already run into permadiff issues on re-apply,
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/compute_instance.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The following arguments are supported:
startup-script metadata key on the created instance and thus the two
mechanisms are not allowed to be used simultaneously. Users are free to use
either mechanism - the only distinction is that this separate attribute
willl cause a recreate on modification. On import, `metadata_startup_script`
will cause a recreate on modification. On import, `metadata_startup_script`
will be set, but `metadata.startup-script` will not - if you choose to use the
other mechanism, you will see a diff immediately after import, which will cause a
destroy/recreate operation. You may want to modify your state file manually
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/container_node_pool.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ resource "google_container_cluster" "primary" {
may change this value in your existing cluster, which will trigger destruction
and recreation on the next Terraform run (to rectify the discrepancy). If you don't
need this value, don't set it. If you do need it, you can [use a lifecycle block to
ignore subsqeuent changes to this field](https://github.com/hashicorp/terraform-provider-google/issues/6901#issuecomment-667369691).
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.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/dataproc_cluster.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ resource "google_dataproc_cluster" "accelerated_cluster" {
* `cluster_config` - (Optional) Allows you to configure various aspects of the cluster.
Structure defined below.

* `graceful_decommission_timout` - (Optional) Allows graceful decomissioning when you change the number of worker nodes directly through a terraform apply.
* `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.
Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress.
Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs).
Expand Down Expand Up @@ -190,7 +190,7 @@ The `cluster_config` block supports:
* `preemptible_worker_config` (Optional) The Google Compute Engine config settings for the additional
instances in a cluster. Structure defined below.
* **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 neccasarily mean it is preemptible and is named as
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.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/gke_hub_feature_membership.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The `configmanagement` block supports:

* `binauthz` -
(Optional)
Binauthz conifguration for the cluster.
Binauthz configuration for the cluster.

* `config_sync` -
(Optional)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/google_project.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The following arguments are supported:

* `billing_account` - (Optional) The alphanumeric ID of the billing account this project
belongs to. The user or service account performing this operation with Terraform
must have at mininum Billing Account User privileges (`roles/billing.user`) on the billing account.
must have at minimum Billing Account User privileges (`roles/billing.user`) on the billing account.
See [Google Cloud Billing API Access Control](https://cloud.google.com/billing/docs/how-to/billing-access)
for more details.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/logging_billing_account_sink.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ typical IAM roles granted on a project.
```hcl
resource "google_logging_billing_account_sink" "my-sink" {
name = "my-sink"
description = "some explaination on what this is"
description = "some explanation on what this is"
billing_account = "ABCDEF-012345-GHIJKL"
# Can export to pubsub, cloud storage, or bigquery
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/logging_folder_sink.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Manages a folder-level logging sink. For more information see:
```hcl
resource "google_logging_folder_sink" "my-sink" {
name = "my-sink"
description = "some explaination on what this is"
description = "some explanation on what this is"
folder = google_folder.my-folder.name
# Can export to pubsub, cloud storage, or bigquery
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/logging_organization_sink.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Manages a organization-level logging sink. For more information see:
```hcl
resource "google_logging_organization_sink" "my-sink" {
name = "my-sink"
description = "some explaination on what this is"
description = "some explanation on what this is"
org_id = "123456789"
# Can export to pubsub, cloud storage, or bigquery
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/logging_project_sink.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ resource "google_storage_bucket" "log-bucket" {
# Our sink; this logs all activity related to our "my-logged-instance" instance
resource "google_logging_project_sink" "instance-sink" {
name = "my-instance-sink"
description = "some explaination on what this is"
description = "some explanation on what this is"
destination = "storage.googleapis.com/${google_storage_bucket.log-bucket.name}"
filter = "resource.type = gce_instance AND resource.labels.instance_id = \"${google_compute_instance.my-logged-instance.instance_id}\""
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/storage_transfer_job.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The `object_conditions` block supports:
* `min_time_elapsed_since_last_modification` - (Optional)
A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

* `include_prefixes` - (Optional) If `include_refixes` is specified, objects that satisfy the object conditions must have names that start with one of the `include_prefixes` and that do not start with any of the `exclude_prefixes`. If `include_prefixes` is not specified, all objects except those that have names starting with one of the `exclude_prefixes` must satisfy the object conditions. See [Requirements](https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#ObjectConditions).
* `include_prefixes` - (Optional) If `include_prefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `include_prefixes` and that do not start with any of the `exclude_prefixes`. If `include_prefixes` is not specified, all objects except those that have names starting with one of the `exclude_prefixes` must satisfy the object conditions. See [Requirements](https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#ObjectConditions).

* `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).

Expand Down