terraform-docker-module

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

terraform-docker-module

★ 15 Open GitHub ↗

Module to create & maintain docker resources from terraform

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Terraform Docker Module

## Overview

Terraform docker module is a module to help docker maintenance over terraform. 
It should replace other means of docker maintenance like docker-compose.

There are several advantages of maintaining docker on terraform.

* Infrastructure as code.
* CI/CD. Many CI tools offers some way to automate terraform execution.
* Remote execution. You don't need to manually ssh into servers.

This module uses under the hood [Docker Provider](https://www.terraform.io/docs/providers/docker/index.html).

Example:

```hcl
provider "docker" {
  host = "tcp://192.168.0.100:2375/"
}

module "proxy" {
 source = "alinefr/module/docker"
 version = "<add latest version>"

image = "masnagam/nginx-proxy:latest"
  container_name = "proxy"
  restart_policy = "always"
  docker_networks = {
    "proxy-tier" = {
      ipam_config = {
        aux_address = {}
        gateway = "10.0.20.1"
        subnet = "10.0.20.0/24"
      }
    }
  }
  ports = [
    {
      internal = 80
      external = 80
      protocol = "tcp"
    },
    {
      internal = 443
      external = 443
      protocol = "tcp"
    }
  ]
  named_volumes = {
    "nginx_confs" = {
      container_path = "/etc/nginx/conf.d"
      read_only = false
      create = true
    },
    "nginx_html" = {
      container_path = "/var/www/html"
      read_only = false
      create = true
    }
  }
  host_paths = {
    "/media/letsencrypt/etc/letsencrypt/live" = {
      container_path = "/etc/nginx/certs"
      read_only = false
    },
    "/media/letsencrypt/etc/letsencrypt/archive" = {
      container_path = "/etc/nginx/archive"
      read_only = false
    },
    "/var/run/docker.sock" = {
      container_path = "/tmp/docker.sock"
      read_only = true
    }
  }
  capabilities = {
    add = ["NET_ADMIN"]
    drop = []
  }
  networks_advanced = {
    name = "proxy-tier"
    ipv4_address = "10.0.20.100"
    ipv6_address = null
    aliases = null
  }
}

module "letsencrypt-companion" {
 source = "alinefr/module/docker"
 version = "<add latest version>"

image = "jrcs/letsencrypt-nginx-proxy-companion"
  container_name = "letsencrypt-companion"
  restart_policy = "always"
  volumes_from_containers = [
      "proxy"
  ]
  host_paths = {
    "/var/run/docker.sock" = {
      container_path = "/var/run/docker.sock"
      read_only = true
    }
  }
  networks_advanced = {
    name = "proxy-tier"
    ipv4_address = "10.0.20.101"
    ipv6_address = null
    aliases = null
  }
}
```

## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.4 |
| <a name="requirement_docker"></a> [docker](#requirement\_docker) | ~> 3.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_docker"></a> [docker](#provider\_docker) | ~> 3.0 |

## Modules

No modules.

## Resources

| Name | Type |
|------|------|
| [docker_container.default](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs/resources/container) | resource |
| [docker_image.default](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs/resources/image) | resource |
| [docker_network.default](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs/resources/network) | resource |
| [docker_volume.default](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs/resources/volume) | resource |
| [docker_registry_image.default](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs/data-sources/registry_image) | data source |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_capabilities"></a> [capabilities](#input\_capabilities) | Add or drop container capabilities | <pre>object({ add = list(string) drop = list(string) })</pre> | `null` | no |
| <a name="input_command"></a> [command](#input\_command) | Override the default command | `list(string)` | `null` | no |
| <a name="input_container_name"></a> [container\_name](#input\_container\_name) | Custom container name | `string` | `null` | no |
| <a name="input_devices"></a> [devices](#input\_devices) | Device mappings | <pre>map(object({ container_path = string permissions = string }))</pre> | `{}` | no |
| <a name="input_dns"></a> [dns](#input\_dns) | Set custom dns servers for the container | `list(string)` | `null` | no |
| <a name="input_docker_networks"></a> [docker\_networks](#input\_docker\_networks) | List of custom networks to create<pre>hcl docker_networks = [ { name = "proxy-tier" ipam_config = { aux_address = {} gateway = "10.0.0.1" subnet = "10.0.0.0/24" } } ]</pre> | `any` | `[]` | no |
| <a name="input_entrypoint"></a> [entrypoint](#input\_entrypoint) | Override the default entrypoint | `list(string)` | `null` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | Add environment variables | `map(string)` | `null` | no |
| <a name="input_existing_image"></a> [existing\_image](#input\_existing\_image) | Specify an existing image from another module | `string` | `null` | no |
| <a name="input_healthcheck"></a> [healthcheck](#input\_healthcheck) | Test to check if container is healthy | <pre>object({ interval = string retries = number start_period = string test = list(string) timeout = string })</pre> | `null` | no |
| <a name="input_host_paths"></a> [host\_paths](#input\_host\_paths) | Mount host paths | <pre>map(object({ container_path = string read_only = bool }))</pre> | `{}` | no |
| <a name="input_hostname"></a> [hostname](#input\_hostname) | Set docker hostname | `string` | `null` | no |
| <a name="input_image"></a> [image](#input\_image) | Specify the image to start the container from. Can either be a repository/tag or a partial image ID | `string` | `null` | no |
| <a name="input_init"></a> [init](#input\_init) | If init process should be used as the PID 1 in the container | `bool` | `false` | no |
| <a name="input_named_volumes"></a> [named\_volumes](#input\_named\_volumes) | Mount named volumes | <pre>map(object({ container_path = string read_only = bool create = bool }))</pre> | `{}` | no |
| <a name="input_network_mode"></a> [network\_mode](#input\_network\_mode) | Specify a custom network mode | `string` | `null` | no |
| <a name="input_networks_advanced"></a> [networks\_advanced](#input\_networks\_advanced) | Advanced network options for the container<pre>hcl networks_advanced = [ { name = "proxy-tier" ipv4_address = "10.0.0.14" }, { name = "media-tier" ipv4_address = "172.0.0.14" } ]</pre> | `any` | `null` | no |
| <a name="input_ports"></a> [ports](#input\_ports) | Expose ports | <pre>list(object({ internal = number external = number protocol = string }))</pre> | `null` | no |
| <a name="input_privileged"></a> [privileged](#input\_privileged) | Give extended privileges to this container | `bool` | `false` | no |
| <a name="input_restart_policy"></a> [restart\_policy](#input\_restart\_policy) | Restart policy. Default: no | `string` | `"no"` | no |
| <a name="input_volumes_from_containers"></a> [volumes\_from\_containers](#input\_volumes\_from\_containers) | Mount volumes from another container | `list(any)` | `null` | no |
| <a name="input_working_dir"></a> [working\_dir](#input\_working\_dir) | Working directory inside the container | `string` | `null` | no |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_capabilities"></a> [capabilities](#output\_capabilities) | n/a |
| <a name="output_command"></a> [command](#output\_command) | n/a |
| <a name="output_container_name"></a> [container\_name](#output\_container\_name) | n/a |
| <a name="output_devices"></a> [devices](#output\_devices) | n/a |
| <a name="output_dns"></a> [dns](#output\_dns) | n/a |
| <a name="output_docker_networks"></a> [docker\_networks](#output\_docker\_networks) | n/a |
| <a name="output_docker_volumes"></a> [docker\_volumes](#output\_docker\_volumes) | n/a |
| <a name="output_entrypoint"></a> [entrypoint](#output\_entrypoint) | n/a |
| <a name="output_environment"></a> [environment](#output\_environment) | n/a |
| <a name="output_healthcheck"></a> [healthcheck](#output\_healthcheck) | n/a |
| <a name="output_hostname"></a> [hostname](#output\_hostname) | n/a |
| <a name="output_image_id"></a> [image\_id](#output\_image\_id) | n/a |
| <a name="output_image_name"></a> [image\_name](#output\_image\_name) | n/a |
| <a name="output_init"></a> [init](#output\_init) | n/a |
| <a name="output_network_mode"></a> [network\_mode](#output\_network\_mode) | n/a |
| <a name="output_networks_advanced"></a> [networks\_advanced](#output\_networks\_advanced) | n/a |
| <a name="output_ports"></a> [ports](#output\_ports) | n/a |
| <a name="output_privileged"></a> [privileged](#output\_privileged) | n/a |
| <a name="output_restart"></a> [restart](#output\_restart) | n/a |
| <a name="output_volumes"></a> [volumes](#output\_volumes) | n/a |
| <a name="output_working_dir"></a> [working\_dir](#output\_working\_dir) | n/a |

terraform-docker-module

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README