From 944fdd776eb68211a3e58648d1d2ebd9a12f0636 Mon Sep 17 00:00:00 2001 From: Peter Mikus Date: Fri, 1 Apr 2022 14:38:58 +0200 Subject: docs(terraform): Update docs Signed-off-by: Peter Mikus Change-Id: I6ff7572103b24b099281da173215fc1ae1cbf2c0 --- .../terraform-nomad-prometheus/README.md | 52 ++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 fdio.infra.terraform/terraform-nomad-prometheus/README.md (limited to 'fdio.infra.terraform/terraform-nomad-prometheus') diff --git a/fdio.infra.terraform/terraform-nomad-prometheus/README.md b/fdio.infra.terraform/terraform-nomad-prometheus/README.md new file mode 100644 index 0000000000..e0568c376c --- /dev/null +++ b/fdio.infra.terraform/terraform-nomad-prometheus/README.md @@ -0,0 +1,52 @@ + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 1.1.4 | +| [nomad](#requirement\_nomad) | >= 1.4.16 | + +## Providers + +| Name | Version | +|------|---------| +| [nomad](#provider\_nomad) | >= 1.4.16 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [nomad_job.nomad_job_prometheus](https://registry.terraform.io/providers/hashicorp/nomad/latest/docs/resources/job) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [auto\_promote](#input\_auto\_promote) | Specifies if the job should auto-promote to the canary version | `bool` | `true` | no | +| [auto\_revert](#input\_auto\_revert) | Specifies if the job should auto-revert to the last stable job | `bool` | `true` | no | +| [canary](#input\_canary) | Equal to the count of the task group allows blue/green depl. | `number` | `1` | no | +| [cpu](#input\_cpu) | CPU allocation | `number` | `2000` | no | +| [data\_dir](#input\_data\_dir) | Prometheus DISK allocation | `string` | `"/data"` | no | +| [datacenters](#input\_datacenters) | Specifies the list of DCs to be considered placing this task | `list(string)` |
[
"dc1"
]
| no | +| [group\_count](#input\_group\_count) | Specifies the number of the task groups running under this one | `number` | `4` | no | +| [job\_name](#input\_job\_name) | Specifies a name for the job | `string` | `"prometheus"` | no | +| [max\_parallel](#input\_max\_parallel) | Specifies the maximum number of updates to perform in parallel | `number` | `1` | no | +| [memory](#input\_memory) | Specifies the memory required in MB | `number` | `4096` | no | +| [pm\_version](#input\_pm\_version) | Prometheus version | `string` | `"2.33.1"` | no | +| [port](#input\_port) | Specifies the static TCP/UDP port to allocate | `number` | `9090` | no | +| [region](#input\_region) | Specifies the list of DCs to be considered placing this task | `string` | `"global"` | no | +| [service\_name](#input\_service\_name) | Specifies the name this service will be advertised in Consul | `string` | `"prometheus"` | no | +| [use\_canary](#input\_use\_canary) | Uses canary deployment | `bool` | `true` | no | +| [use\_host\_volume](#input\_use\_host\_volume) | Use Nomad host volume feature | `bool` | `true` | no | +| [vault\_secret](#input\_vault\_secret) | Set of properties to be able to fetch secret from vault. |
object({
use_vault_provider = bool,
vault_kv_policy_name = string,
vault_kv_path = string,
vault_kv_field_access_key = string,
vault_kv_field_secret_key = string
})
|
{
"use_vault_provider": false,
"vault_kv_field_access_key": "access_key",
"vault_kv_field_secret_key": "secret_key",
"vault_kv_path": "secret/data/prometheus",
"vault_kv_policy_name": "kv"
}
| no | +| [volume\_destination](#input\_volume\_destination) | Specifies where the volume should be mounted inside the task | `string` | `"/data/"` | no | +| [volume\_source](#input\_volume\_source) | The name of the volume to request | `string` | `"prod-volume-data1-1"` | no | + +## Outputs + +No outputs. + \ No newline at end of file -- cgit 1.2.3-korg