84 lines
4.5 KiB
Markdown
84 lines
4.5 KiB
Markdown
<!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->
|
|
Terraform NAME Module
|
|
========================
|
|
|
|
## Overview
|
|
|
|
Description of what the module does
|
|
## Requirements
|
|
|
|
| Name | Version |
|
|
|------|---------|
|
|
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | >= 1.0 |
|
|
## Providers
|
|
|
|
No providers.
|
|
## Modules
|
|
|
|
| Name | Source | Version |
|
|
|------|--------|---------|
|
|
| <a name="module_default_label"></a> [default_label](#module_default_label) | git@gitlab.com:zulunity/terraform/modules/general/label.git | 0.0.0 |
|
|
## Usage
|
|
Basic usage of this module is as follows:
|
|
```hcl
|
|
module "example" {
|
|
source = "<module-path>"
|
|
|
|
# Optional variables
|
|
account = null
|
|
attributes = []
|
|
cloud_provider = null
|
|
context = {
|
|
"account": null,
|
|
"additional_tag_map": {},
|
|
"attributes": [],
|
|
"cloud_provider": null,
|
|
"delimiter": null,
|
|
"enabled": true,
|
|
"environment": null,
|
|
"id_length_limit": null,
|
|
"label_order": [],
|
|
"name": null,
|
|
"namespace": null,
|
|
"regex_replace_chars": null,
|
|
"region": null,
|
|
"stage": null,
|
|
"tags": {}
|
|
}
|
|
domain = null
|
|
enabled = true
|
|
environment = null
|
|
name = "hi"
|
|
namespace = null
|
|
region = null
|
|
stage = null
|
|
tags = {}
|
|
}
|
|
```
|
|
## Resources
|
|
|
|
No resources.
|
|
## Inputs
|
|
|
|
| Name | Description | Type | Default | Required |
|
|
|------|-------------|------|---------|:--------:|
|
|
| <a name="input_account"></a> [account](#input_account) | Name of the account being used (master, nonprod, prod, etc) | `string` | `null` | no |
|
|
| <a name="input_attributes"></a> [attributes](#input_attributes) | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no |
|
|
| <a name="input_cloud_provider"></a> [cloud_provider](#input_cloud_provider) | Cloud provider name if any | `string` | `null` | no |
|
|
| <a name="input_context"></a> [context](#input_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional_tag_map, which are merged. | <pre>object({<br> enabled = bool<br> namespace = string<br> cloud_provider = string<br> account = string<br> region = string<br> environment = string<br> stage = string<br> name = string<br> delimiter = string<br> attributes = list(string)<br> tags = map(string)<br> additional_tag_map = map(string)<br> regex_replace_chars = string<br> label_order = list(string)<br> id_length_limit = number<br> })</pre> | <pre>{<br> "account": null,<br> "additional_tag_map": {},<br> "attributes": [],<br> "cloud_provider": null,<br> "delimiter": null,<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_order": [],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "region": null,<br> "stage": null,<br> "tags": {}<br>}</pre> | no |
|
|
| <a name="input_domain"></a> [domain](#input_domain) | TLD to use when deploying assets | `string` | `null` | no |
|
|
| <a name="input_enabled"></a> [enabled](#input_enabled) | Set to false to prevent the module from creating any resources | `bool` | `true` | no |
|
|
| <a name="input_environment"></a> [environment](#input_environment) | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | `string` | `null` | no |
|
|
| <a name="input_name"></a> [name](#input_name) | Module name, e.g. 'app' or 'jenkins' | `string` | `"hi"` | no |
|
|
| <a name="input_namespace"></a> [namespace](#input_namespace) | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | `string` | `null` | no |
|
|
| <a name="input_region"></a> [region](#input_region) | AWS region to deploy asset into | `string` | `null` | no |
|
|
| <a name="input_stage"></a> [stage](#input_stage) | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
|
|
| <a name="input_tags"></a> [tags](#input_tags) | Additional tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no |
|
|
## Outputs
|
|
|
|
| Name | Description |
|
|
|------|-------------|
|
|
| <a name="output_context"></a> [context](#output_context) | Default label context |
|
|
| <a name="output_enabled"></a> [enabled](#output_enabled) | Whether or not the module is enabled |
|
|
| <a name="output_name"></a> [name](#output_name) | Name of the asset |
|
|
<!-- END_AUTOMATED_TF_DOCS_BLOCK --> |