Skip to main content

Upgrade chaos infrastructure

If a HCE release is not backward compatible, upgrade your chaos infrastructure to ensure you can execute all experiments smoothly. This applies only to releases that have breaking changes, which will be clearly indicated in release notes.

warning

These are the high-level steps to upgrade your chaos infrastructure, explained in detail later:

  1. Delete the old ChaosEngine CRs where you've deployed a chaos infrastructure.
  2. Update CRDs where you've deployed a chaos infrastructure.
  3. Update the chaos infrastructure in Harness in environments where you've deployed it.
  4. Edit experiment YAML to update the chaosnative/go-runner image to the new version.

How to tell if an infrastructure upgrade is required?​

Go to Chaos > Environments, and select an environment where you've installed chaos infrastructure. UPGRADE NEEDED is displayed next to an infrastructure if it requires an upgrade, along with an Update link.

Environment details page showing chaos-enabled infrastructures

Upgrade your chaos infrastructure​

Step 1: Delete the old ChaosEngine​

This step removes all ChaosEngine custom resources (CRs) in the infrastructure namespace.

  1. Connect to the cluster on a console where you can run kubectl.

  2. Delete the old ChaosEngine CRs from the cluster:

    kubectl delete chaosengines --all -n NAMESPACE_OF_CHAOS_INFRASTRUCTURE

  3. If ChaosEngine CRs are not being deleted, remove the finalizer from all the chaosengine CRs.

    kubectl get chaosengine --no-headers -o custom-columns=":metadata.name" -n NAMESPACE_OF_CHAOS_INFRASTRUCTURE | xArgs  kubectl patch chaosengine {}   -p '{"metadata":{"finalizers":[]}}' --type=merge -n NAMESPACE_OF_CHAOS_INFRASTRUCTURE

  4. Confirm ChaosEngine CRs are deleted.

    kubectl get chaosengine -n NAMESPACE_OF_CHAOS_INFRASTRUCTURE

Step 2: Upgrade CRDs where you've deployed a chaos infrastructure​

  1. Connect to the cluster on a console where you can run kubectl.

  2. Run this command to upgrade the CRDs:

    kubectl apply -f https://raw.githubusercontent.com/chaosnative/hce-charts/main/hce-saas/hce-saas-crds.yaml

Step 3: Update the chaos infrastructure in Harness​

  1. In Harness, go to Chaos > Environments, and then select an environment where you've installed chaos infrastructure.

    UPGRADE NEEDED is the status displayed next to infrastructures that require an upgrade.

    Environment details page showing chaos-enabled infrastructures

  2. Select Update (next to the old version number), and then follow the instructions on the next screen.

    When the update is complete, the status changes to CONNECTED, and the new version number is displayed.

Step 4: Update the chaosnative/go-runner image in experiment YAML​

For existing experiments that use the infrastructure you're upgrading, you must update the version of the chaosnative/go-runner image. You do this by editing the YAML definitions of these experiments. This step is not required for new experiments after the upgrade.

To update the chaosnative/go-runner image version in an experiment:

  1. Refer to the release notes to determine the required version of the chaosnative/go-runner image.

  2. In Harness, go to Chaos > Chaos Experiments, and then select the experiment you want to update.

  3. At the top of the experiment details page, select YAML.

  4. In the experiments .yml file, select Edit Yaml.

  5. In the edit view, do a browser search (Ctrl/Cmd + f) for chaosnative/go-runner, and then update its version number.

    For example, this updates chaosnative/go-runner to version 0.13.1.

    Experiment YAML file with chaosnative/go-runner highlighted

  6. Select Save.

  7. Repeat this procedure to update the relevant existing experiments in any custom chaos hubs that may be connected to your project.

Use Helm Template to Upgrade Chaos Infrastructure​

  • To upgrade a chaos infrastructure that you installed using the Helm commands, you can navigate to the environment and click Upgrade now. This will list the set of commands that you can execute on your terminal.

    step 9

  1. Choose an existing environment or create a new environment

  2. If you want to override other values, you can make the changes in the values.yaml file of the respective custom resource in the Helm repository.

  3. Download the helm repository. This repository contains all the chaos resources required for chaos infrastructure management. The repository also contains resources necessary for the namespace and cluster scope installations. You can use this repository to install and manage the infrastructure.

Based on the scope of installation, you have to execute the commands.

  1. If you wish to install the infrastructure in the namespace scope, you will get a helm command to install the CRDs. You have to apply this command separately before installing or upgrading the infrastructure.
  2. If you wish to install the infrastructure in cluster scope, apply the helm upgrade command to install the CRDs and other infrastructure components.
tip
  1. If you install your infrastructure in cluster scope, HCE supports auto-upgrade for such an infrastructure.
  2. It is important that you remember that the flags in the command are based on the input parameters you provide while installing the infrastructure.