Skip to content

Commit 8fd4eaa

Browse files
authored
fix(anthos-attached-cluster): document modules (#714)
1 parent 909e4b6 commit 8fd4eaa

File tree

2 files changed

+72
-0
lines changed
  • anthos-attached-clusters/modules

2 files changed

+72
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Attached Install Manifest
2+
3+
## Example usage
4+
5+
```
6+
module "attached_install_manifest" {
7+
source = "./attached-install-manifest"
8+
attached_cluster_name = CUSTER NAME
9+
attached_cluster_fleet_project = PROJECT ID
10+
gcp_location = LOCATION
11+
platform_version = VERSION
12+
}
13+
```
14+
15+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
16+
## Inputs
17+
18+
| Name | Description | Type | Default | Required |
19+
|------|-------------|------|---------|:--------:|
20+
| attached\_cluster\_fleet\_project | GCP fleet project ID where the cluster will be attached | `string` | n/a | yes |
21+
| attached\_cluster\_name | Name for the attached cluster resource | `string` | n/a | yes |
22+
| gcp\_location | GCP location to create the attached resource in | `string` | `"us-west1"` | no |
23+
| platform\_version | Platform version of the attached cluster resource | `string` | `"1.28.8-gke.3"` | no |
24+
| temp\_dir | Directory name to temporarily write out the helm chart for bootstrapping the attach process | `string` | `""` | no |
25+
26+
## Outputs
27+
28+
No outputs.
29+
30+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Attached Install Mesh
2+
3+
Sample module to install [Google Cloud Service Mesh](https://cloud.google.com/products/service-mesh) on [GKE Attached Clusters](https://cloud.google.com/kubernetes-engine/multi-cloud/docs/attached).
4+
5+
## Example usage
6+
7+
```
8+
module "install-mesh" {
9+
source = "./attached-install-mesh"
10+
11+
kubeconfig = kind_cluster.cluster.kubeconfig_path
12+
context = local.cluster_context
13+
fleet_id = data.google_project.project.project_id
14+
}
15+
```
16+
17+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Inputs
19+
20+
| Name | Description | Type | Default | Required |
21+
|------|-------------|------|---------|:--------:|
22+
| activate\_service\_account | Set to false to skip running `gcloud auth activate-service-account`. Optional. | `bool` | `true` | no |
23+
| asmcli\_download\_url | Custom asmcli download url. Optional. | `string` | `null` | no |
24+
| asmcli\_version | The asmcli version to download. Optional. | `string` | `"1.22"` | no |
25+
| context | The cluster contex. | `string` | n/a | yes |
26+
| fleet\_id | The fleet\_id. | `string` | n/a | yes |
27+
| gcloud\_download\_url | Custom gcloud download url. Optional. | `string` | `null` | no |
28+
| gcloud\_sdk\_version | The gcloud sdk version to download. Optional. | `string` | `"491.0.0"` | no |
29+
| jq\_download\_url | Custom jq download url. Optional. | `string` | `null` | no |
30+
| jq\_version | The jq version to download. Optional. | `string` | `"1.6"` | no |
31+
| kubeconfig | The kubeconfig path. | `string` | n/a | yes |
32+
| platform | Platform asmcli will run on. Valid values: linux [default], darwin. Optional. | `string` | `"linux"` | no |
33+
| service\_account\_key\_file | Path to service account key file to run `gcloud auth activate-service-account` with. Optional. | `string` | `""` | no |
34+
| use\_tf\_google\_credentials\_env\_var | Use `GOOGLE_CREDENTIALS` environment variable to run `gcloud auth activate-service-account` with. Optional. | `bool` | `false` | no |
35+
36+
## Outputs
37+
38+
| Name | Description |
39+
|------|-------------|
40+
| wait | An output to use when you want to depend on cmd finishing |
41+
42+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)