Docker

@hashicorp

The Docker plugin can build a Docker image of an application, push a Docker image to a remote registry, and/or deploy the Docker image to a Docker daemon. It also launches on-demand runners to do operations remotely.

Official
Built-in

Updated 5 months ago

GitHub
(opens in new tab)

Docker Platform

Deploy a container to Docker, local or remote.

Interface

Input: docker.Image
Output: docker.Deployment

Examples

deploy {
  use "docker" {
    command      = ["ps"]
    service_port = 3000
    static_environment = {
      "environment": "production",
      "LOG_LEVEL": "debug"
    }
  }
}

Parameters

Required only

20 Results

authOptionalcategory
the authentication information to log into the docker repository
- auth.authOptionalstring
- auth.emailOptionalstring
- auth.hostnameOptionalstring
  Hostname of Docker registry
- auth.identityTokenOptionalstring
  Token used to authenticate user
- auth.passwordOptionalstring
  Password of Docker registry account
- auth.registryTokenOptionalstring
  Bearer tokens to be sent to Docker registry
- auth.serverAddressOptionalstring
  Address of Docker registry
- auth.usernameOptionalstring
  Username of Docker registry account
bindsOptionallist of string
A 'source:destination' list of folders to mount onto the container from the host. A list of folders to mount onto the container from the host. The expected format for each string entry in the list is source:destination. So for example: `binds: ["host_folder/scripts:/scripts"]
client_configOptionaldocker.ClientConfig
client config for remote Docker engine this config block can be used to configure a remote Docker engine. By default Waypoint will attempt to discover this configuration using the environment variables: DOCKER_HOST to set the url to the docker server. DOCKER_API_VERSION to set the version of the API to reach, leave empty for latest. DOCKER_CERT_PATH to load the TLS certificates from. DOCKER_TLS_VERIFY to enable or disable TLS verification, off by default.
commandOptionallist of string
the command to run to start the application in the container
extra_portsOptionallist of uint
additional TCP ports the application is listening on to expose on the container Used to define and expose multiple ports that the application is listening on for the container in use. These ports will get merged with service_port when creating the container if defined.
force_pullOptionalbool
always pull the docker container from the registry
labelsOptionalmap of string to string
A map of key/value pairs to label the docker container with. A map of key/value pair(s), stored in docker as a string. Each key/value pair must be unique. Validiation occurs at the docker layer, not in Waypoint. Label keys are alphanumeric strings which may contain periods (.) and hyphens (-).
networksOptionallist of string
An list of strings with network names to connect the container to. A list of networks to connect the container to. By default the container will always connect to the waypoint network.
resourcesOptionalmap of string to string
A map of resources to configure the container with, such as memory or cpu limits. these options are used to configure the container used when deploying with docker. Currently, the supported resources are 'memory' and 'cpu' limits. The field 'memory' is expected to be defined as "512MB", "44kB", etc.
scratch_pathOptionalstring
a path within the container to store temporary data docker will mount a tmpfs at this path
service_portOptionaluint
port that your service is running on in the container
static_environmentOptionalmap of string to string
environment variables to expose to the application these environment variables should not be run of the mill configuration variables, use waypoint config for that. These variables are used to control over all container modes, such as configuring it to start a web app vs a background worker

Outputs

4 Results

containerstring
idstring
namestring
resource_stateopaqueany.Any