How to Upgrade Your Wallaroo Ops

This process is for kots based installations of Wallaroo.

This assumes that kubectl and kots have been installed in a terminal with administrative access to the Kubernetes cluster hosting the Wallaroo installation.

1. Launch the Kots Administrative Dashboard with kubectl kots admin-console --namespace $WALLAROO_NAMESPACE, replacing $WALLAROO_NAMESPACE with the namespace the Wallaroo instance is installed in. For example: kubectl kots admin-console --namespace wallaroo.
2. Log into the administration console with the Administrative Dashboard password set during the installation process.
3. Select the Troubleshoot tab.
4. Select Analyze Wallaroo.
5. Select Download bundle to save the bundle file as a compressed archive. Depending on your browser settings the file download location can be specified.
6. Send the file to Wallaroo technical support.

At any time, any existing bundle can be examined and downloaded from the Troubleshoot tab.

To generate a support bundle via the command line for either kots or helm based installations of Wallaroo, the following applications are used.

• kubectl
• kubectl plugins:
  • krew: Install Krew
  • krew support-bundle: Install with kubectl krew install support-bundle.

This creates a collection of log files, configuration files and other details into a .tar.gz file in the same directory as the command is run from in the format support-bundle-YYYY-MM-DDTHH-MM-SS.tar.gz. This file is submitted to the Wallaroo support team for review.

kubectl support-bundle --load-cluster-specs  --interactive=false

The following section details how to upgrade the kots plugin and cluster in preparation of upgrading the Wallaroo installation. Note that the default timeout for kots based installations are 10 minutes. For more details, see kots CLI flags documentation.

Kubernetes and Kots Client Software Prerequisites

Before installing or upgrading Wallaroo, the administrative node managing the Kubernetes cluster will require these tools.

• kubectl
  
  • For Kots based installs:
    • kots Version 1.112.2
  
  
  • For Helm installs:
    • helm: Install Helm
      • Minimum supported version: Helm 3.11.2
    • krew: Install Krew
    • krew preflight and krew support-bundle. Install with the following commands:
      • kubectl krew install support-bundle
      • kubectl krew install preflight

The following are quick guides for installing kubectl for macOS.

To install kubectl on a macOS system using Homebrew:

1. Issue the brew install command:

   brew install kubectl
   

2. Verify the installation:

   kubectl version --client
   

Upgrade Kots Client Procedure

To upgrade the version of kots used:

Upgrade the kubectl kots plugin] to the specific version with the following command. For more details, see Installing the KOTS CLI.

curl https://kots.io/install/1.112.2 | bash

Upgrade Kots Cluster Application Procedure

Upgrade the kots version of an installed cluster to match your CLI kots version via the following command, replacing $NAMESPACE with the namespace the Wallaroo instance is installed in. For more details, see Update an Application: Using the KOTS CLI.

kubectl kots admin-console upgrade -n $NAMESPACE

For example, if the Wallaroo installation is in the default namespace wallaroo, the command is:

kubectl kots admin-console upgrade -n wallaroo

To upgrade a kots based installation of Wallaroo:

1. From a terminal shell with administrative access to the Kubernetes cluster hosting Wallaroo, launch the Kots Administrative Dashboard via the following command:

   kubectl kots admin-console --namespace $NAMESPACE
   

   Replacing $NAMESPACE with the name of the namespace the Wallaroo Ops center is installed in, which is wallaroo by default. For example:

   kubectl kots admin-console --namespace wallaroo
   • Press Ctrl+C to exit
   • Go to http://localhost:8800 to access the Admin Console
   

2. Access the Kots Administrative Dashboard via the domain name and port as provided in the previous step.

3. From the Kots Administrative Dashboard:

   

   1. If there is a new version of Wallaroo to install based on your Wallaroo license type, it will be displayed under the Version (B) display as New Version Available. Select Check for updates to check for updated versions.

   2. Select the version to upgrade to.

   3. To perform a preflight check, select the preflight icon and verify the cluster meets the requirements.

   4. If ready to upgrade, select Deploy (C).

   5. Verify the upgrade process by selecting Yes, Deploy.

      

4. During the upgrade process, the status indicator (A) changes from Ready to Unavailable. Selecting Details will show which services are available or are still being upgraded.

5. When the upgrade process is complete, the status indicator will change to Ready. At this point, users can resume their normal operations.

• For Helm installs:
  • helm: Install Helm
    • Minimum supported version: Helm 3.11.2
  • krew: Install Krew
  • krew preflight and krew support-bundle. Install with the following commands:
    • kubectl krew install support-bundle
    • kubectl krew install preflight

To upgrade a helm based installation of Wallaroo:

1. From a Wallaroo Support representative, retrieve the following:
   1. The license channel. This will be in the form of oci://registry.replicated.com/wallaroo/$CHANNEL/wallaroo, where $CHANNEL represents the channel type. For example, ``oci://registry.replicated.com/wallaroo/2024-3/wallaroo`.
   2. The version to be upgrade to. For example: 2024.3.
   3. OCI Registry login. This will be in the format: helm registry login registry.replicated.com --username $YOURUSERNAME --password $YOURPASSWORD
   4. Helm Release Name: This was determined during the Wallaroo Install process.
2. Prepare the local-values.yaml file that will store the essential configurations options. It is highly recommended to use the same local-values.yaml file used during the Wallaroo installation for minimum changes. The following is an example of the local-values.yaml file settings. See Wallaroo Helm Reference Guides for additional settings.

wallarooDomain: "wallaroo.example.com" # change to match the domain name

custTlsSecretName: cust-cert-secret

apilb:
  serviceType: LoadBalancer
  external_inference_endpoints_enabled: true
  ingress_mode: internal # internal (Default), external,or none

dashboard:
  clientName: "Wallaroo Helm Example" # Insert the name displayed in the Wallaroo Dashboard

kubernetes_distribution: ""   # Required. One of: aks, eks, gke, oke, or kurl.

From a terminal with helm and administrative access to the Kubernetes cluster Wallaroo Ops is installed to, perform the following:

1. Login to the OCI registry, replacing $YOURUSERNAME and $YOURPASSWORD with the ones provided by Wallaroo:

   helm registry login registry.replicated.com --username $YOURUSERNAME --password $YOURPASSWORD
   

2. Set the default Kubernetes namespace to the one used for the Wallaroo installation. By default, the namespace wallaroo is used. For example:

   kubectl config set-context --current --namespace wallaroo
   

3. Perform the preflight check. Preflight verification is performed with the following command format. The variables $LICENSE_CHANNEL and $VERSION is supplied by your Wallaroo support representative.

   helm template --is-upgrade \
   oci://registry.replicated.com/wallaroo/$LICENSE_CHANNEL/wallaroo --version $VERSION \
   | kubectl preflight -
   

   For example, the $LICENSE_CHANNEL=2024-3 and the $VERSION=2024.3

   helm template --is-upgrade \
   oci://registry.replicated.com/wallaroo/2024-3/wallaroo --version 2024.3 \
   | kubectl preflight -
   

   This displays the Preflight Checks report. Verify that all checks are completed successfully before proceeding.

4. Perform the upgrade with the following command, replacing the following:

   • $LICENSE_CHANNEL: The channel for the installation upgrade.
   • $VERSION: The version to upgrade to.
   • $RELEASE: The helm name of the installation release. This does not need to match the name of the release already used. By default, wallaroo.

   helm upgrade --install --version $VERSION \
   --wait --timeout 10m \
   --values local-values.yaml \
   --debug \
   $RELEASE \
   oci://registry.replicated.com/wallaroo/$LICENSE_CHANNEL/wallaroo
   

   For example, the $LICENSE_CHANNEL=2024-3, $VERSION=2024.3, and $RELEASE=wallaroo, the command would be:

   helm upgrade --install --version 2024.3 \
   --wait --timeout 10m \
   --values local-values.yaml \
   --debug \
   wallaroo \
   oci://registry.replicated.com/wallaroo/2024-3/wallaroo
   

5. Once the installation is complete, verify the installation with the helm test $RELEASE command. With the settings above, this would be:

   helm test wallaroo
   

   A successful upgrade will resemble the following:

   NAME: wallaroo
   LAST DEPLOYED: Thu Apr 11 09:56:17 2024
   NAMESPACE: default
   STATUS: pending-upgrade
   REVISION: 2
   TEST SUITE:     wallaroo-fluent-bit-test-connection
   Last Started:   Thu Apr 11 10:03:52 2024
   Last Completed: Thu Apr 11 10:03:56 2024
   Phase:          Succeeded
   TEST SUITE:     nats-test-request-reply
   Last Started:   Thu Apr 11 10:03:44 2024
   Last Completed: Thu Apr 11 10:03:52 2024
   Phase:          Succeeded
   TEST SUITE:     wallaroo-test-connections-hook
   Last Started:   Thu Apr 11 10:03:56 2024
   Last Completed: Thu Apr 11 10:06:11 2024
   Phase:          Succeeded
   TEST SUITE:     wallaroo-test-objects-hook
   Last Started:   Thu Apr 11 10:06:12 2024
   Last Completed: Thu Apr 11 10:06:21 2024
   Phase:          Succeeded