Skip to content

Commit d6f6e50

Browse files
committed
Adding variables to README
1 parent 55862a0 commit d6f6e50

File tree

1 file changed

+39
-36
lines changed

1 file changed

+39
-36
lines changed

README.md

Lines changed: 39 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -81,60 +81,63 @@ Then perform the following commands on the root folder:
8181
- `terraform destroy` to destroy the built infrastructure
8282
[^]: (autogen_docs_start)
8383

84-
8584
## Inputs
8685

8786
| Name | Description | Type | Default | Required |
8887
|------|-------------|:----:|:-----:|:-----:|
88+
| basic\_auth\_password | Kubernetes HTTP Basic auth password. Defaults to empty string. Only used if `enable_basic_auth` is true | string | `` | no |
89+
| basic\_auth\_username | Kubernetes HTTP Basic auth username. Defaults to empty string. Only used if `enable_basic_auth` is true | string | `` | no |
8990
| description | The description of the cluster | string | `` | no |
90-
| horizontal_pod_autoscaling | Enable horizontal pod autoscaling addon | string | `false` | no |
91-
| http_load_balancing | Enable httpload balancer addon | string | `true` | no |
92-
| ip_masq_link_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no |
93-
| ip_masq_resync_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no |
94-
| ip_range_pods | The secondary ip range to use for pods | string | - | yes |
95-
| ip_range_services | The secondary ip range to use for pods | string | - | yes |
96-
| kubernetes_dashboard | Enable kubernetes dashboard addon | string | `false` | no |
97-
| kubernetes_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `1.10.6-gke.2` | no |
98-
| logging_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `logging.googleapis.com` | no |
99-
| maintenance_start_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no |
100-
| master_authorized_networks_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)<br><br> ### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `<list>` | no |
101-
| monitoring_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `monitoring.googleapis.com` | no |
91+
| enable\_basic\_auth | Basic authentication allows a user to authenticate to the cluster with a username and password. To maximize the security of your cluster, disable this option. Basic authentication is not recommended because it provides no confidentiality protection for transmitted credentials. Default: true | string | `true` | no |
92+
| horizontal\_pod\_autoscaling | Enable horizontal pod autoscaling addon | string | `false` | no |
93+
| http\_load\_balancing | Enable httpload balancer addon | string | `true` | no |
94+
| ip\_masq\_link\_local | Whether to masquerade traffic to the link-local prefix (169.254.0.0/16). | string | `false` | no |
95+
| ip\_masq\_resync\_interval | The interval at which the agent attempts to sync its ConfigMap file from the disk. | string | `60s` | no |
96+
| ip\_range\_pods | The secondary ip range to use for pods | string | - | yes |
97+
| ip\_range\_services | The secondary ip range to use for pods | string | - | yes |
98+
| issue\_client\_certificate | Issues a client certificate to authenticate to the cluster endpoint. To maximize the security of your cluster, leave this option disabled. Client certificates don't automatically rotate and aren't easily revocable. WARNING: changing this after cluster creation is destructive! Default: false | string | `false` | no |
99+
| kubernetes\_dashboard | Enable kubernetes dashboard addon | string | `false` | no |
100+
| kubernetes\_version | The Kubernetes version of the masters. If set to 'latest' it will pull latest available version in the selected region. | string | `latest` | no |
101+
| logging\_service | The logging service that the cluster should write logs to. Available options include logging.googleapis.com, logging.googleapis.com/kubernetes (beta), and none | string | `logging.googleapis.com` | no |
102+
| maintenance\_start\_time | Time window specified for daily maintenance operations in RFC3339 format | string | `05:00` | no |
103+
| master\_authorized\_networks\_config | The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists)<br><br> ### example format ### master_authorized_networks_config = [{ cidr_blocks = [{ cidr_block = "10.0.0.0/8" display_name = "example_network" }], }] | list | `<list>` | no |
104+
| monitoring\_service | The monitoring service that the cluster should write metrics to. Automatically send metrics from pods in the cluster to the Google Cloud Monitoring API. VM metrics will be collected by Google Compute Engine regardless of this setting Available options include monitoring.googleapis.com, monitoring.googleapis.com/kubernetes (beta) and none | string | `monitoring.googleapis.com` | no |
102105
| name | The name of the cluster (required) | string | - | yes |
103106
| network | The VPC network to host the cluster in (required) | string | - | yes |
104-
| network_policy | Enable network policy addon | string | `false` | no |
105-
| network_project_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no |
106-
| node_pools | List of maps containing node pools | list | `<list>` | no |
107-
| node_pools_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
108-
| node_pools_tags | Map of lists containing node network tags by node-pool name | map | `<map>` | no |
109-
| node_pools_taints | Map of lists containing node taints by node-pool name | map | `<map>` | no |
110-
| node_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `` | no |
111-
| non_masquerade_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `<list>` | no |
112-
| project_id | The project ID to host the cluster in (required) | string | - | yes |
107+
| network\_policy | Enable network policy addon | string | `false` | no |
108+
| network\_project\_id | The project ID of the shared VPC's host (for shared vpc support) | string | `` | no |
109+
| node\_pools | List of maps containing node pools | list | `<list>` | no |
110+
| node\_pools\_labels | Map of maps containing node labels by node-pool name | map | `<map>` | no |
111+
| node\_pools\_tags | Map of lists containing node network tags by node-pool name | map | `<map>` | no |
112+
| node\_pools\_taints | Map of lists containing node taints by node-pool name | map | `<map>` | no |
113+
| node\_version | The Kubernetes version of the node pools. Defaults kubernetes_version (master) variable and can be overridden for individual node pools by setting the `version` key on them. Must be empyty or set the same as master at cluster creation. | string | `` | no |
114+
| non\_masquerade\_cidrs | List of strings in CIDR notation that specify the IP address ranges that do not use IP masquerading. | list | `<list>` | no |
115+
| project\_id | The project ID to host the cluster in (required) | string | - | yes |
113116
| region | The region to host the cluster in (required) | string | - | yes |
114117
| regional | Whether is a regional cluster (zonal cluster if set false. WARNING: changing this after cluster creation is destructive!) | string | `true` | no |
115-
| stub_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `<map>` | no |
118+
| stub\_domains | Map of stub domains and their resolvers to forward DNS queries for a certain domain to an external DNS server | map | `<map>` | no |
116119
| subnetwork | The subnetwork to host the cluster in (required) | string | - | yes |
117120
| zones | The zones to host the cluster in (optional if regional cluster / required if zonal) | list | `<list>` | no |
118121

119122
## Outputs
120123

121124
| Name | Description |
122125
|------|-------------|
123-
| ca_certificate | Cluster ca certificate (base64 encoded) |
126+
| ca\_certificate | Cluster ca certificate (base64 encoded) |
124127
| endpoint | Cluster endpoint |
125-
| horizontal_pod_autoscaling_enabled | Whether horizontal pod autoscaling enabled |
126-
| http_load_balancing_enabled | Whether http load balancing enabled |
127-
| kubernetes_dashboard_enabled | Whether kubernetes dashboard enabled |
128+
| horizontal\_pod\_autoscaling\_enabled | Whether horizontal pod autoscaling enabled |
129+
| http\_load\_balancing\_enabled | Whether http load balancing enabled |
130+
| kubernetes\_dashboard\_enabled | Whether kubernetes dashboard enabled |
128131
| location | Cluster location (region if regional cluster, zone if zonal cluster) |
129-
| logging_service | Logging service used |
130-
| master_authorized_networks_config | Networks from which access to master is permitted |
131-
| master_version | Current master kubernetes version |
132-
| min_master_version | Minimum master kubernetes version |
133-
| monitoring_service | Monitoring service used |
132+
| logging\_service | Logging service used |
133+
| master\_authorized\_networks\_config | Networks from which access to master is permitted |
134+
| master\_version | Current master kubernetes version |
135+
| min\_master\_version | Minimum master kubernetes version |
136+
| monitoring\_service | Monitoring service used |
134137
| name | Cluster name |
135-
| network_policy_enabled | Whether network policy enabled |
136-
| node_pools_names | List of node pools names |
137-
| node_pools_versions | List of node pools versions |
138+
| network\_policy\_enabled | Whether network policy enabled |
139+
| node\_pools\_names | List of node pools names |
140+
| node\_pools\_versions | List of node pools versions |
138141
| region | Cluster region |
139142
| type | Cluster type (regional / zonal) |
140143
| zones | List of zones in which the cluster resides |
@@ -256,4 +259,4 @@ are as follows:
256259
is a compiled language so there is no standard linter.
257260
* Terraform - terraform has a built-in linter in the 'terraform validate'
258261
command.
259-
* Dockerfiles - hadolint. Can be found in homebrew
262+
* Dockerfiles - hadolint. Can be found in homebrew

0 commit comments

Comments
 (0)