Container

Container defines a structure for creating Docker containers

Attributes

Attributes are the properties of a resource that can be used to configure it.

Attribute	Description
Networks network required []block NetworkAttachment	Network attaches the container to an existing network defined in a separate stanza. This block can be specified multiple times to attach the container to multiple networks.
Image image required block Image	Image defines a Docker image to use when creating the container.
Entrypoint entrypoint []string	Entrypoint for the container, if not set, Jumppad starts the container using the entrypoint defined in the Docker image.
Command command []string	Command allows you to specify a command to execute when starting a container. Command is specified as an array of strings, each part of the command is a separate string. For example, to start a container and follow logs at /dev/null the following command could be used. command = [ "tail", "-f", "/dev/null" ]
Environment environment map[string]string	Allows you to set environment variables in the container. environment = { PATH = "/user/local/bin" }
Labels labels map[string]string	Labels to apply to the container
Volumes volume required []block Volume	A volume allows you to specify a local volume which is mounted to the container when it is created. This stanza can be specified multiple times. volume { source = "./" destination = "/files" }
Ports port required []block Port	A port stanza allows you to expose container ports on the local network or host. This stanza can be specified multiple times. port { local = 80 remote = 80 ost = 8080 }
PortRanges port_range required []block PortRange	A port_range stanza allows you to expose a range of container ports on the local network or host. This stanza can be specified multiple times. The following example would create 11 ports from 80 to 90 (inclusive) and expose them to the host machine. port_range { range = "80-90" enable_host = true }
DNS dns []string
Privileged privileged bool	Should the container run in Docker privileged mode?
Capabilities capabilities block Capabilities
MaxRestartCount max_restart_count int	The maximum number of times a container will be restarted when it exits with a status code other than 0
Resources resources block Resources	Define resource constraints for the container
HealthCheck health_check HealthCheckContainer	Define a health check for the container, the resource will only be marked as successfully created when the health check passes.
RunAs run_as block User	Allows the container to be run as a specific user or group.

Computed Attributes

These attributes are computed when the config is parsed and applied, and are therefor only known at parsetime or runtime.

Attribute	Description
Meta ID meta.id string	The full ID of the resource e.g. `resource.type.name`. This is computed from the full resource path: resource "type" "name" { ... }
Meta Type meta.type string	The type of the resource. This taken from the type label of the resource definition. resource "type" "name" { ... }
Meta Name meta.name string	The name of the resource. This taken from the name label of the resource definition. resource "type" "name" { ... }
ContainerName container_name string	Fully qualified resource name for the container, this value can be used to access the container from within the Docker network. `container_name` is also the name of the created Docker container. name.container.local.jmpd.in

Examples

Minimal Example

resource "container" "unique_name" {
    network {
        id         = resource.network.cloud.meta.id
        ip_address = "10.16.0.203"
        aliases    = ["my_unique_name_ip_address"]
    }

    image {
        name = "consul:1.6.1"
    }
}

Full Example

resource "container" "unique_name" {
    depends_on = ["resource.container.another"]

    network {
        id         = resource.network.cloud.meta.id
        ip_address = "10.16.0.200"
        aliases    = ["my_unique_name_ip_address"]
    }

    image {
        name     = "consul:1.6.1"
        username = "repo_username"
        password = "repo_password"
    }

    command = [
        "consul",
        "agent"
    ]

    environment = {
        CONSUL_HTTP_ADDR = "http://localhost:8500"
    }

    volume {
        source      = "./config"
        destination = "/config"
    }

    port {
        local  = 8500
        remote = 8500
        host   = 18500
    }

    port_range {
        range       = "9000-9002"
        enable_host = true
    }

    privileged = false
}