chore: Add documentation for Inputs and Outputs for auth submodule (#865

)
terraform-google-modules · Apr 14, 2021 · 1fe90e9 · 1fe90e9
1 parent 062bd5e
commit 1fe90e9
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/modules/auth/README.md b/modules/auth/README.md
@@ -45,3 +45,24 @@ provider "kubernetes" {
   token                  = module.gke_auth.token
 }
 ```
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| cluster\_name | The name of the GKE cluster. | `string` | n/a | yes |
+| location | The location (region or zone) of the GKE cluster. | `string` | n/a | yes |
+| project\_id | The GCP project of the GKE cluster. | `string` | n/a | yes |
+| use\_private\_endpoint | Connect on the private GKE cluster endpoint | `bool` | `false` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| cluster\_ca\_certificate | The cluster\_ca\_certificate value for use with the kubernetes provider. |
+| host | The host value for use with the kubernetes provider. |
+| kubeconfig\_raw | A kubeconfig file configured to access the GKE cluster. |
+| token | The token value for use with the kubernetes provider. |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->