Upgrading Lens AppIQ Control Plane

You can upgrade the Lens AppIQ control plane running in your clusters when updates are available for any of our controllers. Such upgrades ensure users enjoy our latest features, security patches, and important bug fixes.

When clusters are eligible to be upgraded, our UI displays a visual indication (a blue tag stating "Upgrade Available") next to their name to indicate that at least one controller/agent running in the cluster can be updated.

To upgrade clusters connected to Lens AppIQ, follow the steps below:

Visit the section Clusters in the UI and locate a cluster with an Upgrade notice.

Go to the details page of that cluster by clicking on it to see which pieces of the control plane have available upgrades.

Click the button Upgrade located in the top left corner of the panel.

Copy the kubectl command automatically generated, and run it in a terminal connected to your cluster. By executing the command, a new chart will be installed in your cluster, and our control plane will start its upgrade

$ kubectl apply -f "https://api.lenscloud.io/cluster-connect?authToken=..."
namespace/shipa configured
secret/sh.helm.release.v1.shipa-agent.v1 configured
serviceaccount/shipa-agent unchanged
secret/shipa-agent unchanged
configmap/shipa-agent-config configured
clusterrole.rbac.authorization.k8s.io/shipa-agent-general unchanged
clusterrole.rbac.authorization.k8s.io/shipa-agent-autodiscovery-shipa-controller unchanged
clusterrole.rbac.authorization.k8s.io/shipa-agent-autodiscovery-helm unchanged
clusterrole.rbac.authorization.k8s.io/shipa-agent-containermetrics-busybody unchanged
clusterrole.rbac.authorization.k8s.io/shipa-agent-containermetrics-helm unchanged
clusterrolebinding.rbac.authorization.k8s.io/shipa-agent-general unchanged
clusterrolebinding.rbac.authorization.k8s.io/shipa-agent-autodiscovery-shipa-controller unchanged
clusterrolebinding.rbac.authorization.k8s.io/shipa-agent-autodiscovery-helm unchanged
clusterrolebinding.rbac.authorization.k8s.io/shipa-agent-containermetrics-busybody unchanged
clusterrolebinding.rbac.authorization.k8s.io/shipa-agent-containermetrics-helm unchanged
role.rbac.authorization.k8s.io/shipa-agent-general unchanged
role.rbac.authorization.k8s.io/shipa-agent-autodiscovery-shipa-controller unchanged
rolebinding.rbac.authorization.k8s.io/shipa-agent-general unchanged
rolebinding.rbac.authorization.k8s.io/shipa-agent-autodiscovery-shipa-controller unchanged
service/shipa-agent-api unchanged
deployment.apps/shipa-agent configured

You can oversee the upgrade process directly on your cluster by running the command kubectl get pods -n shipa -w to watch how the necessary pods are upgraded.

$ kubectl get pods -n shipa -w
NAME                               READY   STATUS    RESTARTS   AGE
shipa-busybody-xrx9x               1/1     Running   0          5h33m
shipa-agent-5dfd475986-dgh8d       1/1     Running   0          4h5m
shipa-controller-849dd6698-59kvw   1/1     Running   0          19m
shipa-agent-5f5bcd8598-cr7x2       0/1     Running   0          8s
shipa-controller-657c4df64-4f847   0/1     Pending   0          0s
shipa-controller-657c4df64-4f847   0/1     Pending   0          0s
shipa-controller-657c4df64-4f847   0/1     ContainerCreating   0          0s
shipa-controller-657c4df64-4f847   0/1     Running             0          1s
shipa-agent-5f5bcd8598-cr7x2       1/1     Running             0          31s
shipa-agent-5dfd475986-dgh8d       1/1     Terminating         0          4h6m
shipa-agent-5dfd475986-dgh8d       0/1     Terminating         0          4h6m
shipa-agent-5dfd475986-dgh8d       0/1     Terminating         0          4h6m
shipa-agent-5dfd475986-dgh8d       0/1     Terminating         0          4h6m
shipa-agent-5dfd475986-dgh8d       0/1     Terminating         0          4h6m
shipa-controller-657c4df64-4f847   1/1     Running             0          20s
shipa-controller-849dd6698-59kvw   1/1     Terminating         0          19m
shipa-controller-849dd6698-59kvw   0/1     Terminating         0          19m
shipa-controller-849dd6698-59kvw   0/1     Terminating         0          19m
shipa-controller-849dd6698-59kvw   0/1     Terminating         0          19m
shipa-controller-849dd6698-59kvw   0/1     Terminating         0          19m

You can also visit the Events page on the UI or go back to the Cluster Details section to visualize how the cluster will reflect the status changes while it upgrades.

Once the shipa-agent gets updated, the first stage of the process will be completed. Now, wait a couple more seconds for the agent to verify the state of other controllers and to report the proper status for each in the UI.

🚧
Errors during the upgrade
It is possible that your cluster will be reported in an "error" state in the UI while the upgrade is completed. Please allow up to 5 minutes for our agent to consolidate the process and report the right status for each component in the control plane

Once all pods in the Control Plane tab are reported as Running and the "Upgrade Available" notice is removed, the process can be considered completed.