Platform

Docker Platform

Parameters

the authentication information to log into the docker repository

Bearer tokens to be sent to Docker registry

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 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.

the command to run to start the application in the container

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.

always pull the docker container from the registry

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 (-).

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.

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.

a path within the container to store temporary data
docker will mount a tmpfs at this path

port that your service is running on in the container

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

Task

Docker Task

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"]`

A 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.

The amount of memory to use. Defined as '512MB', '44kB', etc.

environment variables to expose to the application
These variables are used to control all of a container's modes, such as configuring it to start a web app vs a background worker. These environment variables should not be common configuration variables normally set in `waypoint config`.

Builder

Docker Builder

build args to pass to docker for the build step
A map of key/value pairs passed as build-args to docker for the build step.

if set, use the buildkit builder from Docker

if set, the entrypoint binary won't be injected into the image
The entrypoint binary is what provides extended functionality such as logs and exec. If it is not injected at build time the expectation is that the image already contains it

The path to the Dockerfile.
Set this when the Dockerfile is not APP-PATH/Dockerfile

Do not use cache when building the image
Ensures a clean image build.

set target platform to build container if server is multi-platform capable
Must enable Docker buildkit to use the 'platform' flag.

the target build stage in a multi-stage Dockerfile
If buildkit is enabled unused stages will be skipped

Registry

Docker Registry

the authentication information to log into the docker repository
The format of this is base64-encoded JSON. The structure is the [`AuthConfig`](https://pkg.go.dev/github.com/docker/cli/cli/config/types#AuthConfig) structure used by Docker.
  WARNING: be very careful to not leak the authentication information by hardcoding it here. Use a helper function like `file()` to read the information from a file not stored in VCS

the image to push the local image to, fully qualified
this value must be the fully qualified name to the image. for example: gcr.io/waypoint-demo/demo

access the registry via http rather than https
This indicates that the registry should be accessed via http rather than https. Not recommended for production usage.

if set, the image will only be tagged locally and not pushed to a remote repository

password associated with username on the registry
This optional conflicts with encoded_auth and thusly only one can be used at a time. If both are used, encoded_auth takes precedence.

the tag for the new image
this is added to image to provide the full image reference

username to authenticate with the registry
This optional conflicts with encoded_auth and thusly only one can be used at a time. If both are used, encoded_auth takes precedence.

Interface

Examples

Developer

Waypoint

Integrations

Docker

v0.11.0

Components

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.

This integration is shipped in the core product and does not need to be installed.

Built-in

Our community conference is taking place in San Francisco and online October 10-12.

A curated collection of official, partner, and community Waypoint Integrations.