Chainguard Container for REPO_NAME

Home for Cluster API, a subproject of sig-cluster-lifecycle

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/REPO_NAME: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 Cluster-Api image is comparable to Kubernetes Sig Cluster-Api on Docker Hub. Chainguard's image contains only the minimum set of dependencies needed to run the different components.

Getting Started

Start by creating a Kubernetes manifest that allows the Docker provider to access Docker on the host:

kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
networking:
  ipFamily: dual
nodes:
- role: control-plane
  extraMounts:
    - hostPath: /var/run/docker.sock
      containerPath: /var/run/docker.sock

Next, apply this manifest above by creating a cluster. The following example will create a Kubernetes cluster with kind:

kind create cluster -config config.yaml

Next, initialize a management cluster against the host cluster:

docker run -d \
    cgr.dev/<ORGANISATION>/cluster-api-clusterctl:latest \
    clusterctl init \
    --kubeconfig <KUBECONFIG> \
    --infrastructure vcluster \
    --core cluster-api \
    --bootstrap kubeadm \
    --control-plane kubeadm \
    --wait-providers=false

Generate a manifest for creating clusters:

docker run -d \
    cgr.dev/<ORGANISATION>/cluster-api-clusterctl:latest \
    clusterctl generate cluster ${CLUSTER_NAME} \
    --infrastructure vcluster \
    --kubernetes-version ${KUBERNETES_VERSION} \
    --target-namespace ${CLUSTER_NAMESPACE} > cluster-manifest.yaml

Documentation and Resources

• cluster-api GitHub Repository
• cluster-api 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.