diff --git a/README.md b/README.md index 628db0f..4286a1e 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,4 @@ -terraform-nomad-base -========= - -Terraform module to deploy nomad jobs. Optionally, this module can deploy csi volumes, consul kv, and consul intentions associated to the job(s). - -## Requirements - -No requirements. - -## Providers - -| Name | Version | -|------|---------| -| [consul](#provider\_consul) | n/a | -| [nomad](#provider\_nomad) | n/a | - -## Modules - -No modules. - -## Resources - -| Name | Type | -|------|------| -| [consul_intention.this](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/resources/intention) | resource | -| [consul_key_prefix.this](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/resources/key_prefix) | resource | -| [nomad_external_volume.this](https://registry.terraform.io/providers/hashicorp/nomad/latest/docs/resources/external_volume) | resource | -| [nomad_job.this](https://registry.terraform.io/providers/hashicorp/nomad/latest/docs/resources/job) | resource | -| [nomad_volume.this](https://registry.terraform.io/providers/hashicorp/nomad/latest/docs/resources/volume) | resource | - -## Inputs - -| Name | Description | Type | Default | Required | -|------|-------------|------|---------|:--------:| -| [consul\_intentions](#input\_consul\_intentions) | List of intentions associated with the job(s) | 
map(object({
    source_name      = string
    destination_name = string
    action           = string
  }))
| `{}` | no | -| [consul\_kv](#input\_consul\_kv) | List key/value pairs to put at a specific prefix (mainly for traefik) | `map(any)` | `{}` | no | -| [jobs](#input\_jobs) | The list of jobs to deploy | `map(string)` | `{}` | no | -| [nfs\_volumes](#input\_nfs\_volumes) | List of nfs volumes associated to the job(s) | 
map(object({
    type       = string
    plugin_id  = string
    namespace  = string
    capability = map(string)
    context    = map(string)
    mount_options = object({
      fs_type     = string
      mount_flags = list(string)
    })
  }))
| `{}` | no | -| [volumes](#input\_volumes) | List of volumes associated to the job(s) | 
map(object({
    type         = string
    plugin_id    = string
    namespace    = string
    capacity_min = string
    capacity_max = string
    capability   = map(string)
    parameters   = map(string)
    secrets      = map(string)
  }))
| `{}` | no | - -## Outputs - -No outputs. - + ### Requirements No requirements.