|
1 | 1 | # terraform-google-project |
2 | | -terraform-google-project |
| 2 | + |
| 3 | +The terraform module for creation and management of a GCP project with normalized name and labels. |
| 4 | + |
| 5 | +## Usage |
| 6 | + |
| 7 | +```hcl |
| 8 | +module "my_awesome_project" { |
| 9 | + source = "git::https://github.com/SweetOps/terraform-google-project.git?ref=master" |
| 10 | + name = "awesome" |
| 11 | + stage = "production" |
| 12 | + namespace = "sweetops" |
| 13 | +} |
| 14 | +``` |
| 15 | + |
| 16 | +## Inputs |
| 17 | + |
| 18 | + |
| 19 | +| Name | Description | Type | Default | Required | |
| 20 | +|:---------------------------|:------------------------------------------------------------------------------------------------|:------:|:---------:|:--------:| |
| 21 | +| name | Solution name, e.g. 'app' or 'jenkins' | string | n/a | yes | |
| 22 | +| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | n/a | yes | |
| 23 | +| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | n/a | yes | |
| 24 | +| attributes | Additional attributes (e.g. `1`) | list | `[]` | no | |
| 25 | +| auto_create_network | Create the 'default' network automatically | string | `"true"` | no | |
| 26 | +| context | Default context to use for passing state between label invocations | map | `{}` | no | |
| 27 | +| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `"-"` | no | |
| 28 | +| enable_deletion_protection | If true, the Terraform resource can be deleted without deleting the Project via the Google API. | string | `"false"` | no | |
| 29 | +| enabled | Set to false to prevent the module from creating any resources | string | `"true"` | no | |
| 30 | +| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `""` | no | |
| 31 | +| folder_id | The numeric ID of the folder this project should be created under | string | `""` | no | |
| 32 | +| org_id | The numeric ID of the organization this project belongs to | string | `""` | no | |
| 33 | +| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map | `{}` | no | |
| 34 | + |
| 35 | +## Outputs |
| 36 | + |
| 37 | +| Name | Description | |
| 38 | +|:-------|:--------------------------------------| |
| 39 | +| name | The project ID | |
| 40 | +| number | The numeric identifier of the project | |
0 commit comments