litmus-chaos-operator

packaged by Chainguard

Chainguard Container for litmus-chaos-operator

LitmusChaos Operator is a Kubernetes operator that manages the lifecycle of chaos experiments. It watches for ChaosEngine custom resources and orchestrates chaos injection into target applications for resilience testing.

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/litmus-chaos-operator:latest

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

Overview

The LitmusChaos Operator is a Kubernetes operator that manages the lifecycle of chaos experiments. It watches for ChaosEngine custom resources and orchestrates chaos injection into target applications, enabling resilience testing in Kubernetes environments.

This image is a drop-in replacement for the upstream litmuschaos/chaos-operator image.

Compatibility

This image can be used as a replacement for the litmuschaos/chaos-operator image in any LitmusChaos deployment. It is compatible with the official Litmus Helm chart.

Usage

Helm Installation

LitmusChaos requires two Helm deployments: the ChaosCenter platform (frontend, server, MongoDB) and the chaos-operator itself.

1. Deploy the ChaosCenter Platform

First, deploy the LitmusChaos platform and configure it to use the Chainguard chaos-operator image via portal.server.graphqlServer.imageEnv:

helm repo add litmuschaos https://litmuschaos.github.io/litmus-helm/

helm install litmus litmuschaos/litmus \
  --namespace=litmus --create-namespace \
  --set portal.frontend.service.type=NodePort \
  --set portal.server.graphqlServer.imageEnv.LITMUS_CHAOS_OPERATOR_IMAGE=cgr.dev/ORGANIZATION/litmus-chaos-operator:latest

2. Deploy the Chaos Operator

Then deploy the chaos-operator subchart directly, overriding the image to use the Chainguard variant:

# Clone the litmus-helm repo for the subchart
git clone https://github.com/litmuschaos/litmus-helm.git

helm install chaos-operator litmus-helm/charts/litmus-agent/charts/chaos-operator \
  --namespace=litmus \
  --set image.repository=cgr.dev/ORGANIZATION/litmus-chaos-operator \
  --set image.tag=latest

3. Install CRDs

The chaos-operator subchart does not bundle CRDs. Install them from the upstream repository:

kubectl apply -f https://raw.githubusercontent.com/litmuschaos/chaos-operator/VERSION/deploy/chaos_crds.yaml

Replace VERSION with the version that matches your operator (e.g., 3.26.0).

Verify the CRDs are established:

kubectl wait --for=condition=Established crd/chaosengines.litmuschaos.io --timeout=30s
kubectl wait --for=condition=Established crd/chaosexperiments.litmuschaos.io --timeout=30s
kubectl wait --for=condition=Established crd/chaosresults.litmuschaos.io --timeout=30s

Running a Chaos Experiment

Once the operator is running and CRDs are installed, you can run chaos experiments by creating ChaosExperiment and ChaosEngine custom resources.

1. Create a ChaosExperiment

apiVersion: litmuschaos.io/v1alpha1
kind: ChaosExperiment
metadata:
  name: pod-delete
  namespace: litmus
spec:
  definition:
    scope: Namespaced
    permissions:
      - apiGroups: [""]
        resources: ["pods"]
        verbs: ["create", "delete", "get", "list", "patch", "update", "deletecollection"]
      - apiGroups: ["batch"]
        resources: ["jobs"]
        verbs: ["create", "list", "get", "delete", "deletecollection"]
    image: "litmuschaos/go-runner:latest"
    args:
      - -c
      - ./experiments -name pod-delete
    command:
      - /bin/bash
    env:
      - name: TOTAL_CHAOS_DURATION
        value: "15"
      - name: CHAOS_INTERVAL
        value: "5"
    labels:
      name: pod-delete

2. Create a ChaosEngine to Trigger the Experiment

apiVersion: litmuschaos.io/v1alpha1
kind: ChaosEngine
metadata:
  name: nginx-chaos
  namespace: litmus
spec:
  appinfo:
    appns: litmus
    applabel: app=nginx-test
    appkind: deployment
  engineState: active
  chaosServiceAccount: litmus-admin
  experiments:
    - name: pod-delete
      spec:
        components:
          env:
            - name: TOTAL_CHAOS_DURATION
              value: "15"

The operator will watch for the ChaosEngine and automatically create runner pods to execute the experiment. You can monitor progress via:

kubectl get chaosengine,chaosresult -n litmus

Docker

docker pull cgr.dev/ORGANIZATION/litmus-chaos-operator:latest
docker run --rm cgr.dev/ORGANIZATION/litmus-chaos-operator:latest --help

Documentation and Resources

• LitmusChaos Documentation
• LitmusChaos GitHub
• Litmus Helm Charts
• ChaosHub - Experiment Library
• Chainguard Academy

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.