cimg/deploy

cimg/deploy is a Docker image created by CircleCI with continuous delivery and deployment pipelines in mind. Each tag is a date-based snapshot of many deployment related tools such as kubectl, terraform, and much more. If you find this image useful but also want the AWS CLI, please check out cimg/aws. GCP and Azure images are coming soon.

Getting Started

This image can be used with the CircleCI docker executor. For example:

1
2
3
4
5
6
7
jobs:
  build:
    docker:
      - image: cimg/deploy:2024.11
    steps:
      - checkout
      - run: echo "Do things"

In the above example, the CircleCI Deploy Docker image is used for the primary container. You can now use all of the tools pre-installed in this image in this job.

How This Image Works

This image is published on a monthly basis. Each month, we'll update the main tools to newer versions as they are available.

Tagging Scheme

This image has the following tagging scheme:

cimg/deploy:YYYY.MM.I[-variant]

The tag will be YYYY.MM.I where YYYY is the 4 digit year, MM is the 2 digit month, and I is the nth release of that month. The last piece there typically will only change when we need to patch an image for that month.

[-variant] - Variant tags, if available, can optionally be used. For example the Node.js variant is available, it can be used like this: cimg/deploy:2022.06.1-node.

Image Tags

Variants

Variant images typically contain the same base software, but with a few additional modifications.

Node.js

The Node.js variant is the same Deploy image but with Node.js also installed. The Node.js variant will be used by appending -node to the end of an existing cimg/deploy tag.

1
2
3
4
5
6
7
jobs:
  build:
    docker:
      - image: cimg/deploy:2024.11-node
    steps:
      - checkout
      - run: node --version