Skip to content

Commit ec96e35

Browse files
author
Simon So
committed
Update docs
1 parent ebbb80b commit ec96e35

File tree

6 files changed

+19
-6
lines changed

6 files changed

+19
-6
lines changed

examples/instance_template/simple/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ This is a simple, minimal example of how to use the instance_template module.
99
| Name | Description | Type | Default | Required |
1010
|------|-------------|:----:|:-----:|:-----:|
1111
| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes |
12+
| labels | Labels, provided as a map | map | n/a | yes |
1213
| project\_id | The GCP project to use for integration tests | string | n/a | yes |
1314
| region | The GCP region to create and test resources in | string | n/a | yes |
1415
| service\_account | Service account email address and scopes | map | n/a | yes |
1516
| subnetwork | The name of the subnetwork create this instance in. | string | `""` | no |
17+
| tags | Network tags, provided as a list | list | n/a | yes |
1618

1719
## Outputs
1820

examples/mig/autoscaler/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,11 @@ group with an autoscaler.
1212
| autoscaling\_cpu | Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization | list | n/a | yes |
1313
| autoscaling\_enabled | Creates an autoscaler for the managed instance group | string | n/a | yes |
1414
| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes |
15-
| labels | Labels, provided as a map | map | n/a | yes |
1615
| min\_replicas | The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. | string | n/a | yes |
1716
| project\_id | The GCP project to use for integration tests | string | n/a | yes |
1817
| region | The GCP region to create and test resources in | string | n/a | yes |
1918
| service\_account | Service account email address and scopes | map | n/a | yes |
2019
| subnetwork | The subnetwork to host the compute instances in | string | n/a | yes |
21-
| tags | Network tags, provided as a list | list | n/a | yes |
2220

2321
## Outputs
2422

examples/mig/simple/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@ managed instance group.
1010
| Name | Description | Type | Default | Required |
1111
|------|-------------|:----:|:-----:|:-----:|
1212
| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes |
13-
| labels | Labels, provided as a map | map | n/a | yes |
1413
| project\_id | The GCP project to use for integration tests | string | n/a | yes |
1514
| region | The GCP region to create and test resources in | string | n/a | yes |
1615
| service\_account | Service account email address and scopes | map | n/a | yes |
1716
| subnetwork | The subnetwork to host the compute instances in | string | n/a | yes |
18-
| tags | Network tags, provided as a list | list | n/a | yes |
1917
| target\_size | The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. | string | n/a | yes |
2018

2119
## Outputs

modules/instance_template/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ See the [simple](examples/instance_template/simple) for a usage example.
2626
| metadata | Metadata, provided as a map | map | `<map>` | no |
2727
| name\_prefix | Name prefix for the instance template | string | `"default-instance-template"` | no |
2828
| network | The name or self_link of the network to attach this interface to. Use network attribute for Legacy or Auto subnetted networks and subnetwork for custom subnetted networks. | string | `""` | no |
29-
| service\_account | Service account email address and scopes | map | n/a | yes |
29+
| service\_account | Service account to attach to the instance. See https://www.terraform.io/docs/providers/google/r/compute_instance_template.html#service_account. | map | n/a | yes |
3030
| source\_image | Source disk image. If neither source_image nor source_image_family is specified, defaults to the latest public CentOS image. | string | `""` | no |
3131
| source\_image\_family | Source image family. If neither source_image nor source_image_family is specified, defaults to the latest public CentOS image. | string | `""` | no |
3232
| source\_image\_project | Project where the source image comes from | string | `""` | no |

modules/mig/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ See the [simple](examples/mig/simple) for a usage example.
3333
| instance\_template | Instance template self_link used to create compute instances | string | n/a | yes |
3434
| max\_replicas | The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. | string | `"10"` | no |
3535
| min\_replicas | The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. | string | `"2"` | no |
36-
| named\_ports | Named name and named port | list | `<list>` | no |
36+
| named\_ports | Named name and named port. https://cloud.google.com/load-balancing/docs/backend-service#named_ports | list | `<list>` | no |
3737
| network | Network to deploy to. Only one of network or subnetwork should be specified. | string | `""` | no |
3838
| region | The GCP region where the managed instance group resides. | string | n/a | yes |
3939
| subnetwork | Subnet to deploy to. Only one of network or subnetwork should be specified. | string | `""` | no |

modules/project_services/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,19 @@ terraform apply tfplan
2525

2626
[^]: (autogen_docs_start)
2727

28+
## Inputs
29+
30+
| Name | Description | Type | Default | Required |
31+
|------|-------------|:----:|:-----:|:-----:|
32+
| activate\_apis | The list of apis to activate within the project | list | `<list>` | no |
33+
| disable\_services\_on\_destroy | Whether project services will be disabled when the resources are destroyed. https://www.terraform.io/docs/providers/google/r/google_project_service.html#disable_on_destroy | string | `"true"` | no |
34+
| enable\_apis | Whether to actually enable the APIs. If false, this module is a no-op. | string | `"true"` | no |
35+
| project\_id | The GCP project you want to enable APIs on | string | n/a | yes |
36+
37+
## Outputs
38+
39+
| Name | Description |
40+
|------|-------------|
41+
| project\_id | The GCP project you want to enable APIs on |
42+
2843
[^]: (autogen_docs_end)

0 commit comments

Comments
 (0)