Swimlane 10.15.1 Upgrade Instructions
Use these upgrade instructions to upgrade your instance of Swimlane 10.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 Swimlane on Embedded Cluster Installations
Use the following instructions to upgrade this version of Swimlane on an embedded cluster installation.
Prerequisites:
- Swimlane version 10.13+ If you are not on a version that is >= 10.13, contact your Swimlane support representative.
- MongoDB 5.0.14
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 and execute the following command to begin the Swimlane Platform Installer component upgrade:
NOTE: If you have configured SELinux, add this to the end of the command above:
- For a multi-node (HA) cluster, the script prompts you to drain node one (1) and apply the upgrade. Once the upgrade on node one (1) is complete, the process continues running. It then asks for confirmation to drain node two (2) as well as a command to run in that node. See this example:
- Run the upgrade command on the node that was drained. Use this command to find the IP of the node that was drained:
The primary script that ran in node 1 will detect that node 2 has been upgraded, and will now ask to drain and upgrade node three (3). Follow the same steps for node 2 to complete the Kubernetes portion of the upgrade.
- Once the additional nodes are complete, press Enter in the terminal window of the first node in which you ran the install command to complete the installation.
- Log in to the Swimlane Platform Installer dashboard (https://<SwimlaneDNS>:8800).
If this version doesn’t show up initially, click Check For Updates.
- Go to the Version History tab and look for the new published version.
- A pop-up window appears, click Go to updated version.
- Click Deploy on the new 10.15.1 version with the highest sequence number at the top of the versions list.
- Once the Application tab shows ‘Ready’ your upgrade is complete.
See Update the Swimlane Python Driver Python Package if you want to update the driver at this time.
Upgrade Swimlane on Existing Cluster Installations
Prerequisites:
- Swimlane version 10.6 or greater If you are not on a version that is > 10.6, contact your Swimlane support representative.
- MongoDB 5.0.14
- Kubernetes 1.22-1.26
- KOTS kubectl plugin 1.102.0
- 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 Kotsadm to v1.102.0
Download the latest SPI kubectl add-on for the OS version where you run kubectl commands from:
The KOTS kubectl plugin version should match what is listed in the prerequisites above.
Upgrade Velero to 1.11.x
Velero 1.11 includes a change that replaces the restic daemonset with the 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:
Untar the file and then change directory (cd) into the uncompressed directory:
- Update Velero custom resource definitions:
- 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:
Upgrade the Swimlane KOTS application
- Next, upgrade the Swimlane Platform Installer (SPI):
- Log in to the Swimlane Platform Installer dashboard (https://<SwimlaneDNS>:8800). If this version doesn’t show up initially, click Check For Updates.
- Go to the Version History tab and look for the new published version.
- A pop-up window appears, click Go to updated version or visit the Version History tab.
- Click Deploy on the new 10.15.1 version with the highest sequence number at the top of the versions list.
- Once the Application tab shows ‘Ready’ your upgrade is complete.
See Update the Swimlane Python Driver Python Package if you want to update the driver at this time.
Upgrade Swimlane on Embedded Airgap Cluster Installations
Prerequisites
- Swimlane version 10.13+ If you are not on a version that is >= 10.13, contact your Swimlane support representative.
- MongoDB 5.0.14
- 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 swimlane-platform-10.15.1_xxx.tar.gz
- Run the Swimlane 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:
The script responds with this output:
- Run 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.
- The install script now runs on node 1 for a few minutes. Once it completes, follow the prompts to run the upgrade script on nodes 2 and 3, similar to this example (the IP address will depend on your deployment):
- When both upgrade scripts are complete, press Enter on node 1 and then upload the 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 swimlane-platform-10.15.1_XXX.airgap file and click Upload.
- The sequence number 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 back to the Version History tab and Click on configure on the 10.15.1 release with the highest suffix number.
- Once the Application tab shows ‘Ready’ your upgrade is complete.
See Update the Swimlane Python Driver Python Package if you want to update the driver at this time.
Upgrade Swimlane on Existing Airgap Cluster Installations Prerequisites
- Swimlane version 10.6+ If you are not on a version that is > 10.6, contact your Swimlane support representative.
- MongoDB 5.0.14
- Kubernetes 1.22-1.26
- KOTS kubectl plugin 1.102.0
- 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 Kotsadm to v1.102.0
- Download the latest SPI Kubectl Add-on Linux: https://get.swimlane.io/existing-cluster/install/linux OSX: https://get.swimlane.io/existing-cluster/install/osx
- 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 kots_<OS version>.tar.gz user@<swimlaneDNS>:/tmp/kots_<OS version>.tar.gz $ scp kotsadm.tar.gz user@<swimlaneDNS>:/tmp/kotsadm.tar.gz
- Untar the SPI Kubectl Add-on: $ tar -zxvf kots_<OS version>.tar.gz
- Rename or remove the original kubectl-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/
- Verify the version: $ kubectl kots version
Upgrade Velero to 1.11.x
Velero 1.11 includes a change that replaces the restic daemonset with the 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.0 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:
- Update Velero custom resource definitions:
- 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:
Upgrade the Swimlane KOTS application
- 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 Swimlane 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 swimlane-platform-10.15.1_XXX.airgap file and click Upload.
- If a new sequence has been published, you should use that version. Select the version with the highest sequence number.
- 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 10.15.1.
- Click Deploy on the new 10.15.1 version with the highest sequence number at the top of the versions list.
- Once the Application tab shows ‘Ready’ your upgrade is complete.
See Update the Swimlane Python Driver Python Package if you want to update the driver at this time.