Turbine 23.5.7 Upgrade Instructions

Use these upgrade instructions to upgrade your instance of Turbine 23.x. The instructions are organized by subsections of this document that will help you upgrade by specific installation type, whether you have an embedded or existing cluster installation.

Known Issue with Embedded/Existing Cluster/helm Installations: We are aware of an issue where the user is 'unable to generate a URL while creating a webhook'. There is a workaround for that for now. This script which can be used on all deployment methods, for KOTS (existing or embedded clusters) and for helm deployments. Contact Support for additional details.

Prerequisites:

Requires a fully functional jq software version 1.6 and all dependent packages.

Instructions:

Set the value for the NS variable in line 5 to the Kubernetes namespace where Turbine has been installed.

KOTS existing cluster and Helm deployments allow setting the namespace where the app is installed.

KOTS embedded cluster should be set to “default”.

Copy the script to a computer where you have access to the Kubernetes cluster.

#!/bin/bash set -e # Set the Kubernetes namespace where Turbine is installed, this should be "default" for a Turbine installation with an embedded cluster # NS=default NS= [[ -z $NS ]] && echo "This script requires that you set the name of the Kubernetes namespace where Turbine is installed in the NS variable." && exit 1 configmap=$(kubectl -n $NS get configmap tenant-services -o jsonpath='{.data.turbine\-init\-tenant\-job\.yaml}') tenants=$(kubectl get ns -l "app.kubernetes.io/name"="tenant-services" -o json | jq -r '.items[] | .metadata.labels."tenant.swimlane.io/account-id" + ";" + .metadata.labels."tenant.swimlane.io/tenant-id"') IFS=$'\n' for i in $tenants;do accountid=$(echo $i | cut -d";" -f1) tenantid=$(echo $i | cut -d";" -f2) yaml=$(echo "$configmap" | sed -r -e "s/REPLACE_ACCOUNT_ID/${accountid}/g" -e "s/REPLACE_TENANT_ID/${tenantid}/g") echo "$yaml" | kubectl -n tenant$tenantid apply -f - done

Run the script on the host with a command like “chmod +x script.sh && ./script.sh"

The script will show the output of the kubectl command which applies the job manifest for each tenant

$ chmod +x script.sh && ./script.sh job.batch/tenant-init-791dac50-10cc-4096-944f-a2ae98560d1a created

Upgrade Turbine on Embedded Cluster Installations

Use the following instructions to upgrade this version of Swimlane on an embedded cluster installation.

Prerequisites:

Turbine version 23.2.x+

MongoDB 5.0.23

Important! Swimlane recommends that you perform a MongoDB backup prior to starting this update. For more information, see Backup and Restore on an Embedded Cluster with Snapshots.

Upgrade Instructions

SSH into any node in your deployment.

Scale down EKCO and kotsadm-rqlite.

kubectl scale deployment ekc-operator --replicas=0 -n kurl kubectl scale statefulsets kotsadm-rqlite --replicas=0 -n default

NOTE: If you have configured SELinux, add this to the end of the command above:

installer-spec-file=se.yaml

Execute the following command to begin the Turbine Platform Installer component upgrade:

$ curl -sSL https://kurl.sh/turbine-turbine-23-5-7 | sudo bash -s ha

After the install script has completed, log in to the Turbine Platform Installer dashboard (https://<SwimlaneDNS>:8800).

Go to the Version History tab and click Check For Updates.

A pop-up window appears, click Go to updated version and click configure.

Click Deploy on the new 23.5.7 version with the highest sequence number at the top of the versions list.

Once the Application tab shows ‘Ready’ your upgrade is complete.

Upgrade Turbine on Existing Cluster Installations

Prerequisites:

Turbine version 23.2.x+

MongoDB 5.0.23

Kubernetes 1.22-1.27

KOTS kubectl plugin 1.107.3

Velero 1.11.x

Important! Swimlane recommends that you perform a MongoDB backup prior to starting this update. For more information, see Backup and Restore on an Existing Cluster with Snapshots.

Upgrade Velero to 1.11.x

Verify if Velero needs to be updated

$ ./velero version

Velero 1.11 includes a change that replaces the restic daemonset with node-agent daemonset. Depending on what version you are upgrading from, there are different steps for patching the container images. See the Velero Documentation for details.

Download Velero 1.11.x for your OS version:

https://github.com/vmware-tanzu/velero/releases/tag/v1.11.0

Untar the file and then change directory (cd) into the uncompressed directory:

$ tar -zxf <FILENAME>.tar.gz $ cd <DIRECTORY>

Upgrade container images as instructed in the Velero upgrade to 1.11 article

Confirm that both the client and server versions are on the same 1.11.0 release:

$ ./velero version

Upgrade KOTS addon and KOTS app

Prepare the Swimlane Turbine Installer Kubectl Add-on

Download the Swimlane Turbine Installer kubectl add-on for the OS version where you run kubectl commands from: Linux: https://get.swimlane.io/turbine/existing-cluster/install/linux OSX: https://get.swimlane.io/turbine/existing-cluster/install/osx

Untar the file:

tar zxf kots_<OS version>.tar.gz

Rename the kots binary to kubectl-kots:

mv kots kubectl-kots

Move the kubectl-kots binary into your PATH so that it can be recognized by kubectl (e.g. /usr/local/bin/)

mv kubectl-kots /usr/local/bin/

Run the upgrade command:

kubectl kots admin-console upgrade -n <namespace>

When the upgrade is complete, login to the Turbine Installer dashboard (https://<SwimlaneDNS>:8800).

Go to the Version History tab - you will see a version for 23.5.7

Click Deploy once the preflight checks have completed.

A new configuration is needed for the Elasticsearch persistent volume size and storageclass. Recommended sizes for small/medium/large environments are 8GB/16GB/32GB respectively.

Once the Application tab shows ‘Ready’ your upgrade is complete.

Upgrade Turbine on Embedded Airgap Cluster Installations

Prerequisites:

Turbine version 23.2.x+If you are not on a version that is >= 11.0, contact your Swimlane support representative.

MongoDB 5.0.23

Links to the Offline Installer Package and Offline Airgap Bundle If you do not have these linked, contact your Swimlane support representative.

Important! Swimlane recommends that you perform a MongoDB backup prior to starting this update. For more information, see Backup and Restore on an Embedded Cluster with Snapshots.

Upgrade Instructions

Copy the latest offline installer package to each airgapped server.Untar the offline installer package on each server.

$ tar -xzvf turbine-23.5.7.tar.gz

Scale down EKCO and kotsadm-rqlite.

kubectl scale deployment ekc-operator --replicas=0 -n kurl kubectl scale statefulsets kotsadm-rqlite --replicas=0 -n default

Run the Turbine Platform Installer update on any node in your deployment:

$ cat install.sh | sudo bash -s airgap ha

Once the installation is complete, if you have a multi-node (HA) cluster, the script prompts you to run an additional command on every node:

Run this script on node swimlane-2 to load required images before proceeding: cat ./tasks.sh | sudo bash -s load-images Have images been loaded on node swimlane-2? (Y/n)

cat ./tasks.sh | sudo bash -s load-images

on nodes two (2) and node three (3) before proceeding to run the command on node one (1).

This command can be run simultaneously on nodes 2 and 3.

Once the load-images script completes on nodes 2 and 3, enter Y in the node 1 terminal session twice.

When the upgrade script completes, press Enter on node 1 and then upload the airgap bundle to the SPI dashboard.

The sequence number “_266” of the airgap file may be higher than shown if a new sequence has been published

Once the upload of the airgap completes, refresh the page or switch tabs to see the status of the file extraction.

Go to the Version History tab and click Upload a new version, then browse to the turbine-23.5.7.airgap file and click Upload.

Go back to the Version History tab and Click on configure on 23.5.7_266

Scroll down for Swimlane Logging Level change default warn to info and save the config

Go back to the Version History tab and click Deploy on the new 23.5.7 version at the top of the versions list.

Once the Application tab shows ‘Ready’ your upgrade is complete

Upgrade Turbine on Existing Airgap Cluster Installations

Prerequisites

Turbine version 23.2.x+

MongoDB 5.0.23

Kubernetes 1.22-1.27

KOTS kubectl plugin 1.107.3

Velero 1.11.x

Turbine 23.5.7 airgap bundle from Swimlane

If you do not have a download link for this, contact your Swimlane support representative.

Important! Swimlane recommends that you perform a MongoDB backup prior to starting this update. For more information, see Backup and Restore on an Existing Cluster with Snapshots.

Upgrade Velero to 1.11.x

Verify if Velero needs to be updated

$ ./velero version

Download Velero 1.11.x for your OS version:

https://github.com/vmware-tanzu/velero/releases/tag/v1.11.0

Untar the file and then change directory (cd) into the uncompressed directory:

$ tar -zxf <FILENAME>.tar.gz $ cd <DIRECTORY>

Update Velero custom resource definitions:

$ ./velero install --crds-only --dry-run -o yaml | kubectl apply -f -

Download the new Velero images and push them to your private registry from your jumpbox. For specific steps on how to download and push new Velero images, see Download and Push New Velero Images.

Upgrade container images as instructed in the Velero upgrade to 1.11 article

Confirm that both the client and server versions are on the same 1.11.0 release:

$ ./velero version

Upgrade KOTS plugin and KOTS app:

Download the latest SPI Kubectl Add-on

See kots documentationfor how to do so. A versioned link will look like this:

# Linux AMD https://github.com/replicatedhq/kots/releases/download/v1.107.3/kots_linux_amd64.tar.gz

Download the latest SPI offline package:https://get.swimlane.io/existing-cluster/install/offline-package

Copy the latest SPI Kubectl Add-on and SPI offline packages to your jumpbox:

$ scp kotsadm.tar.gz user@<swimlaneDNS>:/tmp/kotsadm.tar.gz

$ scp kots_<OS version>.tar.gz user@<swimlaneDNS>:/tmp/kots_<OS version>.tar.gz

Untar the SPI Kubectl Add-on:

$ tar -zxvf kots_<OS version>.tar.gz

Rename or remove the originalkubectl-kots file:

$ rm /usr/local/bin/kubectl-kots

Rename and move the latest SPI Kubectl Add-on file to /usr/local/bin/kubectl-kots

$ mv kots kubectl-kots

$ mv kubectl-kots /usr/local/bin/

Push the SPI (kotsadm) images to your registry:

$ kubectl kots admin-console push-images kotsadm.tar.gz <your-registry-endpoint>/<your-registry-name> --registry-username <username> --registry-password <password>

Next, upgrade the Swimlane Platform Installer (SPI):

$ kubectl kots admin-console upgrade --kotsadm-registry <your-registry-endpoint>/<your-registry-name> --registry-username <username> --registry-password <password> -n <namespace>

When the SPI upgrade is complete, upload the Turbine airgap bundle to the SPI dashboard.

Go to the Version History tab and click Upload a new version, then browse to the turbine-23.5.7.airgap file and click Upload.

The sequence number “_266” of the airgap file may be higher than shown if a new sequence has been published

Once the upload of the airgap completes, refresh the page or switch tabs to see the status of the file extraction.

Go to the Version History tab - you will see a version for 23.5.7 and Click on configure

Click Deploy on the new 23.5.7 version at the top of the versions list.

Once the Application tab shows ‘Ready’ your upgrade is complete.