ansible-operator

packaged by Chainguard

Chainguard Container for ansible-operator

Operator SDK runtime that reconciles Kubernetes resources with Ansible

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/ansible-operator:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

Chainguard's ansible-operator image is comparable to the upstream quay.io/operator-framework/ansible-operator image and can be used as a drop-in replacement.

This image ships the ansible-operator binary from operator-framework/ansible-operator-plugins, along with the Ansible toolchain (ansible, ansible-playbook, ansible-runner, and friends) it invokes at runtime. The Ansible tooling lives in a virtualenv under /usr/share/ansible-operator, which is already on the image's PATH and PYTHONPATH.

The image runs as the ansible user (UID 1001, root group 0) with HOME=/opt/ansible, matching the layout the operator's Ansible runner expects.

Matching the upstream image, the entrypoint is /usr/bin/tini -- /usr/local/bin/ansible-operator run --watches-file=./watches.yaml (the watches path is resolved against the /opt/ansible working directory). The tini init process runs as PID 1 so the child processes ansible-runner spawns on each reconcile are reaped and signals are forwarded for a clean shutdown.

Getting Started

Building an Ansible-based operator

The ansible-operator image is designed to be the base of your operator image. A minimal Dockerfile copies in your watches.yaml, roles, and playbooks:

FROM cgr.dev/ORGANIZATION/ansible-operator:latest

COPY watches.yaml ${HOME}/watches.yaml
COPY roles/ ${HOME}/roles/
COPY playbooks/ ${HOME}/playbooks/

The default entrypoint is /usr/local/bin/ansible-operator. In a cluster the operator is typically started with:

ansible-operator run --watches-file=./watches.yaml

Checking the version

docker run --rm cgr.dev/ORGANIZATION/ansible-operator version

Running the bundled Ansible CLIs

Because the Ansible toolchain is on the image PATH, you can drive it directly by overriding the entrypoint — for example to render a playbook:

docker run --rm --entrypoint ansible-playbook \
  cgr.dev/ORGANIZATION/ansible-operator --version

Documentation and Resources

• operator-framework/ansible-operator-plugins — the source repository for the ansible-operator binary.
• Operator SDK documentation — building operators with Ansible.
• Ansible documentation

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.