From 6b927e5a918efc681e4ca8705360ed3a05577f96 Mon Sep 17 00:00:00 2001 From: Andrew Peabody Date: Wed, 13 Sep 2023 14:42:54 -0700 Subject: [PATCH] fix: regenerate docs (#1733) --- examples/safer_cluster_iap_bastion/README.md | 2 +- .../simple_regional_private_beta/README.md | 47 +++++++++---------- .../README.md | 46 +++++++++--------- .../README.md | 41 ++++++++-------- examples/upstream_nameservers/README.md | 41 ++++++++-------- examples/workload_metadata_config/README.md | 43 +++++++++-------- modules/acm/README.md | 2 +- modules/fleet-membership/README.md | 2 +- modules/hub-legacy/README.md | 2 +- 9 files changed, 108 insertions(+), 118 deletions(-) diff --git a/examples/safer_cluster_iap_bastion/README.md b/examples/safer_cluster_iap_bastion/README.md index f527858d5..700bc6e65 100644 --- a/examples/safer_cluster_iap_bastion/README.md +++ b/examples/safer_cluster_iap_bastion/README.md @@ -71,4 +71,4 @@ To deploy this example: | router\_name | Name of the router that was created | | subnet\_name | The name of the VPC subnet being created | - + diff --git a/examples/simple_regional_private_beta/README.md b/examples/simple_regional_private_beta/README.md index 160fc74a4..86e54b774 100644 --- a/examples/simple_regional_private_beta/README.md +++ b/examples/simple_regional_private_beta/README.md @@ -2,45 +2,42 @@ This example illustrates how to create a simple private cluster with beta features. -[^]: (autogen_docs_start) - + ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cloudrun | Boolean to enable / disable CloudRun | string | `"true"` | no | -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| istio | Boolean to enable / disable Istio | string | `"true"` | no | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | +|------|-------------|------|---------|:--------:| +| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes | +| dns\_cache | Boolean to enable / disable NodeLocal DNSCache | `bool` | `false` | no | +| gce\_pd\_csi\_driver | (Beta) Whether this cluster should enable the Google Compute Engine Persistent Disk Container Storage Interface (CSI) Driver. | `bool` | `false` | no | +| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes | +| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes | +| network | The VPC network to host the cluster in | `any` | n/a | yes | +| project\_id | The project ID to host the cluster in | `any` | n/a | yes | +| region | The region to host the cluster in | `any` | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca\_certificate | | -| client\_token | | +| ca\_certificate | n/a | +| client\_token | n/a | | cluster\_name | Cluster name | -| credentials\_path | | | ip\_range\_pods | The secondary IP range used for pods | | ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | +| kubernetes\_endpoint | n/a | +| location | n/a | | master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | +| network | n/a | +| project\_id | n/a | +| region | n/a | +| service\_account | The default service account used for running nodes. | +| subnetwork | n/a | | zones | List of zones in which the cluster resides | -[^]: (autogen_docs_end) + To provision this example, run the following from within this directory: - `terraform init` to get the plugins diff --git a/examples/simple_regional_private_with_cluster_version/README.md b/examples/simple_regional_private_with_cluster_version/README.md index 160fc74a4..26a676675 100644 --- a/examples/simple_regional_private_with_cluster_version/README.md +++ b/examples/simple_regional_private_with_cluster_version/README.md @@ -2,45 +2,41 @@ This example illustrates how to create a simple private cluster with beta features. -[^]: (autogen_docs_start) - + ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cloudrun | Boolean to enable / disable CloudRun | string | `"true"` | no | -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| credentials\_path | The path to the GCP credentials JSON file | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| istio | Boolean to enable / disable Istio | string | `"true"` | no | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | +|------|-------------|------|---------|:--------:| +| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes | +| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes | +| 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 | +| network | The VPC network to host the cluster in | `any` | n/a | yes | +| project\_id | The project ID to host the cluster in | `any` | n/a | yes | +| region | The region to host the cluster in | `any` | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca\_certificate | | -| client\_token | | +| ca\_certificate | n/a | +| client\_token | n/a | | cluster\_name | Cluster name | -| credentials\_path | | | ip\_range\_pods | The secondary IP range used for pods | | ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | +| kubernetes\_endpoint | n/a | +| location | n/a | | master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | +| network | n/a | +| project\_id | n/a | +| region | n/a | +| service\_account | The default service account used for running nodes. | +| subnetwork | n/a | | zones | List of zones in which the cluster resides | -[^]: (autogen_docs_end) + To provision this example, run the following from within this directory: - `terraform init` to get the plugins diff --git a/examples/stub_domains_upstream_nameservers/README.md b/examples/stub_domains_upstream_nameservers/README.md index 5448cc812..0c47b3a7e 100644 --- a/examples/stub_domains_upstream_nameservers/README.md +++ b/examples/stub_domains_upstream_nameservers/README.md @@ -7,41 +7,40 @@ It will: - Remove the default kube-dns configmap - Add a new kube-dns configmap with custom stub domains and upstream nameservers -[^]: (autogen_docs_start) - + ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | +|------|-------------|------|---------|:--------:| +| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes | +| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes | +| network | The VPC network to host the cluster in | `any` | n/a | yes | +| project\_id | The project ID to host the cluster in | `any` | n/a | yes | +| region | The region to host the cluster in | `any` | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca\_certificate | | -| client\_token | | +| ca\_certificate | n/a | +| client\_token | n/a | | cluster\_name | Cluster name | | ip\_range\_pods | The secondary IP range used for pods | | ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | +| kubernetes\_endpoint | n/a | +| location | n/a | | master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | +| network | n/a | +| project\_id | n/a | +| region | n/a | +| service\_account | The default service account used for running nodes. | +| subnetwork | n/a | | zones | List of zones in which the cluster resides | -[^]: (autogen_docs_end) + To provision this example, run the following from within this directory: - `terraform init` to get the plugins diff --git a/examples/upstream_nameservers/README.md b/examples/upstream_nameservers/README.md index f980e64f1..63515d730 100644 --- a/examples/upstream_nameservers/README.md +++ b/examples/upstream_nameservers/README.md @@ -7,41 +7,40 @@ It will: - Remove the default kube-dns configmap - Add a new kube-dns configmap with custom upstream nameservers -[^]: (autogen_docs_start) - + ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | +|------|-------------|------|---------|:--------:| +| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no | +| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | `any` | n/a | yes | +| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes | +| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes | +| network | The VPC network to host the cluster in | `any` | n/a | yes | +| project\_id | The project ID to host the cluster in | `any` | n/a | yes | +| region | The region to host the cluster in | `any` | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca\_certificate | | -| client\_token | | +| ca\_certificate | n/a | +| client\_token | n/a | | cluster\_name | Cluster name | | ip\_range\_pods | The secondary IP range used for pods | | ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | +| kubernetes\_endpoint | n/a | +| location | n/a | | master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | +| network | n/a | +| project\_id | n/a | +| region | n/a | +| service\_account | The default service account used for running nodes. | +| subnetwork | n/a | | zones | List of zones in which the cluster resides | -[^]: (autogen_docs_end) + To provision this example, run the following from within this directory: - `terraform init` to get the plugins diff --git a/examples/workload_metadata_config/README.md b/examples/workload_metadata_config/README.md index 19b990d96..e258123b3 100644 --- a/examples/workload_metadata_config/README.md +++ b/examples/workload_metadata_config/README.md @@ -2,42 +2,41 @@ This example illustrates how to use a cluster with `workload_metadata_config` defined. -[^]: (autogen_docs_start) - + ## Inputs | Name | Description | Type | Default | Required | -|------|-------------|:----:|:-----:|:-----:| -| cluster\_name\_suffix | A suffix to append to the default cluster name | string | `""` | no | -| compute\_engine\_service\_account | Service account to associate to the nodes in the cluster | string | n/a | yes | -| ip\_range\_pods | The secondary ip range to use for pods | string | n/a | yes | -| ip\_range\_services | The secondary ip range to use for pods | string | n/a | yes | -| network | The VPC network to host the cluster in | string | n/a | yes | -| project\_id | The project ID to host the cluster in | string | n/a | yes | -| region | The region to host the cluster in | string | n/a | yes | -| subnetwork | The subnetwork to host the cluster in | string | n/a | yes | -| zones | The zone to host the cluster in (required if is a zonal cluster) | list | n/a | yes | +|------|-------------|------|---------|:--------:| +| cluster\_name\_suffix | A suffix to append to the default cluster name | `string` | `""` | no | +| ip\_range\_pods | The secondary ip range to use for pods | `any` | n/a | yes | +| ip\_range\_services | The secondary ip range to use for services | `any` | n/a | yes | +| network | The VPC network to host the cluster in | `any` | n/a | yes | +| project\_id | The project ID to host the cluster in | `any` | n/a | yes | +| region | The region to host the cluster in | `any` | n/a | yes | +| registry\_project\_ids | Project names for GCR registries | `list(string)` | n/a | yes | +| subnetwork | The subnetwork to host the cluster in | `any` | n/a | yes | +| zones | The zone to host the cluster in (required if is a zonal cluster) | `list(string)` | n/a | yes | ## Outputs | Name | Description | |------|-------------| -| ca\_certificate | | -| client\_token | | +| ca\_certificate | n/a | +| client\_token | n/a | | cluster\_name | Cluster name | | ip\_range\_pods | The secondary IP range used for pods | | ip\_range\_services | The secondary IP range used for services | -| kubernetes\_endpoint | | -| location | | +| kubernetes\_endpoint | n/a | +| location | n/a | | master\_kubernetes\_version | The master Kubernetes version | -| network | | -| project\_id | | -| region | | -| service\_account | The service account to default running nodes as if not overridden in `node_pools`. | -| subnetwork | | +| network | n/a | +| project\_id | n/a | +| region | n/a | +| service\_account | The default service account used for running nodes. | +| subnetwork | n/a | | zones | List of zones in which the cluster resides | -[^]: (autogen_docs_end) + To provision this example, run the following from within this directory: - `terraform init` to get the plugins diff --git a/modules/acm/README.md b/modules/acm/README.md index 2daf23891..f9207a51b 100644 --- a/modules/acm/README.md +++ b/modules/acm/README.md @@ -111,4 +111,4 @@ data "google_client_config" "default" {} | git\_creds\_public | Public key of SSH keypair to allow the Anthos Config Management Operator to authenticate to your Git repository. | | wait | An output to use when you want to depend on cmd finishing | - + diff --git a/modules/fleet-membership/README.md b/modules/fleet-membership/README.md index 24a506c23..9b1fdf6f5 100644 --- a/modules/fleet-membership/README.md +++ b/modules/fleet-membership/README.md @@ -39,4 +39,4 @@ To deploy this config: | cluster\_membership\_id | The ID of the hub membership | | wait | An output to use when you want to depend on registration finishing | - + diff --git a/modules/hub-legacy/README.md b/modules/hub-legacy/README.md index 999f8113d..0a5d5debd 100644 --- a/modules/hub-legacy/README.md +++ b/modules/hub-legacy/README.md @@ -56,4 +56,4 @@ To deploy this config: |------|-------------| | wait | An output to use when you want to depend on registration finishing | - +