CircleCI Convenience Images => Deploy

A Continuous Delivery & Deployment focused Docker image built to run on CircleCI

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 tools specific to your cloud provider, please see:

• cimg/aws
• cimg/gcp
• cimg/azure

Support Policy

The CircleCI Docker Convenience Image support policy can be found on the CircleCI docs site. This policy outlines the release, update, and deprecation policy for CircleCI Docker Convenience Images.

Table of Contents

• Getting Started
• How This Image Works
• Development
• Contributing
• Additional Resources
• License

Getting Started

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

jobs:
  build:
    docker:
      - image: cimg/deploy:2022.06.1
    steps:
      - checkout
      - run: echo "Do things"

In the above example, the CircleCI Deploy Docker image is used for the primary container. More specifically, the tag 2022.06.1 is used meaning this is the 1st April 2022 snapshot. 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.

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.

jobs:
  build:
    docker:
      - image: cimg/deploy:2022.06.1-node
    steps:
      - checkout
      - run: node --version

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.

Development

Images can be built and run locally with this repository. This has the following requirements:

• local machine of Linux (Ubuntu tested) or macOS
• modern version of Bash (v4+)
• modern version of Docker Engine (v20.10+)

Cloning For Community Users (no write access to this repository)

Fork this repository on GitHub. When you get your clone URL, you'll want to add --recurse-submodules to the clone command in order to populate the Git submodule contained in this repo. It would look something like this:

git clone --recurse-submodules <my-clone-url>

If you missed this step and already cloned, you can just run git submodule update --init to populate the submodule. Then you can optionally add this repo as an upstream to your own:

git remote add upstream https://github.com/CircleCI-Public/cimg-deploy.git

Cloning For Maintainers ( you have write access to this repository)

Clone the project with the following command so that you populate the submodule:

git clone --recurse-submodules git@github.com:CircleCI-Public/cimg-deploy.git

Generating Dockerfiles

Dockerfiles can be generated by using the gen-dockerfiles.sh script. For example, you would run the following from the root of the repo:

./shared/gen-dockerfiles.sh 2022.06.1

The generated Dockerfile will be located at ./2022.06/Dockefile. To build this image locally and try it out, you can run the following:

cd 2022.06
docker build -t test/deploy:2022.06.1 .
docker run -it test/deploy:2022.06.1 bash

Building the Dockerfiles

To build the Docker images locally as this repository does, you'll want to run the build-images.sh script:

./build-images.sh

This would need to be run after generating the Dockerfiles first. When releasing proper images for CircleCI, this script is run from a CircleCI pipeline and not locally.

Publishing Official Images (for Maintainers only)

The individual scripts (above) can be used to create the correct files for an image, and then added to a new git branch, committed, etc. A release script is included to make this process easier. To make a proper release for this image, let's use the fake date April 1991, you would run the following from the repo root:

./shared/release.sh 1991.04.2

This will automatically create a new Git branch, generate the Dockerfile(s), stage the changes, commit them, and push them to GitHub. The commit message will end with the string [release]. This string is used by CircleCI to know when to push images to Docker Hub. All that would need to be done after that is:

• wait for build to pass on CircleCI
• review the PR
• merge the PR

The main branch build will then publish a release.

Incorporating Changes

How changes are incorporated into this image depends on where they come from.

build scripts - Changes within the ./shared submodule happen in its own repository. For those changes to affect this image, the submodule needs to be updated. Typically like this:

cd shared
git pull
cd ..
git add shared
git commit -m "Updating submodule for foo."

parent image - By design, when changes happen to a parent image, they don't appear in existing Deploy images. This is to aid in "determinism" and prevent breaking customer builds. New Deploy images will automatically pick up the changes.

If you really want to publish changes from a parent image into the Deploy image, you have to build a specific image version as if it was a new image. This will create a new Dockerfile and once published, a new image.

Deploy image specific changes - Editing the Dockerfile.template file in this repo will modify the Deploy image specifically. Don't forget that to see any of these changes locally, the gen-dockerfiles.sh script will need to be run again (see above).

Contributing

We encourage issues and pull requests against this repository.

Please check out our contributing guide which outlines best practices for contributions and what you can expect from the images team at CircleCI.

Additional Resources

CircleCI Docs - The official CircleCI Documentation website. CircleCI Configuration Reference - From CircleCI Docs, the configuration reference page is one of the most useful pages we have. It will list all of the keys and values supported in .circleci/config.yml. Docker Docs - For simple projects this won't be needed but if you want to dive deeper into learning Docker, this is a great resource.

License

This repository is licensed under the MIT license. The license can be found here.