From e47242b5c8eb052452187acd9a3000bca0ceb2bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wiktor=20Niesiob=C4=99dzki?= Date: Sun, 29 Jan 2023 11:02:47 +0100 Subject: [PATCH] tfdoc --- modules/gke-cluster/README.md | 34 ++++++++++++++++------------------ modules/gke-hub/README.md | 2 +- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/modules/gke-cluster/README.md b/modules/gke-cluster/README.md index 0ba75cd61..1a6b611f9 100644 --- a/modules/gke-cluster/README.md +++ b/modules/gke-cluster/README.md @@ -96,33 +96,31 @@ module "cluster-autopilot" { } # tftest modules=1 resources=1 inventory=autopilot.yaml ``` - - ## Variables | name | description | type | required | default | |---|---|:---:|:---:|:---:| -| [location](variables.tf#L117) | Cluster zone or region. | string | ✓ | | -| [name](variables.tf#L174) | Cluster name. | string | ✓ | | -| [project_id](variables.tf#L200) | Cluster project id. | string | ✓ | | -| [vpc_config](variables.tf#L217) | VPC-level configuration. | object({…}) | ✓ | | +| [location](variables.tf#L118) | Cluster zone or region. | string | ✓ | | +| [name](variables.tf#L175) | Cluster name. | string | ✓ | | +| [project_id](variables.tf#L201) | Cluster project id. | string | ✓ | | +| [vpc_config](variables.tf#L218) | VPC-level configuration. | object({…}) | ✓ | | | [cluster_autoscaling](variables.tf#L17) | Enable and configure limits for Node Auto-Provisioning with Cluster Autoscaler. | object({…}) | | null | | [description](variables.tf#L38) | Cluster description. | string | | null | | [enable_addons](variables.tf#L44) | Addons enabled in the cluster (true means enabled). | object({…}) | | {…} | -| [enable_features](variables.tf#L68) | Enable cluster-level features. Certain features allow configuration. | object({…}) | | {…} | -| [issue_client_certificate](variables.tf#L105) | Enable issuing client certificate. | bool | | false | -| [labels](variables.tf#L111) | Cluster resource labels. | map(string) | | null | -| [logging_config](variables.tf#L122) | Logging configuration. | list(string) | | ["SYSTEM_COMPONENTS"] | -| [maintenance_config](variables.tf#L128) | Maintenance window configuration. | object({…}) | | {…} | -| [max_pods_per_node](variables.tf#L151) | Maximum number of pods per node in this cluster. | number | | 110 | -| [min_master_version](variables.tf#L157) | Minimum version of the master, defaults to the version of the most recent official release. | string | | null | -| [monitoring_config](variables.tf#L163) | Monitoring components. | object({…}) | | {…} | -| [node_locations](variables.tf#L179) | Zones in which the cluster's nodes are located. | list(string) | | [] | -| [private_cluster_config](variables.tf#L186) | Private cluster configuration. | object({…}) | | null | -| [release_channel](variables.tf#L205) | Release channel for GKE upgrades. | string | | null | -| [tags](variables.tf#L211) | Network tags applied to nodes. | list(string) | | null | +| [enable_features](variables.tf#L68) | Enable cluster-level features. Certain features allow configuration. | object({…}) | | {…} | +| [issue_client_certificate](variables.tf#L106) | Enable issuing client certificate. | bool | | false | +| [labels](variables.tf#L112) | Cluster resource labels. | map(string) | | null | +| [logging_config](variables.tf#L123) | Logging configuration. | list(string) | | ["SYSTEM_COMPONENTS"] | +| [maintenance_config](variables.tf#L129) | Maintenance window configuration. | object({…}) | | {…} | +| [max_pods_per_node](variables.tf#L152) | Maximum number of pods per node in this cluster. | number | | 110 | +| [min_master_version](variables.tf#L158) | Minimum version of the master, defaults to the version of the most recent official release. | string | | null | +| [monitoring_config](variables.tf#L164) | Monitoring components. | object({…}) | | {…} | +| [node_locations](variables.tf#L180) | Zones in which the cluster's nodes are located. | list(string) | | [] | +| [private_cluster_config](variables.tf#L187) | Private cluster configuration. | object({…}) | | null | +| [release_channel](variables.tf#L206) | Release channel for GKE upgrades. | string | | null | +| [tags](variables.tf#L212) | Network tags applied to nodes. | list(string) | | null | ## Outputs diff --git a/modules/gke-hub/README.md b/modules/gke-hub/README.md index 17d7b427a..f3f31755e 100644 --- a/modules/gke-hub/README.md +++ b/modules/gke-hub/README.md @@ -307,7 +307,7 @@ module "hub" { | [clusters](variables.tf#L17) | Clusters members of this GKE Hub in name => id format. | map(string) | | {} | | [configmanagement_clusters](variables.tf#L24) | Config management features enabled on specific sets of member clusters, in config name => [cluster name] format. | map(list(string)) | | {} | | [configmanagement_templates](variables.tf#L31) | Sets of config management configurations that can be applied to member clusters, in config name => {options} format. | map(object({…})) | | {} | -| [features](variables.tf#L66) | Enable and configue fleet features. | object({…}) | | {…} | +| [features](variables.tf#L66) | Enable and configue fleet features. | object({…}) | | {…} | | [workload_identity_clusters](variables.tf#L92) | Clusters that will use Fleet Workload Identity. | list(string) | | [] | ## Outputs