Swimlane 10.18.3 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.

Important Notes!

For customers with Swimlane clusters with other than one or three nodes, please contact Support before proceeding.

A new fixed version of the "Swimlane Email Plugin" has been released alongside version 10.18.3 to address a bug with rendering email to image. It is recommended to download and install the latest version of the plugin from apphub.swimlane.com.

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.17+

If you are not on a version that is >= 10.17, contact your Swimlane support representative.

MongoDB 6.0.14

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

If swimlane uses an external MongoDB, then scale down the cluster, that is deployments and stateful sets (sts) replicas to 0. Then upgrade your external MongoDB servers to version 6.0.14 and then follow the upgrade instructions.

During startup of the external mongo process we need to pass the below commands,

--tlsAllowConnectionsWithoutCertificates --tlsAllowInvalidCertificates

kubectl scale deploy <deployment name> -n <name space> --replicas=0kubectl scale sts <sts name> -n <name space> --replicas=0

Upgrade Instructions:

SSH into any node in your deployment and execute the following command to begin the Swimlane Platform Installer component upgrade:

$ curl -sSL https://kurl.sh/swimlane-platform-stable-10-18-3 | sudo bash -s ha

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

installer-spec-file=se.yaml

A Kubernetes upgrade may be needed depending on the current version in the environment. 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:

✔ Kubernetes host packages installednode/ip-10-1-0-147.swimlane.io already uncordonedDrain node ip-10-1-0-186.swimlane.io to prepare for upgrade? (Y/n) y...pod/swimlane-syslog-receiver-86f79c8fd6-2rvwt evictedpod/swimlane-tasks-5dfd4d5f94-tkrb2 evictednode/ip-10-1-0-186.swimlane.io evicted Run the upgrade script on remote node to proceed: ip-10-1-0-186.swimlane.io curl https://kurl.sh/swimlane-platform-stable-10-18-0/upgrade.sh | sudo bash -s kubernetes-version=1.28.7

Run the upgrade command on the node that was drained. Use to find the IP of the node that was drained.

kubectl get nodes -o wide

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 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.

Go to the Version History tab and look for the new published versionIf this version doesn’t show up initially, click Check For Updates.

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

Click Deploy on the new 10.18.3 version with the highest sequence number at the top of the versions list (currently 10.18.3_XXX).

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.17 or greater If you are not on a version that is >= 10.17, contact your Swimlane support representative.

MongoDB 6.0.14

Kubernetes 1.27 to 1.30

KOTS kubectl plugin 1.110.x

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 Kotsadm to v1.110.0:

Download the latest SPI kubectl add-on for the OS version where you run kubectl commands from:

$ curl https://kots.io/install/v1.110.0 | bash$ kubectl kots version

The KOTS kubectl plugin version should match what is listed in the prerequisites above.

Upgrading Velero to 1.13:

See the Velero documentation for details: Velero Docs - Upgrading to Velero 1.13

Upgrade the Swimlane KOTS application:

Next, upgrade the Swimlane Platform Installer (SPI):

$ kubectl kots admin-console upgrade -n <namespace>

Go to the Version History tab and look for the new published versionIf this version doesn’t show up initially, click Check For Updates.

A pop-up window appears, click Go to updated version or visit the Version History tab.

Click Deploy on the new 10.18.3 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.17+If you are not on a version that is >= 10.17, contact your Swimlane support representative.

MongoDB 6.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.18.3_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 install 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-imagesHave 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.

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):

✔ Kubernetes host packages installednode/ip-10-1-0-147.swimlane.io already uncordonedDrain node ip-10-1-0-186.swimlane.io to prepare for upgrade? (Y/n) y...pod/swimlane-syslog-receiver-86f79c8fd6-2rvwt evictedpod/swimlane-tasks-5dfd4d5f94-tkrb2 evictednode/ip-10-1-0-186.swimlane.io evictedRun the upgrade script on remote node to proceed: ip-10-1-0-186.swimlane.iocat upgrade.sh | sudo bash -s kubernetes-version=1.28.7 docker-registry-ip=10.96.3.115

When both upgrade scripts are complete, press Enter on node 1 and then upload the airgap bundle to the SPI dashboard.

Go to the Version History tab and click Upload a new version, then browse to the swimlane-platform-10.18.3_XXX.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 back to the Version History tab and click Deploy on the new 10.18.3 version 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 Airgap Cluster Installations Prerequisites

Swimlane version 10.17+ If you are not on a version that is >= 10.17, contact your Swimlane support representative.

MongoDB 6.0.14

Kubernetes 1.27-1.30

KOTS kubectl plugin 1.110.0

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 Kotsadm to v1.110.0:

Download the KOTS Kubectl Add-on

Linux: https://github.com/replicatedhq/kots/releases/download/v1.110.0/kots_linux_amd64.tar.gz OSX: https://github.com/replicatedhq/kots/releases/download/v1.110.0/kots_darwin_all.tar.gz

Download the latest SPI offline package:

https://github.com/replicatedhq/kots/releases/download/v1.110.0/kotsadm.tar.gz

Copy the KOTS Kubectl Add-on and SPI offline packages from your jumpbox to each node:

$ 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 version

$ kubectl kots version

Upgrade past Velero 1.13.x:

See the Velero documention for details. You’ll have to use a jumpbox to download the new images and move them over. Velero Docs - Upgrading to Velero 1.13

Confirm both client and server version are on the same 1.13.0 release:

$ ./velero version

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.

Go to the Version History tab and click Upload a new version, then browse to the swimlane-platform-10.18._XXX.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 10.18.3_XXX.

Click Deploy on the new 10.18.3_XXX 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.

Update the Swimlane Python Driver Python Package

Beginning with Swimlane version 10.2.0, the Python Driver swimlane Python package must be manually updated after an upgrade.

Delete the old swimlane Python package.

Update the swimlane Python package in the Swimlane UI to version 10.18.3If this is an embedded airgapped upgrade, please download the swimlane Python wheel (.whl) package from here and update it in the Swimlane UI.

Restart the Swimlane API and tasks pods with this command:

kubectl rollout restart deployments/swimlane-api deployments/swimlane-tasks

Download and Push New Velero Images

Use these commands to download and push new Velero images.

cker pull velero/velero:v1.13.2$ docker tag velero/velero:v1.13.2 <my-registry>/<my-namespace>/velero/velero:v1.13.2$ docker push <my-registry>/<my-namespace>/velero/velero:v1.13.2$ docker pull velero/velero-restic-restore-helper:v1.13.2$ docker tag velero/velero-restic-restore-helper:v1.13.2 <my-registry>/<my-namespace>/velero/velero-restic-restore-helper:v1.13.2$ docker push <my-registry>/<my-namespace>/velero/velero-restic-restore-helper:v1.13.2$ docker pull velero/velero-plugin-for-aws:v1.9.1$ docker tag velero/velero-plugin-for-aws:v1.9.1 <my-registry>/<my-namespace>/velero/velero-plugin-for-aws:v1.9.1$ docker push <my-registry>/<my-namespace>/velero/velero-plugin-for-aws:v1.9.1$ docker pull velero/velero-plugin-for-gcp:v1.9.0$ docker tag velero/velero-plugin-for-gcp:v1.9.0 <my-registry>/<my-namespace>/velero/velero-plugin-for-gcp:v1.9.0$ docker push <my-registry>/<my-namespace>/velero/velero-plugin-for-gcp:v1.9.0$ docker pull velero/velero-plugin-for-microsoft-azure:v1.9.1$ docker tag velero/velero-plugin-for-microsoft-azure:v1.9.1 <my-registry>/<my-namespace>/velero/velero-plugin-for-microsoft-azure:v1.9.1$ docker push <my-registry>/<my-namespace>/velero/velero-plugin-for-microsoft-azure:v1.9.1

Troubleshooting

Upgrading will sometimes leave the Hangfire notifications in a corrupted state. The swimlane-api and swimlane-tasks pods will be crashlooping with logs of this form

swimlane-api:Hangfire.Mongo.Migration.MongoMigrationException: Migration failed in Hangfire.Mongo.Migration.Steps.Version17.AddNotificationsCollectionswimlane-tasks:Core.ErrorHandling.ContractRequiresException: RabbitMQConnectionString is not defined in Orchestration configuration.

2. Dropping the Hangfire notifications collection in Mongo will remedy this.

kubectl exec swimlane-tools-0 -- /bin/bash -c 'mongo $SWIMLANE_Data__Mongo__SwimlaneConnectionString --quiet --tls --tlsAllowInvalidCertificates --eval \'db["hangfire.notifications"].drop()\''