HashiConf Last chance to register for our cloud conference October 10-12. Register today
Waypoint
Waypoint Integrations
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 9 months ago

Docker Task

Launch a Docker container as a task.

If a Docker server is available (either locally or via environment variables such as "DOCKER_HOST"), then it will be used to start the container.

Examples

task {
  use "docker" {
        force_pull = true
  }
}

Parameters

10 Results

  • 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
  • debug_containersOptionalbool
  • force_pullOptionalbool
  • 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

    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.

  • resourcesOptionalcategory

    The resources that the tasks should use.

    • resources.cpuOptionalint64

      The cpu shares that the tasks should use

    • resources.memoryOptionalstring

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

  • static_environmentOptionalmap of string to string

    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.

Outputs

1 Result

  • idstring