How to use this image

All examples in this guide use the public image. If you've mirrored the repository for your own use (for example, to your Docker Hub namespace), update your commands to reference the mirrored image instead of the public one.

For example:

• Public image: dhi.io/k8ssandra-operator:<tag>
• Mirrored image: <your-namespace>/dhi-k8ssandra-operator:<tag>

For the examples, you must first use docker login dhi.io to authenticate to the registry to pull the images.

About K8ssandra Operator

K8ssandra Operator is a Kubernetes operator that manages the lifecycle of Apache Cassandra clusters deployed on Kubernetes. It is designed to run as a Kubernetes controller and is not intended to be run as a standalone Docker container. The operator provides:

• Multi-cluster and multi-region support for Cassandra deployments
• Automated deployment and management of Cassandra clusters
• Backup and restore capabilities
• Monitoring and metrics integration
• Control plane and data plane architecture for distributed deployments

Prerequisites

Before using this image, you need:

• A Kubernetes cluster (version 1.21 or later)
• kubectl configured to access your cluster
• Helm 3.x or Kustomize for deployment
• Network connectivity between clusters (for multi-cluster deployments)

Deploy K8ssandra Operator

K8ssandra Operator is typically deployed using Helm or Kustomize. The following examples show how to deploy the operator using the Docker Hardened Image.

Deploy with Helm

First, add the K8ssandra Helm repository and update it:

$ helm repo add k8ssandra https://helm.k8ssandra.io/stable
$ helm repo update

Create a values.yaml file to override the default image:

image:
  registry: dhi.io
  repository: k8ssandra-operator
  tag: <tag>
  pullPolicy: IfNotPresent

Install the operator:

$ helm install k8ssandra-operator k8ssandra/k8ssandra-operator \
  -f values.yaml \
  --namespace k8ssandra-operator \
  --create-namespace

Deploy with Kustomize

Create a kustomization.yaml file:

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

namespace: k8ssandra-operator

resources:
  - https://github.com/k8ssandra/k8ssandra-operator/config/deployments/control-plane?ref=v1.30.2

images:
  - name: k8ssandra/k8ssandra-operator
    newName: dhi.io/k8ssandra-operator
    newTag: <tag>

Apply the configuration:

$ kubectl apply -k .

Verify deployment

Check that the operator is running:

$ kubectl get pods -n k8ssandra-operator
NAME                                   READY   STATUS    RESTARTS   AGE
k8ssandra-operator-7d8f9c8b5d-abcde    1/1     Running   0          1m

Common K8ssandra Operator use cases

For end-to-end K8ssandraCluster examples and feature-specific manifests, refer to the upstream K8ssandra documentation:

• Single-cluster install with Helm⁠
• Single-cluster install with Kustomize⁠
• Multi-cluster connectivity⁠
• Data plane registration⁠
• Stargate⁠
• Backup and restore⁠
• Monitoring with Prometheus and Grafana⁠

Use the image override patterns in this guide when you want to substitute the upstream operator image with the Docker Hardened Image.

Configuration options

This guide focuses on the Docker Hardened Image-specific configuration needed to deploy k8ssandra-operator. For operator settings, chart values, and K8ssandraCluster fields, refer to the upstream K8ssandra documentation:

• K8ssandra Operator⁠
• K8ssandra Operator CRD reference⁠

Helm values

image:
  registry: dhi.io
  repository: k8ssandra-operator
  tag: <tag>
  pullPolicy: IfNotPresent

Configuration options

The operator supports configuration through environment variables and command-line flags:

Check operator logs

$ kubectl logs -n k8ssandra-operator deployment/k8ssandra-operator

Check K8ssandraCluster status

$ kubectl get k8ssandracluster -n k8ssandra-operator
$ kubectl describe k8ssandracluster demo -n k8ssandra-operator

Check Cassandra datacenter status

$ kubectl get cassandradatacenter -n k8ssandra-operator
$ kubectl describe cassandradatacenter dc1 -n k8ssandra-operator

Image variants

Docker Hardened Images come in different variants depending on their intended use. Image variants are identified by their tag.

• Runtime variants are designed to run your application in production. These images are intended to be used either directly or as the FROM image in the final stage of a multi-stage build. These images typically:

  • Run as a nonroot user
  • Do not include a shell or a package manager
  • Contain only the minimal set of libraries needed to run the app

• Build-time variants typically include dev in the tag name and are intended for use in the first stage of a multi-stage Dockerfile. These images typically:

  • Run as the root user
  • Include a shell and package manager
  • Are used to build or compile applications

• FIPS variants include fips in the variant name and tag. They come in both runtime and build-time variants. These variants use cryptographic modules that have been validated under FIPS 140, a U.S. government standard for secure cryptographic operations. For example, usage of MD5 fails in FIPS variants.

To view the image variants and get more information about them, select the Tags tab for this repository, and then select a tag.

Migrate to a Docker Hardened Image

To migrate your application to a Docker Hardened Image, you must update your Dockerfile. At minimum, you must update the base image in your existing Dockerfile to a Docker Hardened Image. This and a few other common changes are listed in the following table of migration notes.

The following steps outline the general migration process.

1. Find hardened images for your app.

   A hardened image may have several variants. Inspect the image tags and find the image variant that meets your needs.

2. Update the base image in your Dockerfile.

   Update the base image in your application's Dockerfile to the hardened image you found in the previous step. For framework images, this is typically going to be an image tagged as dev because it has the tools needed to install packages and dependencies.

3. For multi-stage Dockerfiles, update the runtime image in your Dockerfile.

   To ensure that your final image is as minimal as possible, you should use a multi-stage build. All stages in your Dockerfile should use a hardened image. While intermediary stages will typically use images tagged as dev, your final runtime stage should use a non-dev image variant.

4. Install additional packages

   Docker Hardened Images contain minimal packages in order to reduce the potential attack surface. You may need to install additional packages in your Dockerfile. Inspect the image variants to identify which packages are already installed.

   Only images tagged as dev typically have package managers. You should use a multi-stage Dockerfile to install the packages. Install the packages in the build stage that uses a dev image. Then, if needed, copy any necessary artifacts to the runtime stage that uses a non-dev image.

   For Alpine-based images, you can use apk to install packages. For Debian-based images, you can use apt-get to install packages.

Troubleshooting migration

The following are common issues that you may encounter during migration.

General debugging

The hardened images intended for runtime don't contain a shell nor any tools for debugging. The recommended method for debugging applications built with Docker Hardened Images is to use Docker Debug⁠ to attach to these containers. Docker Debug provides a shell, common debugging tools, and lets you install other tools in an ephemeral, writable layer that only exists during the debugging session.

Permissions

By default image variants intended for runtime, run as the nonroot user. Ensure that necessary files and directories are accessible to the nonroot user. You may need to copy files to different directories or change permissions so your application running as the nonroot user can access them.

Privileged ports

Non-dev hardened images run as a nonroot user by default. As a result, applications in these images can't bind to privileged ports (below 1024) when running in Kubernetes or in Docker Engine versions older than 20.10. To avoid issues, configure your application to listen on port 1025 or higher inside the container, even if you map it to a lower port on the host. For example, docker run -p 80:8080 my-image will work because the port inside the container is 8080, and docker run -p 80:81 my-image won't work because the port inside the container is 81.

No shell

By default, image variants intended for runtime don't contain a shell. Use dev images in build stages to run shell commands and then copy any necessary artifacts into the runtime stage. In addition, use Docker Debug to debug containers with no shell.

Entry point

Docker Hardened Images may have different entry points than images such as Docker Official Images. Use docker inspect to inspect entry points for Docker Hardened Images and update your Dockerfile if necessary.