Docker

The Docker plugin can be used to build and publish images to the Docker registry using Docker-in-Docker. The following pipeline configuration uses the Docker plugin to build and publish Docker images.

  • Example configuration builds and publishes an image using a Dockerfile in the root of your git repository. The docker context also defaults to the root of your git repository.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    
    kind: pipeline
    name: default
    
    steps:
    - name: docker  
      image: plugins/docker
      settings:
        username: kevinbacon
        password: pa55word
        repo: foo/bar
        tags:
        - latest
    
  • Example configuration using multiple tags:

     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    
    steps:
    - name: docker  
      image: plugins/docker
      settings:
        username: kevinbacon
        password: pa55word
        repo: foo/bar
        tags:
          - latest
          - '1.0.1'
          - '1.0'
    
  • Example configuration uses a .tags file, a comma-separate list of tags, to dynamically configure tags. The plugin automatically loads this file if it exists.

     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    
    steps:
    - name: build
      image: golang
      commands:
        - go build
        - go test
        - echo -n "5.2.6,5.2.4" > .tags
    
    - name: docker  
      image: plugins/docker
      settings:
        username: kevinbacon
        password: pa55word
        repo: foo/bar
    
  • Example configuration using build arguments:

     5
     6
     7
     8
     9
    10
    11
    12
    13
    
    steps:
    - name: docker  
      image: plugins/docker
      settings:
        username: kevinbacon
        password: pa55word
        repo: foo/bar
        build_args:
          - HTTP_PROXY=http://yourproxy.com
    
  • Example configuration passing secrets as build arguments:

     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    
    steps:
      - name: build-image
        image: plugins/docker
        environment:
          TOKEN:
            from_secret: one_of_the_tokens
        settings:
          username: kevinbacon
          password: pa55word
          repo: foo/bar
          build_args_from_env:
            - TOKEN
    
  • Example configuration using alternate Dockerfile:

     4
     5
     6
     7
     8
     9
    10
    11
    
    steps:
    - name: docker  
      image: plugins/docker
      settings:
        username: kevinbacon
        password: pa55word
        repo: foo/bar
        dockerfile: path/to/Dockerfile
    
  • Example configuration using a custom registry:

     4
     5
     6
     7
     8
     9
    10
    11
    
    steps:
    - name: docker  
      image: plugins/docker
      settings:
        username: kevinbacon
        password: pa55word
        repo: index.company.com/foo/bar
        registry: index.company.com
    

Secrets

It is considered best practice to source sensitive configuration parameters from secrets. The following example demonstrates how you can source the username and password from secrets:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
kind: pipeline
name: default

steps:
- name: docker  
  image: plugins/docker
  settings:
    username:
      from_secret: docker_username
    password:
      from_secret: docker_password
    repo: foo/bar
    tags:
    - latest

Autotag

The Docker plugin can be configured to automatically tag your images. When this feature is enabled and the event type is tag, the plugin will automatically tag the image using the standard major, minor, release convention. For example:

  • v1.0.0 produces docker tags 1, 1.0, 1.0.0
  • v1.0.0-rc.1 produces docker tags 1.0.0-rc.1

When the event type is push and the target branch is your default branch (e.g. master) the plugin will automatically tag the image as latest. All other event types and branches are ignored.

Example configuration:

1
2
3
4
5
6
7
8
steps:
- name: docker  
  image: plugins/docker
  settings:
    repo: foo/bar
    auto_tag: true
    username: kevinbacon
    password: pa55word

Example configuration with tag suffix:

1
2
3
4
5
6
7
8
9
steps:
- name: docker  
  image: plugins/docker
  settings:
    repo: foo/bar
    auto_tag: true
    auto_tag_suffix: linux-amd64
    username: kevinbacon
    password: pa55word

Please note that auto-tagging is intentionally simple and opinionated. We are not accepting pull requests at this time to further customize the logic.

Parameters

  • registry
    authenticates to this registry
  • username
    authenticates with this username
  • password
    authenticates with this password
  • repo
    repository name for the image
  • tags
    repository tag for the image
  • dockerfile
    dockerfile to be used, defaults to Dockerfile
  • dry_run
    boolean if the docker image should be pushed at the end
  • purge
    boolean if cleanup of the docker image should be done at the end
  • context
    the context path to use, defaults to root of the git repo
  • target
    the build target to use, must be defined in the docker file
  • force_tag=false
    replace existing matched image tags
  • insecure=false
    enable insecure communication to this registry
  • mirror
    use a mirror registry instead of pulling images directly from the central Hub
  • bip=false
    use for pass bridge ip
  • custom_dns
    set custom dns servers for the container
  • custom_dns_search
    docker daemon dns search domains
  • storage_driver
    supports aufs, overlay or vfs drivers
  • storage_path
    docker daemon storage path
  • build_args
    pass custom arguments to docker build
  • build_args_from_env
    pass the envvars as custom arguments to docker build
  • auto_tag=false
    generate tag names automatically based on git branch and git tag
  • auto_tag_suffix
    generate tag names with this suffix
  • debug, launch_debug
    launch the docker daemon in verbose debug mode
  • mtu
    docker daemon custom mtu setting
  • ipv6
    docker daemon IPv6 networking
  • experimental
    docker daemon Experimental mode
  • daemon_off
    don’t start the docker daemon
  • cache_from
    images to consider as cache sources
  • squash
    squash the layers at build time
  • pull_image
    force pull base image at build time
  • compress
    compress the build context using gzip
  • custom_labels
    additional k=v labels
  • label_schema
    label-schema labels
  • email
    docker email
  • no_cache
    do not use cached intermediate containers
  • add_host
    additional host:IP mapping

Common Problems

Missing Username or Password

If the registry username or password are missing you will see the below entry in your pipeline logs. The most common root cause for this issue is incorrectly configuration secrets.

Registry credentials or Docker config not provided. Guest mode enabled.

Invalid Username or Password

If the registry username and password are invalid you will see the below entry in your pipeline logs. The most common root cause for this issue is copy / paste problems when creating secrets, such as newlines or special characters being accidentally copied with the secret string.

level=fatal msg="Error authenticating: exit status 1"