cisagov/con-pca-tasks repository overview

⁠Con-PCA Tasks Docker 🐳

⁠Docker Image

This project's purpose is to containerize Con-PCA-Tasks⁠ project as part of our CI/CD pipeline.

⁠Related Con-PCA Repositories

• con-pca-api⁠
• con-pca-cicd⁠
• con-pca-web⁠
• con-pca-tasks⁠

⁠Running

⁠Running with Docker Compose

1. Start the container and detach:

   docker compose up --detach
   

   Copy

⁠Updating your container

⁠Docker Compose

1. Pull the new image from Docker Hub:

   docker compose pull
   

   Copy

2. Recreate the running container by following the previous instructions⁠:

   docker compose up --detach
   

   Copy

⁠Image tags

The images of this container are tagged with semantic versions⁠ of the underlying con-pca-tasks project that they containerize. It is recommended that most users use a version tag (e.g. :0.0.1).

See the tags tab⁠ on Docker Hub for a list of all the supported tags.

⁠Volumes

⁠Ports

The following ports are exposed by this container:

⁠Environment variables

⁠Required

⁠Building from source

Build the image locally using this git repository as the build context⁠:

docker build \
  --build-arg VERSION=0.0.1 \
  --tag cisagov/con-pca-tasks:0.0.1 \
  https://github.com/cisagov/con-pca-tasks-docker.git#develop

⁠Cross-platform builds

To create images that are compatible with other platforms, you can use the buildx⁠ feature of Docker:

1. Copy the project to your machine using the Code button above or the command line:

   git clone https://github.com/cisagov/con-pca-tasks-docker.git
   cd con-pca-tasks-docker
   

   Copy

2. Create the Dockerfile-x file with buildx platform support:

   ./buildx-dockerfile.sh
   

   Copy

3. Build the image using buildx:

   docker buildx build \
     --file Dockerfile-x \
     --platform linux/amd64 \
     --build-arg VERSION=0.0.1 \
     --output type=docker \
     --tag cisagov/con-pca-tasks:0.0.1 .
   

   Copy

⁠Contributing

We welcome contributions! Please see CONTRIBUTING.md⁠ for details.

⁠License

This project is in the worldwide public domain⁠.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication⁠.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.