HashiCorp Developer AI Private beta now available Sign up today
Waypoint
Waypoint Integrations
Docker Pull

@hashicorp

The Docker Pull plugin pulls a Docker image from an existing Docker repository, and wraps the existing image entrypoint with the Waypoint entrypoint.

  • Official
  • Built-in

Updated 9 months ago

Docker Pull Builder

Archive Notice

This integration relates to a legacy version of Waypoint and is no longer actively maintained.
Read the blog
(opens in new tab)

Use an existing, pre-built Docker image.

This builder will automatically inject the Waypoint entrypoint. You can disable this with the "disable_entrypoint" configuration.

If you wish to rename or retag an image, use this along with the "docker" registry option which will rename/retag the image and then push it to the specified registry.

If Docker isn't available (the Docker daemon isn't running or a DOCKER_HOST isn't set), a daemonless solution will be used instead.

If "disable_entrypoint" is set to true and the Waypoint configuration has no registry, this builder will not physically pull the image. This enables Waypoint to work in environments where the image is built outside of Waypoint (such as in a CI pipeline).

Interface

  • Input: component.Source
  • Output: docker.Image

Examples

build {
  use "docker-pull" {
    image = "gcr.io/my-project/my-image"
    tag   = "abcd1234"
  }
}

Parameters

13 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

  • disable_entrypointOptionalbool

    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

  • encoded_authOptionalstring

    the authentication information to log into the docker repository 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

  • imageRequiredstring

    The image to pull. This should NOT include the tag (the value following the ':' in a Docker image). Use tag to define the image tag.

  • tagRequiredstring

    The tag of the image to pull.

Outputs

4 Results

  • architecturestring
  • imagestring
  • locationdocker.isImage_Location
  • tagstring