-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(anthos-attached-cluster): document modules (#714)
- Loading branch information
Showing
2 changed files
with
72 additions
and
0 deletions.
There are no files selected for viewing
30 changes: 30 additions & 0 deletions
30
anthos-attached-clusters/modules/attached-install-manifest/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Attached Install Manifest | ||
|
||
## Example usage | ||
|
||
``` | ||
module "attached_install_manifest" { | ||
source = "./attached-install-manifest" | ||
attached_cluster_name = CUSTER NAME | ||
attached_cluster_fleet_project = PROJECT ID | ||
gcp_location = LOCATION | ||
platform_version = VERSION | ||
} | ||
``` | ||
|
||
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
## Inputs | ||
|
||
| Name | Description | Type | Default | Required | | ||
|------|-------------|------|---------|:--------:| | ||
| attached\_cluster\_fleet\_project | GCP fleet project ID where the cluster will be attached | `string` | n/a | yes | | ||
| attached\_cluster\_name | Name for the attached cluster resource | `string` | n/a | yes | | ||
| gcp\_location | GCP location to create the attached resource in | `string` | `"us-west1"` | no | | ||
| platform\_version | Platform version of the attached cluster resource | `string` | `"1.28.8-gke.3"` | no | | ||
| temp\_dir | Directory name to temporarily write out the helm chart for bootstrapping the attach process | `string` | `""` | no | | ||
|
||
## Outputs | ||
|
||
No outputs. | ||
|
||
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
42 changes: 42 additions & 0 deletions
42
anthos-attached-clusters/modules/attached-install-mesh/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Attached Install Mesh | ||
|
||
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). | ||
|
||
## Example usage | ||
|
||
``` | ||
module "install-mesh" { | ||
source = "./attached-install-mesh" | ||
kubeconfig = kind_cluster.cluster.kubeconfig_path | ||
context = local.cluster_context | ||
fleet_id = data.google_project.project.project_id | ||
} | ||
``` | ||
|
||
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> | ||
## Inputs | ||
|
||
| Name | Description | Type | Default | Required | | ||
|------|-------------|------|---------|:--------:| | ||
| activate\_service\_account | Set to false to skip running `gcloud auth activate-service-account`. Optional. | `bool` | `true` | no | | ||
| asmcli\_download\_url | Custom asmcli download url. Optional. | `string` | `null` | no | | ||
| asmcli\_version | The asmcli version to download. Optional. | `string` | `"1.22"` | no | | ||
| context | The cluster contex. | `string` | n/a | yes | | ||
| fleet\_id | The fleet\_id. | `string` | n/a | yes | | ||
| gcloud\_download\_url | Custom gcloud download url. Optional. | `string` | `null` | no | | ||
| gcloud\_sdk\_version | The gcloud sdk version to download. Optional. | `string` | `"491.0.0"` | no | | ||
| jq\_download\_url | Custom jq download url. Optional. | `string` | `null` | no | | ||
| jq\_version | The jq version to download. Optional. | `string` | `"1.6"` | no | | ||
| kubeconfig | The kubeconfig path. | `string` | n/a | yes | | ||
| platform | Platform asmcli will run on. Valid values: linux [default], darwin. Optional. | `string` | `"linux"` | no | | ||
| service\_account\_key\_file | Path to service account key file to run `gcloud auth activate-service-account` with. Optional. | `string` | `""` | no | | ||
| use\_tf\_google\_credentials\_env\_var | Use `GOOGLE_CREDENTIALS` environment variable to run `gcloud auth activate-service-account` with. Optional. | `bool` | `false` | no | | ||
|
||
## Outputs | ||
|
||
| Name | Description | | ||
|------|-------------| | ||
| wait | An output to use when you want to depend on cmd finishing | | ||
|
||
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |