Skip to content

Commit 1fe90e9

Browse files
authored
chore: Add documentation for Inputs and Outputs for auth submodule (#865)
1 parent 062bd5e commit 1fe90e9

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

modules/auth/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,24 @@ provider "kubernetes" {
4545
token = module.gke_auth.token
4646
}
4747
```
48+
49+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
50+
## Inputs
51+
52+
| Name | Description | Type | Default | Required |
53+
|------|-------------|------|---------|:--------:|
54+
| cluster\_name | The name of the GKE cluster. | `string` | n/a | yes |
55+
| location | The location (region or zone) of the GKE cluster. | `string` | n/a | yes |
56+
| project\_id | The GCP project of the GKE cluster. | `string` | n/a | yes |
57+
| use\_private\_endpoint | Connect on the private GKE cluster endpoint | `bool` | `false` | no |
58+
59+
## Outputs
60+
61+
| Name | Description |
62+
|------|-------------|
63+
| cluster\_ca\_certificate | The cluster\_ca\_certificate value for use with the kubernetes provider. |
64+
| host | The host value for use with the kubernetes provider. |
65+
| kubeconfig\_raw | A kubeconfig file configured to access the GKE cluster. |
66+
| token | The token value for use with the kubernetes provider. |
67+
68+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)