cloud-foundation-fabric/modules/artifact-registry/README.md

44 lines
1.7 KiB
Markdown
Raw Normal View History

2020-05-26 03:03:15 -07:00
# Google Cloud Artifact Registry Module
This module simplifies the creation of repositories using Google Cloud Artifact Registry.
Note: Artifact Registry is still in beta, hence this module currently uses the beta provider.
## Example
```hcl
module "docker_artifact_registry" {
source = "./modules/artifact-registry"
project_id = "myproject"
location = "europe-west1"
format = "DOCKER"
id = "myregistry"
iam = {
2020-05-26 03:03:15 -07:00
"roles/artifactregistry.admin" = ["group:cicd@example.com"]
}
}
# tftest modules=1 resources=2
2020-05-26 03:03:15 -07:00
```
<!-- BEGIN TFDOC -->
2020-05-26 03:03:15 -07:00
## Variables
| name | description | type | required | default |
|---|---|:---:|:---:|:---:|
| [id](variables.tf#L35) | Repository id. | <code>string</code> | ✓ | |
2022-01-22 04:34:35 -08:00
| [project_id](variables.tf#L52) | Registry project id. | <code>string</code> | ✓ | |
| [description](variables.tf#L17) | An optional description for the repository. | <code>string</code> | | <code>&#34;Terraform-managed registry&#34;</code> |
| [format](variables.tf#L23) | Repository format. One of DOCKER or UNSPECIFIED. | <code>string</code> | | <code>&#34;DOCKER&#34;</code> |
2022-01-22 04:34:35 -08:00
| [iam](variables.tf#L29) | IAM bindings in {ROLE => [MEMBERS]} format. | <code>map&#40;list&#40;string&#41;&#41;</code> | | <code>&#123;&#125;</code> |
| [labels](variables.tf#L40) | Labels to be attached to the registry. | <code>map&#40;string&#41;</code> | | <code>&#123;&#125;</code> |
| [location](variables.tf#L46) | Registry location. Use `gcloud beta artifacts locations list' to get valid values. | <code>string</code> | | <code>null</code> |
2020-05-26 03:03:15 -07:00
## Outputs
| name | description | sensitive |
|---|---|:---:|
| [id](outputs.tf#L17) | Repository id. | |
| [name](outputs.tf#L22) | Repository name. | |
2020-05-26 03:03:15 -07:00
<!-- END TFDOC -->