Upgrade/Rollback
Discovering New Versions
To stay up-to-date with the latest collector-manager versions available in the Helm repository, you can use the following command:
helm repo update
Example output:
Hang tight while we grab the latest from your chart repositories...
...Successfully got an update from the "plerion" chart repository
Update Complete. ⎈Happy Helming!⎈
This command will provide you with a list of available versions, helping you identify the most recent releases.
helm search repo plerion/collector-manager --versions
Example output:
NAME CHART VERSION APP VERSION DESCRIPTION
plerion/collector-manager v1.1.0 v1.1.0 A Helm chart for Plerion Kubernetes Capabilities
plerion/collector-manager v1.0.0 v1.0.0 A Helm chart for Plerion Kubernetes Capabilities
Upgrading Your Collector-Manager
When the need arises to upgrade your collector-manager to a new version while preserving your existing configuration, you can utilize the following helm
command. Make sure to specify the desired version you wish to upgrade to:
helm upgrade plerion-collector-manager plerion/collector-manager --reuse-values --version [version] -n plerion-system
Example output:
Release "plerion-collector-manager" has been upgraded. Happy Helming!
NAME: plerion-collector-manager
LAST DEPLOYED: Mon Nov 20 19:26:30 2023
NAMESPACE: plerion-system
STATUS: deployed
REVISION: 2
Here's a more detailed breakdown of the upgrade process:
-
plerion-collector-manager
: This is the name of your existing collector-manager Helm release. -
plerion/collector-manager
: This specifies the Helm chart repository and the collector-manager Helm chart. -
--reuse-values
: This flag ensures that your existing configuration values are retained during the upgrade. -
--version [version]
: You should replace[version]
with the specific version number you want to upgrade to. This allows you to select the desired collector-manager version for the upgrade.
By following this process, you can seamlessly update your collector-manager to the chosen version without losing your configuration settings.
Rollback
Why Rollback?
-
Unforeseen Issues
In some cases, an updated release may introduce unforeseen issues or conflicts with existing configurations. Rolling back allows users to return to a known, stable state.
-
Compatibility Concerns
Changes made during an update might not be compatible with other components or dependencies. Rolling back helps maintain compatibility within the ecosystem.
-
Emergency Situations
In critical situations, where the latest release is causing system-wide disruptions, rolling back quickly becomes a crucial step to restore functionality.
Rollback Steps
- Check Helm Release History
Before performing a rollback, it's essential to check the release history to identify the specific revision you want to rollback to. Use the following command:
helm history -n plerion-system plerion-collector-manager
Example output:
REVISION UPDATED STATUS CHART APP VERSION DESCRIPTION
1 Tue Nov 20 12:18:00 2023 superseded collector-manager-v1.0.0 v1.0.0 Install complete
2 Wed Nov 21 09:00:35 2023 superseded collector-manager-v1.0.0 v1.0.0 Upgrade complete
3 Wed Nov 22 19:00:42 2023 deployed collector-manager-v1.1.0 v1.1.0 Upgrade complete
Note the revision number of the release you want to rollback to.
- Rollback to a Previous Revision
Use the following command to rollback to a specific revision:
helm rollback -n plerion-system RELEASE_NAME REVISION_NUMBER
Replace RELEASE_NAME
with the name of your Helm release (usually "plerion-collector-manager") and REVISION_NUMBER
with the revision number from the previous step.
Example:
helm rollback -n plerion-system plerion-collector-manager 2
Example output:
Rollback was a success! Happy Helming!
- Verify Rollback
After performing the rollback, it's crucial to verify that the deployment has reverted to the desired state. Use the following command to check the status:
kubectl get pods -n plerion-system
Example output:
NAME READY STATUS RESTARTS AGE
plerion-collector-manager-ccbc55c5d-dr27w 1/1 Running 0 10m
plerion-collector-manager-ccbc55c5d-x255n 1/1 Running 0 10m
Ensure that the pods are in a stable state.
Troubleshooting
If you encounter issues during the rollback process, you can use the following command to see detailed information about the rollback:
helm status -n plerion-system plerion-collector-manager
Review the output to identify any errors or issues.