From 63e67441b325b2eade09b1da7e6ab9b0820465a4 Mon Sep 17 00:00:00 2001 From: Sebastien Badia Date: Thu, 31 Mar 2016 12:37:17 +0200 Subject: [PATCH] docs/google: Update links, fix syntax errors and remove whitespaces --- .../google/r/compute_address.html.markdown | 4 ++-- .../google/r/compute_autoscaler.html.markdown | 2 +- .../google/r/compute_instance.html.markdown | 6 +++--- .../google/r/compute_instance_group.html.markdown | 8 ++++---- .../r/compute_instance_group_manager.html.markdown | 8 ++++---- .../r/compute_instance_template.html.markdown | 14 +++++++------- .../google/r/compute_network.html.markdown | 4 ++-- .../providers/google/r/compute_route.html.markdown | 2 +- .../google/r/compute_ssl_certificate.html.markdown | 2 +- .../google/r/compute_subnetwork.html.markdown | 4 ++-- .../google/r/compute_url_map.html.markdown | 12 ++++++------ .../google/r/compute_vpn_gateway.html.markdown | 4 ++-- .../google/r/compute_vpn_tunnel.html.markdown | 8 ++++---- .../providers/google/r/sql_database.html.markdown | 2 +- .../google/r/sql_database_instance.html.markdown | 2 +- .../docs/providers/google/r/sql_user.html.markdown | 2 +- .../google/r/storage_bucket.html.markdown | 6 +++--- .../google/r/storage_bucket_acl.html.markdown | 4 ++-- .../google/r/storage_bucket_object.html.markdown | 2 +- 19 files changed, 48 insertions(+), 48 deletions(-) diff --git a/website/source/docs/providers/google/r/compute_address.html.markdown b/website/source/docs/providers/google/r/compute_address.html.markdown index b171df5ea..2b695df8c 100644 --- a/website/source/docs/providers/google/r/compute_address.html.markdown +++ b/website/source/docs/providers/google/r/compute_address.html.markdown @@ -27,8 +27,8 @@ The following arguments are supported: * `name` - (Required) A unique name for the resource, required by GCE. Changing this forces a new resource to be created. -* `region` - (Optional) The Region in which the created address should reside. - If it is not provided, the provider region is used. +* `region` - (Optional) The Region in which the created address should reside. + If it is not provided, the provider region is used. ## Attributes Reference diff --git a/website/source/docs/providers/google/r/compute_autoscaler.html.markdown b/website/source/docs/providers/google/r/compute_autoscaler.html.markdown index c8e6e6373..381caf09f 100644 --- a/website/source/docs/providers/google/r/compute_autoscaler.html.markdown +++ b/website/source/docs/providers/google/r/compute_autoscaler.html.markdown @@ -114,7 +114,7 @@ The `metric` block contains (more documentation [here](https://cloud.google.com/monitoring/api/metrics)): * `name` - The name of the Google Cloud Monitoring metric to follow, e.g. - compute.googleapis.com/instance/network/received_bytes_count + `compute.googleapis.com/instance/network/received_bytes_count` * `type` - Either "cumulative", "delta", or "gauge". diff --git a/website/source/docs/providers/google/r/compute_instance.html.markdown b/website/source/docs/providers/google/r/compute_instance.html.markdown index 25bc46f8d..543391bc0 100644 --- a/website/source/docs/providers/google/r/compute_instance.html.markdown +++ b/website/source/docs/providers/google/r/compute_instance.html.markdown @@ -61,7 +61,7 @@ The following arguments are supported: * `description` - (Optional) A brief description of this resource. -* `machine_type` - (Required) The machine type to create.To create a custom machine type, value should be +* `machine_type` - (Required) The machine type to create.To create a custom machine type, value should be set as specified [here](https://cloud.google.com/compute/docs/reference/latest/instances#machineType) * `zone` - (Required) The zone that the machine should be created in. @@ -123,7 +123,7 @@ The `network_interface` block supports: * `network` - (Optional) The name of the network to attach this interface to. Either `network` or `subnetwork` must be provided. - + * `subnetwork` - (Optional) the name of the subnetwork to attach this interface to. The subnetwork must exist in the same region this instance will be created in. Either `network` or `subnetwork` must be provided. @@ -159,7 +159,7 @@ The `scheduling` block supports: * `preemptible` - (Optional) Is the instance preemptible. -* `on_host_maintenance` - (Optional) Describes maintenance behavior for +* `on_host_maintenance` - (Optional) Describes maintenance behavior for the instance. Can be MIGRATE or TERMINATE, for more info, read [here](https://cloud.google.com/compute/docs/instances/setting-instance-scheduling-options) diff --git a/website/source/docs/providers/google/r/compute_instance_group.html.markdown b/website/source/docs/providers/google/r/compute_instance_group.html.markdown index adfb597fc..f7f78fb38 100644 --- a/website/source/docs/providers/google/r/compute_instance_group.html.markdown +++ b/website/source/docs/providers/google/r/compute_instance_group.html.markdown @@ -57,12 +57,12 @@ Supported characters include lowercase letters, numbers, and hyphens. group. * `instances` - (Optional) List of instances in the group. They should be given as - self_link URLs. When adding instances they must all be in the same network and + self_link URLs. When adding instances they must all be in the same network and zone as the instance group. -* `named_port` - (Optional) Named ports are key:value pairs that represent a - service name and the port number that the service runs on. The key:value pairs - are simple metadata that the Load Balancing service can use. This can specified +* `named_port` - (Optional) Named ports are key:value pairs that represent a + service name and the port number that the service runs on. The key:value pairs + are simple metadata that the Load Balancing service can use. This can specified multiple times * `zone` - (Required) The zone that this instance group should be created in. diff --git a/website/source/docs/providers/google/r/compute_instance_group_manager.html.markdown b/website/source/docs/providers/google/r/compute_instance_group_manager.html.markdown index 8d87a13f2..5e39221f1 100644 --- a/website/source/docs/providers/google/r/compute_instance_group_manager.html.markdown +++ b/website/source/docs/providers/google/r/compute_instance_group_manager.html.markdown @@ -10,7 +10,7 @@ description: |- The Google Compute Engine Instance Group Manager API creates and manages pools of homogeneous Compute Engine virtual machine instances from a common instance -template. For more information, see [the official documentation](https://cloud.google.com/compute/docs/instance-groups/manager +template. For more information, see [the official documentation](https://cloud.google.com/compute/docs/instance-groups/manager) and [API](https://cloud.google.com/compute/docs/instance-groups/manager/v1beta2/instanceGroupManagers) ## Example Usage @@ -48,11 +48,11 @@ instance name. group manager. * `instance_template` - (Required) The full URL to an instance template from -which all new instances will be created. +which all new instances will be created. * `update_strategy` - (Optional, Default `"RESTART"`) If the `instance_template` resource is modified, a value of `"NONE"` will prevent any of the managed instances from -being restarted by Terraform. A value of `"RESTART"` will restart all of the +being restarted by Terraform. A value of `"RESTART"` will restart all of the instances at once. In the future, as the GCE API matures we will support `"ROLLING_UPDATE"` as well. @@ -69,7 +69,7 @@ affect existing instances. * `zone` - (Required) The zone that instances in this group should be created in. -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. diff --git a/website/source/docs/providers/google/r/compute_instance_template.html.markdown b/website/source/docs/providers/google/r/compute_instance_template.html.markdown index 32583fc5d..4aaae38c7 100644 --- a/website/source/docs/providers/google/r/compute_instance_template.html.markdown +++ b/website/source/docs/providers/google/r/compute_instance_template.html.markdown @@ -85,20 +85,20 @@ 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. - -* `region` - (Optional) An instance template is a global resource that is not bound to a zone - or a region. However, you can still specify some regional resources in an instance template, + +* `region` - (Optional) An instance template is a global resource that is not bound to a zone + or a region. However, you can still specify some regional resources in an instance template, which restricts the template to the region where that resource resides. For example, a custom `subnetwork` resource is tied to a specific region. Defaults to the region of the Provider if no value is given. -* `automatic_restart` - (Optional, Deprecated - see `scheduling`) +* `automatic_restart` - (Optional, Deprecated - see `scheduling`) Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). This defaults to true. -* `on_host_maintenance` - (Optional, Deprecated - see `scheduling`) +* `on_host_maintenance` - (Optional, Deprecated - see `scheduling`) Defines the maintenance behavior for this instance. * `service_account` - (Optional) Service account to attach to the instance. @@ -138,7 +138,7 @@ The `disk` block supports: * `disk_type` - (Optional) The GCE disk type. Can be either `"pd-ssd"`, `"local-ssd"`, or `"pd-standard"`. -* `disk_size_gb` - (Optional) The size of the image in gigabytes. If not specified, +* `disk_size_gb` - (Optional) The size of the image in gigabytes. If not specified, it will inherit the size of its base image. * `type` - (Optional) The type of GCE disk, can be either `"SCRATCH"` or @@ -179,7 +179,7 @@ The `scheduling` block supports: * `on_host_maintenance` - (Optional) Defines the maintenance behavior for this instance. -* `preemptible` - (Optional) Allows instance to be preempted. Read +* `preemptible` - (Optional) Allows instance to be preempted. Read more on this [here](https://cloud.google.com/compute/docs/instances/preemptible). ## Attributes Reference diff --git a/website/source/docs/providers/google/r/compute_network.html.markdown b/website/source/docs/providers/google/r/compute_network.html.markdown index 224408995..843fd8839 100644 --- a/website/source/docs/providers/google/r/compute_network.html.markdown +++ b/website/source/docs/providers/google/r/compute_network.html.markdown @@ -31,8 +31,8 @@ The following arguments are supported: set, an auto or custom subnetted network will be created, depending on the value of `auto_create_subnetworks` attribute. This attribute may not be used if `auto_create_subnets` is specified. - -* `auto_create_subnetworks` - (Optional) If set to true, this network + +* `auto_create_subnetworks` - (Optional) If set to true, this network will be created in auto subnet mode, and Google will create a subnet for each region automatically. If set to false, and `ipv4_range` is not set, a custom subnetted diff --git a/website/source/docs/providers/google/r/compute_route.html.markdown b/website/source/docs/providers/google/r/compute_route.html.markdown index 5a0dacfe1..9ed18ef5e 100644 --- a/website/source/docs/providers/google/r/compute_route.html.markdown +++ b/website/source/docs/providers/google/r/compute_route.html.markdown @@ -53,7 +53,7 @@ The following arguments are supported: * `next_hop_vpn_gateway` - (Optional) The name of the VPN to route to if this route is matched. - + * `priority` - (Required) The priority of this route, used to break ties. * `tags` - (Optional) The tags that this route applies to. diff --git a/website/source/docs/providers/google/r/compute_ssl_certificate.html.markdown b/website/source/docs/providers/google/r/compute_ssl_certificate.html.markdown index 81eb3a267..3d705ee16 100644 --- a/website/source/docs/providers/google/r/compute_ssl_certificate.html.markdown +++ b/website/source/docs/providers/google/r/compute_ssl_certificate.html.markdown @@ -8,7 +8,7 @@ description: |- # google\_compute\_ssl\_certificate -Creates an SSL certificate resource necessary for HTTPS load balancing in GCE. +Creates an SSL certificate resource necessary for HTTPS load balancing in GCE. For more information see [the official documentation](https://cloud.google.com/compute/docs/load-balancing/http/ssl-certificates) and [API](https://cloud.google.com/compute/docs/reference/latest/sslCertificates). diff --git a/website/source/docs/providers/google/r/compute_subnetwork.html.markdown b/website/source/docs/providers/google/r/compute_subnetwork.html.markdown index 4bc373ec1..6394638f1 100644 --- a/website/source/docs/providers/google/r/compute_subnetwork.html.markdown +++ b/website/source/docs/providers/google/r/compute_subnetwork.html.markdown @@ -33,8 +33,8 @@ The following arguments are supported: * `ip_cidr_range` - (Required) The IP address range that machines in this network are assigned to, represented as a CIDR block. - -* `region` - (Required) The region this subnetwork will be created in. + +* `region` - (Required) The region this subnetwork will be created in. * `description` - (Optional) Description of this subnetwork. diff --git a/website/source/docs/providers/google/r/compute_url_map.html.markdown b/website/source/docs/providers/google/r/compute_url_map.html.markdown index b7cdfdcf7..37b9da909 100644 --- a/website/source/docs/providers/google/r/compute_url_map.html.markdown +++ b/website/source/docs/providers/google/r/compute_url_map.html.markdown @@ -86,7 +86,7 @@ The following arguments are supported: * `description` - (Optional) A brief description of this resource. * `default_service` - (Required) The URL of the backend service to use when none of the - given rules match. See the documentation for formatting the service URL + given rules match. See the documentation for formatting the service URL [here](https://cloud.google.com/compute/docs/reference/latest/urlMaps#defaultService) The `host_rule` block supports: (Note that this block can be defined an arbitrary @@ -97,14 +97,14 @@ number of times.) * `description` - (Optional) An optional description of the host rule. -* `path_matcher` - (Required) The name of the `path_matcher` (defined below) - to apply this host rule to. +* `path_matcher` - (Required) The name of the `path_matcher` (defined below) + to apply this host rule to. The `path_matcher` block supports: (Note that this block can be defined an arbitrary number of times.) * `default_service` - (Required) The URL for the backend service to use if none - of the given paths match. See the documentation for formatting the service URL + of the given paths match. See the documentation for formatting the service URL [here](https://cloud.google.com/compute/docs/reference/latest/urlMaps#pathMatcher.defaultService) * `name` - (Required) The name of the `path_matcher` resource. Used by the `host_rule` @@ -119,10 +119,10 @@ number of times.) documentation for formatting these [here](https://cloud.google.com/compute/docs/reference/latest/urlMaps#pathMatchers.pathRules.paths) * `default_service` - (Required) The URL for the backend service to use if any - of the given paths match. See the documentation for formatting the service URL + of the given paths match. See the documentation for formatting the service URL [here](https://cloud.google.com/compute/docs/reference/latest/urlMaps#pathMatcher.defaultService) -The optional `test` block supports: (Note that this block can be defined an arbitary +The optional `test` block supports: (Note that this block can be defined an arbitary number of times.) * `service` - (Required) The service that should be matched by this test. diff --git a/website/source/docs/providers/google/r/compute_vpn_gateway.html.markdown b/website/source/docs/providers/google/r/compute_vpn_gateway.html.markdown index 881bbc9e3..a70e7d22c 100644 --- a/website/source/docs/providers/google/r/compute_vpn_gateway.html.markdown +++ b/website/source/docs/providers/google/r/compute_vpn_gateway.html.markdown @@ -8,7 +8,7 @@ description: |- # google\_compute\_vpn\_gateway -Manages a VPN Gateway in the GCE network. For more info, read the +Manages a VPN Gateway in the GCE network. For more info, read the [documentation](https://cloud.google.com/compute/docs/vpn). @@ -93,7 +93,7 @@ The following arguments are supported: Changing this forces a new resource to be created. * `region` - (Optional) The region this gateway should sit in. If not specified, - the project region will be used. Changing this forces a new resource to be + the project region will be used. Changing this forces a new resource to be created. ## Attributes Reference diff --git a/website/source/docs/providers/google/r/compute_vpn_tunnel.html.markdown b/website/source/docs/providers/google/r/compute_vpn_tunnel.html.markdown index 6a5e4e9f0..8968ce208 100644 --- a/website/source/docs/providers/google/r/compute_vpn_tunnel.html.markdown +++ b/website/source/docs/providers/google/r/compute_vpn_tunnel.html.markdown @@ -8,7 +8,7 @@ description: |- # google\_compute\_vpn\_tunnel -Manages a VPN Tunnel to the GCE network. For more info, read the +Manages a VPN Tunnel to the GCE network. For more info, read the [documentation](https://cloud.google.com/compute/docs/vpn). ## Example Usage @@ -91,7 +91,7 @@ The following arguments are supported: Changing this forces a new resource to be created. * `region` - (Optional) The region this tunnel should sit in. If not specified, - the project region will be used. Changing this forces a new resource to be + the project region will be used. Changing this forces a new resource to be created. * `shared_secret` - (Required) A passphrase shared between the two VPN gateways. @@ -102,7 +102,7 @@ The following arguments are supported: * `ike_version` - (Optional) Either version 1 or 2. Default is 2. Changing this forces a new resource to be created. - + * `local_traffic_selector` - (Optional) Specifies which CIDR ranges are announced to the VPN peer. Mandatory if the VPN gateway is attached to a custom subnetted network. Refer to Google documentation for more information. @@ -113,4 +113,4 @@ The following attributes are exported: * `self_link` - A GCE server assigned link to this resource. -* `detailed_status` - Information about the status of the VPN tunnel. +* `detailed_status` - Information about the status of the VPN tunnel. diff --git a/website/source/docs/providers/google/r/sql_database.html.markdown b/website/source/docs/providers/google/r/sql_database.html.markdown index eae67b363..07413c390 100644 --- a/website/source/docs/providers/google/r/sql_database.html.markdown +++ b/website/source/docs/providers/google/r/sql_database.html.markdown @@ -17,7 +17,7 @@ Example creating a SQL Database. ``` resource "google_sql_database_instance" "master" { name = "master-instance" - + settings { tier = "D0" } diff --git a/website/source/docs/providers/google/r/sql_database_instance.html.markdown b/website/source/docs/providers/google/r/sql_database_instance.html.markdown index 253132c47..c00f8b526 100644 --- a/website/source/docs/providers/google/r/sql_database_instance.html.markdown +++ b/website/source/docs/providers/google/r/sql_database_instance.html.markdown @@ -30,7 +30,7 @@ The following arguments are supported: * `name` - (Optional, Computed) The name of the instance. If the name is left blank, Terraform will randomly generate one when the instance is first - created. This is done because after a name is used, it cannot be reused + created. This is done because after a name is used, it cannot be reused for up to [two months](https://cloud.google.com/sql/docs/delete-instance). * `region` - (Required) The region the instance will sit in. Note, this does diff --git a/website/source/docs/providers/google/r/sql_user.html.markdown b/website/source/docs/providers/google/r/sql_user.html.markdown index 6bb463291..e7275b0ae 100644 --- a/website/source/docs/providers/google/r/sql_user.html.markdown +++ b/website/source/docs/providers/google/r/sql_user.html.markdown @@ -17,7 +17,7 @@ Example creating a SQL User. ``` resource "google_sql_database_instance" "master" { name = "master-instance" - + settings { tier = "D0" } diff --git a/website/source/docs/providers/google/r/storage_bucket.html.markdown b/website/source/docs/providers/google/r/storage_bucket.html.markdown index b5afc282e..a527fa2df 100644 --- a/website/source/docs/providers/google/r/storage_bucket.html.markdown +++ b/website/source/docs/providers/google/r/storage_bucket.html.markdown @@ -13,7 +13,7 @@ Creates a new bucket in Google cloud storage service(GCS). Currently, it will no ## Example Usage -Example creating a private bucket in standard storage, in the EU region. +Example creating a private bucket in standard storage, in the EU region. ``` resource "google_storage_bucket" "image-store" { @@ -34,8 +34,8 @@ The following arguments are supported: * `name` - (Required) The name of the bucket. * `predefined_acl` - (Optional, Deprecated) The [canned GCS ACL](https://cloud.google.com/storage/docs/access-control#predefined-acl) to apply. Please switch to `google_storage_bucket_acl.predefined_acl`. -* `location` - (Optional, Default: 'US') The [GCS location](https://cloud.google.com/storage/docs/bucket-locations) -* `force_destroy` - (Optional, Default: false) When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, Terraform will fail that run. +* `location` - (Optional, Default: 'US') The [GCS location](https://cloud.google.com/storage/docs/bucket-locations) +* `force_destroy` - (Optional, Default: false) When deleting a bucket, this boolean option will delete all contained objects. If you try to delete a bucket that contains objects, Terraform will fail that run. The optional `website` block supports: diff --git a/website/source/docs/providers/google/r/storage_bucket_acl.html.markdown b/website/source/docs/providers/google/r/storage_bucket_acl.html.markdown index 14a169b9d..c9cbf5339 100644 --- a/website/source/docs/providers/google/r/storage_bucket_acl.html.markdown +++ b/website/source/docs/providers/google/r/storage_bucket_acl.html.markdown @@ -8,7 +8,7 @@ description: |- # google\_storage\_bucket\_acl -Creates a new bucket ACL in Google cloud storage service(GCS). +Creates a new bucket ACL in Google cloud storage service(GCS). ## Example Usage @@ -22,7 +22,7 @@ resource "google_storage_bucket" "image-store" { resource "google_storage_bucket_acl" "image-store-acl" { bucket = "${google_storage_bucket.image_store.name}" - role_entity = ["OWNER:user-my.email@gmail.com", + role_entity = ["OWNER:user-my.email@gmail.com", "READER:group-mygroup"] } diff --git a/website/source/docs/providers/google/r/storage_bucket_object.html.markdown b/website/source/docs/providers/google/r/storage_bucket_object.html.markdown index 7b481550b..ecbefd1be 100644 --- a/website/source/docs/providers/google/r/storage_bucket_object.html.markdown +++ b/website/source/docs/providers/google/r/storage_bucket_object.html.markdown @@ -38,7 +38,7 @@ if `content` is not. * `content` - (Optional) Data as `string` to be uploaded. Must be defined if `source` is not. -* `predefined_acl` - (Optional, Deprecated) The [canned GCS ACL](https://cloud.google.com/storage/docs/access-control#predefined-acl) apply. Please switch +* `predefined_acl` - (Optional, Deprecated) The [canned GCS ACL](https://cloud.google.com/storage/docs/access-control#predefined-acl) apply. Please switch to `google_storage_object_acl.predefined_acl`. ## Attributes Reference