modulo
This commit is contained in:
Josuani Moranchel
70
README.md
70
README.md
@@ -10,25 +10,39 @@ Description of what the module does
|
||||
| Name | Version |
|
||||
|------|---------|
|
||||
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | >= 1.0 |
|
||||
| <a name="requirement_azurerm"></a> [azurerm](#requirement_azurerm) | =3.0.0 |
|
||||
## Providers
|
||||
|
||||
No providers.
|
||||
| Name | Version |
|
||||
|------|---------|
|
||||
| <a name="provider_azurerm"></a> [azurerm](#provider_azurerm) | 3.0.0 |
|
||||
## 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 |
|
||||
| <a name="module_default_label"></a> [default_label](#module_default_label) | git::https://gitlab.com/zulunity/terraform/modules/general/label.git | 0.0.0 |
|
||||
| <a name="module_secrets_label"></a> [secrets_label](#module_secrets_label) | git::https://gitlab.com/zulunity/terraform/modules/general/label.git | n/a |
|
||||
## Usage
|
||||
Basic usage of this module is as follows:
|
||||
```hcl
|
||||
module "example" {
|
||||
source = "<module-path>"
|
||||
|
||||
module "example" {
|
||||
source = "<module-path>"
|
||||
|
||||
# Required variables
|
||||
bgp_community =
|
||||
ddos_protection_plan =
|
||||
edge_zone =
|
||||
flow_timeout_in_minutes =
|
||||
subnets =
|
||||
|
||||
# Optional variables
|
||||
account = null
|
||||
attributes = []
|
||||
cloud_provider = null
|
||||
context = {
|
||||
account = null
|
||||
address_space = [
|
||||
"10.0.0.0/16"
|
||||
]
|
||||
attributes = []
|
||||
cloud_provider = null
|
||||
context = {
|
||||
"account": null,
|
||||
"additional_tag_map": {},
|
||||
"attributes": [],
|
||||
@@ -45,35 +59,53 @@ module "example" {
|
||||
"stage": null,
|
||||
"tags": {}
|
||||
}
|
||||
domain = null
|
||||
enabled = true
|
||||
environment = null
|
||||
name = "hi"
|
||||
namespace = null
|
||||
region = null
|
||||
stage = null
|
||||
tags = {}
|
||||
}
|
||||
dns_servers = [
|
||||
"10.0.0.4",
|
||||
"10.0.0.5"
|
||||
]
|
||||
domain = null
|
||||
enabled = true
|
||||
environment = null
|
||||
name = "hi"
|
||||
namespace = null
|
||||
region = null
|
||||
stage = null
|
||||
tags = {}
|
||||
virtual_network = "network"
|
||||
}
|
||||
```
|
||||
## Resources
|
||||
|
||||
No resources.
|
||||
| Name | Type |
|
||||
|------|------|
|
||||
| [azurerm_network_security_group.example](https://registry.terraform.io/providers/hashicorp/azurerm/3.0.0/docs/resources/network_security_group) | resource |
|
||||
| [azurerm_resource_group.example](https://registry.terraform.io/providers/hashicorp/azurerm/3.0.0/docs/resources/resource_group) | resource |
|
||||
| [azurerm_subnet.example](https://registry.terraform.io/providers/hashicorp/azurerm/3.0.0/docs/resources/subnet) | resource |
|
||||
| [azurerm_virtual_network.example](https://registry.terraform.io/providers/hashicorp/azurerm/3.0.0/docs/resources/virtual_network) | resource |
|
||||
## 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_address_space"></a> [address_space](#input_address_space) | El espacio de direcciones que se usa en la red virtual. Puede proporcionar más de un espacio de direcciones. | `list(string)` | <pre>[<br> "10.0.0.0/16"<br>]</pre> | no |
|
||||
| <a name="input_attributes"></a> [attributes](#input_attributes) | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no |
|
||||
| <a name="input_bgp_community"></a> [bgp_community](#input_bgp_community) | El atributo de comunidad BGP en formato <as-number>:<community-value>. | `number` | n/a | yes |
|
||||
| <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_ddos_protection_plan"></a> [ddos_protection_plan](#input_ddos_protection_plan) | configuración de un plan de protección contra ataques de denegación de servicio distribuido | <pre>map(object({<br> id = string #id de la configuración de un plan de protección contra ataques de denegación de servicio distribuido<br> enable = bool #se define si esta activado o no <br> }))</pre> | n/a | yes |
|
||||
| <a name="input_dns_servers"></a> [dns_servers](#input_dns_servers) | Lista de direcciones IP de servidores DNS | `list(string)` | <pre>[<br> "10.0.0.4",<br> "10.0.0.5"<br>]</pre> | no |
|
||||
| <a name="input_domain"></a> [domain](#input_domain) | TLD to use when deploying assets | `string` | `null` | no |
|
||||
| <a name="input_edge_zone"></a> [edge_zone](#input_edge_zone) | Especifica la zona perimetral dentro de la región de Azure en la que debe existir esta red virtual. Cambiar esto obliga a crear una nueva red virtual. | `string` | n/a | yes |
|
||||
| <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_flow_timeout_in_minutes"></a> [flow_timeout_in_minutes](#input_flow_timeout_in_minutes) | El tiempo de espera del flujo en minutos para la red virtual, que se usa para habilitar el seguimiento de conexiones para los flujos dentro de la máquina virtual. Los valores posibles están entre 4 y 30 minutos | `number` | n/a | yes |
|
||||
| <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_subnets"></a> [subnets](#input_subnets) | n/a | <pre>map(object({<br> name = string<br> address_space = string<br> resource_group_name = string<br> security_group = string<br> }))</pre> | n/a | yes |
|
||||
| <a name="input_tags"></a> [tags](#input_tags) | Additional tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no |
|
||||
| <a name="input_virtual_network"></a> [virtual_network](#input_virtual_network) | n/a | `string` | `"network"` | no |
|
||||
## Outputs
|
||||
|
||||
| Name | Description |
|
||||
|
||||
Reference in New Issue
Block a user