Turbine 24.1.0 Upgrade Instructions
Use these upgrade instructions to upgrade your instance of Turbine 24.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.
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.5.x+
- MongoDB 5.0.24
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. Note: EKCO and Kotsadm-rqlite will automatically scale back up after the script in Step 3 has completed.
- Execute the following command to begin the Turbine Platform Installer component upgrade:
NOTE: If you have configured SELinux, add this to the end of the command above:
- Execute the following command to begin the Turbine Platform Installer component upgrade:
- 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 24.1.0 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.5.x+
- MongoDB 5.0.24
- Kubernetes 1.25-1.28
- KOTS kubectl plugin 1.108.3
- Velero 1.13.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.12.x
- Verify if Velero needs to be updated
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.12.x for your OS version:
Untar the file and then change directory (cd) into the uncompressed directory:
- Upgrade container images as instructed in the Velero upgrade to 1.12.0 article, upgrade to 1.13
- Confirm that both the client and server versions are on the same 1.12.0 release:
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:
- Rename the kots binary to kubectl-kots:
- Move the kubectl-kots binary into your PATH so that it can be recognized by kubectl (e.g. /usr/local/bin/)
- Run the upgrade command:
- 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 24.1.0
- 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.5.x+If you are not on a version that is >= 11.0, contact your Swimlane support representative.
- MongoDB 5.0.24
- 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.
- Scale down EKCO and kotsadm-rqlite. Note: EKCO and Kotsadm-rqlite will automatically scale back up after the script in Step 3 has completed.
- Run the Turbine Platform Installer update on any node in your deployment:
- 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
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.
- Log in to the Turbine Platform Installer dashboard (https://<SwimlaneDNS>:8800).
- The sequence number “_xxx” 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-24.1.0.airgap file and click Upload.
- Go back to the Version History tab and click Deploy on the new 24.1.0 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.5.x+
- MongoDB 5.0.24
- Kubernetes 1.25-1.28
- KOTS kubectl plugin 1.108.3
- Velero 1.13.x
- Turbine 24.1.0 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.12.x
- Verify if Velero needs to be updated
Velero 1.12 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.12.x for your OS version:
- Untar the file and then change directory (cd) into the uncompressed directory:
- Update Velero custom resource definitions:
- 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.12.0 article, upgrade to 1.13
- Confirm that both the client and server versions are on the same 1.12.0 release:
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:
- 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:
- Untar the SPI Kubectl Add-on:
- Rename or remove the originalkubectl-kots file:
- Rename and move the latest SPI Kubectl Add-on file to /usr/local/bin/kubectl-kots
- Push the SPI (kotsadm) images to your registry:
- Next, upgrade the Swimlane Platform Installer (SPI):
When the SPI upgrade is complete, upload the Turbine airgap bundle to the SPI dashboard.
- Log in to the Swimlane Platform Installer dashboard (https://<SwimlaneDNS>:8800).
- Go to the Version History tab and click Upload a new version, then browse to the turbine-24.1.0.airgap file and click Upload.
- The sequence number “_xxx” 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 24.1.0 and Click on configure
- Click Deploy on the new 24.1.0 version at the top of the versions list.
- Once the Application tab shows ‘Ready’ your upgrade is complete.
NOTE: It may be necessary to perform a rolling restart if you notice unexpected behavior post upgrade. Please follow the steps in the following article, Restarting Services in Swimlane Using Kubernetes Rollout Restart Commands