Docker Image Resource
Tracks and builds Docker images.
Note: docker registry must be v2.
Source Configuration
-
repository
: Required. The name of the repository, e.g.concourse/docker-image-resource
.Note: When configuring a private registry, you must include the port (e.g. :443 or :5000) even though the docker CLI does not require it.
-
tag
: Optional. The tag to track. Defaults tolatest
. -
username
: Optional. The username to authenticate with when pushing. -
password
: Optional. The password to use when authenticating. -
aws_access_key_id
: Optional. AWS access key to use for acquiring ECR credentials. -
aws_secret_access_key
: Optional. AWS secret key to use for acquiring ECR credentials. -
insecure_registries
: Optional. An array of CIDRs orhost:port
addresses to whitelist for insecure access (eitherhttp
or unverifiedhttps
). This option overrides any entries inca_certs
with the same address. -
registry_mirror
: Optional. A URL pointing to a docker registry mirror service. -
ca_certs
: Optional. An array of objects with the following format:ca_certs: - domain: example.com:443 cert: | -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- - domain: 10.244.6.2:443 cert: | -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
Each entry specifies the x509 CA certificate for the trusted docker registry residing at the specified domain. This is used to validate the certificate of the docker registry when the registry's certificate is signed by a custom authority (or itself).
The domain should match the first component of
repository
, including the port. If the registry specified inrepository
does not use a custom cert, addingca_certs
will break the check script. This option is overridden by entries ininsecure_registries
with the same address or a matching CIDR.
Behavior
check
: Check for new images.
The current image digest is fetched from the registry for the given tag of the repository.
in
: Fetch the image from the registry.
Pulls down the repository image by the requested digest.
The following files will be placed in the destination:
/image
: Ifsave
istrue
, thedocker save
d image will be provided here./repository
: The name of the repository that was fetched./tag
: The tag of the repository that was fetched./image-id
: The fetched image ID./digest
: The fetched image digest./rootfs.tar
: Ifrootfs
istrue
, the contents of the image will be provided here.
Parameters
save
: Optional. Place adocker save
d image in the destination.rootfs
: Optional. Place a.tar
file of the image in the destination.skip_download
: Optional. Skipdocker pull
of image. Only/image-id
,/repository
, and/tag
will be populated./image
and/rootfs.tar
will not be present.
out
: Push an image, or build and push a Dockerfile
.
Push a Docker image to the source's repository and tag. The resulting version is the image's digest.
Parameters
-
build
: Optional. The path of a directory containing aDockerfile
to build. -
load
: Optional. The path of a directory containing an image that was fetched using this same resource withsave: true
. -
dockerfile
: Optional. The path of theDockerfile
in the directory if it's not at the root of the directory. -
cache
: Optional. Defaultfalse
. When thebuild
parameter is set, first pullimage:tag
from the Docker registry (so as to use cached intermediate images when building). This will cause the resource to fail if it is set totrue
and the image does not exist yet. -
load_base
: Optional. A path to a directory containing an image todocker load
before runningdocker build
. The directory must haveimage
,image-id
,repository
, andtag
present, i.e. the tree produced by/in
. -
load_file
: Optional. A path to a file todocker load
and then push. Requiresload_repository
. -
load_repository
: Optional. The repository of the image loaded fromload_file
. -
load_tag
: Optional. Defaultlatest
. The tag of image loaded fromload_file
-
import_file
: Optional. A path to a file todocker import
and then push. -
pull_repository
: Optional. A path to a repository to pull down, and then push to this resource. -
pull_tag
: Optional. Defaultlatest
. The tag of the repository to pull down viapull_repository
. -
tag
: Optional. The value should be a path to a file containing the name of the tag. -
tag_prefix
: Optional. If specified, the tag read from the file will be prepended with this string. This is useful for addingv
in front of version numbers. -
tag_as_latest
: Optional. Defaultfalse
. If true, the pushed image will be tag as latest too and tag will be push.
Example
resources:
- name: git-resource
type: git
source: # ...
- name: git-resource-image
type: docker-image
source:
repository: concourse/git-resource
username: username
password: password
- name: git-resource-rootfs
type: s3
source: # ...
jobs:
- name: build-rootfs
plan:
- get: git-resource
- put: git-resource-image
params: {build: git-resource}
get_params: {rootfs: true}
- put: git-resource-rootfs
params: {file: git-resource-image/rootfs.tar}