|
| 1 | +--- |
| 2 | +weight: 10 |
| 3 | +--- |
| 4 | + |
| 5 | +# Upgrade `Alauda DevOps Pipelines` Operator |
| 6 | + |
| 7 | +This document provides instructions for upgrading the `Alauda DevOps Pipelines` Operator to a newer version using the `Marketplace`/`OperatorHub` interface in your cluster. The upgrade process is designed to be straightforward while ensuring minimal disruption to existing Tekton resources. |
| 8 | + |
| 9 | +## Upgrade Overview |
| 10 | + |
| 11 | +Upgrading the `Alauda DevOps Pipelines` Operator allows you to access new features, bug fixes, and improvements to the Tekton ecosystem. The `Alauda DevOps Pipelines` Operator handles the upgrade of all Tekton components (Pipelines, Triggers, Hub, etc.) according to your configuration. |
| 12 | + |
| 13 | +## Before You Begin |
| 14 | + |
| 15 | +Before upgrading the `Alauda DevOps Pipelines` Operator, ensure you: |
| 16 | + |
| 17 | +- Have administrative access to your cluster |
| 18 | +- Review the release notes for the new version to understand any breaking changes |
| 19 | +- Verify that your existing Tekton component configurations are compatible with the new version |
| 20 | +- Confirm that all Tekton components are in a ready state |
| 21 | + |
| 22 | +## Upgrade Process |
| 23 | + |
| 24 | +### Using `Marketplace`/`OperatorHub` |
| 25 | + |
| 26 | +1. **Access the `Marketplace`/`OperatorHub`** |
| 27 | + - Log in to your cluster's management console |
| 28 | + - Navigate to the `Marketplace` or `OperatorHub` section |
| 29 | + |
| 30 | +2. **Locate the `Alauda DevOps Pipelines` Operator** |
| 31 | + - Search for `Alauda DevOps Pipelines` in the search bar |
| 32 | + - Click on the `Alauda DevOps Pipelines` card |
| 33 | + |
| 34 | +3. **View Available Versions** |
| 35 | + - On the `Alauda DevOps Pipelines` Operator details page, you'll see information about the currently installed version |
| 36 | + - The interface will indicate if a newer version is available |
| 37 | + - You can click different `Channels` to view all available versions |
| 38 | + |
| 39 | +4. **Initiate the Upgrade** |
| 40 | + - If the target version is in a different `Channel`, switch to the corresponding `Channel` in the `Subscription` first |
| 41 | + - If the current `Channel` has a newer version available, you will see a prompt: |
| 42 | + - **New Version Detected** |
| 43 | + - To upgrade only the current Operator, click `Confirm` to upgrade. |
| 44 | + |
| 45 | +5. **Configure Upgrade Settings (if applicable)** |
| 46 | + - Some upgrades may present configuration options |
| 47 | + - In most cases, the default settings will preserve your existing configuration |
| 48 | + |
| 49 | +6. **Confirm and Start the Upgrade** |
| 50 | + - Click `Confirm` to begin the process |
| 51 | + - Review the upgrade details and confirm your selection |
| 52 | + - The system will update the `Alauda DevOps Pipelines` Operator while maintaining your custom resources |
| 53 | + |
| 54 | +7. **Monitor the Upgrade** |
| 55 | + - The upgrade progress will be displayed in the `OperatorHub` interface |
| 56 | + - You can also check the status in the `tekton-operator` namespace: |
| 57 | + ```bash |
| 58 | + $ kubectl get pods -n tekton-operator |
| 59 | + ``` |
| 60 | + When all pods are in `Running` state, the operator upgrade is complete. |
| 61 | + The operator will then automatically upgrade components such as `Pipelines`, `Triggers`, `Hub`, `Chains`, etc. |
| 62 | + - Check the components upgrade status: |
| 63 | + ```bash |
| 64 | + $ kubectl get tektoninstallerset -A |
| 65 | + $ kubectl get pods -n tekton-pipelines |
| 66 | + ``` |
| 67 | + When all components and pods are in `Ready` state, the components upgrade is complete. |
| 68 | + |
| 69 | +8. **Verify the Upgrade** |
| 70 | + - Check that the `Alauda DevOps Pipelines` Operator version has been updated: |
| 71 | + ```bash |
| 72 | + $ kubectl get csv -n tekton-operator |
| 73 | + |
| 74 | + NAME DISPLAY VERSION REPLACES PHASE |
| 75 | + tektoncd-operator.v4.x.x Alauda DevOps Pipelines 4.x.x x Succeeded |
| 76 | + ``` |
| 77 | + When the `VERSION` matches the new version, the upgrade is complete. |
| 78 | + - Verify that your Tekton components are functioning correctly |
| 79 | + - Test that your pipelines can run successfully |
| 80 | + |
| 81 | +## Post-Upgrade Steps |
| 82 | + |
| 83 | +After the upgrade completes successfully: |
| 84 | + |
| 85 | +1. **Verify Component Status** |
| 86 | + - Check that all Tekton components have been updated: |
| 87 | + ```bash |
| 88 | + kubectl get tektonconfig,tektonpipeline,tektontrigger -A |
| 89 | + kubectl get tektoninstallerset -A |
| 90 | + ``` |
| 91 | + |
| 92 | +2. **Test Functionality** |
| 93 | + - Run a simple pipeline to verify that the system is working correctly |
| 94 | + - Ensure that all existing integrations continue to function |
| 95 | + |
| 96 | +3. **Update Custom Resources if Needed** |
| 97 | + - If the new version introduces changes to CRDs, you may need to update your custom resources |
| 98 | + - Refer to the release notes for specific migration steps |
| 99 | + |
| 100 | +## Rollback Procedure |
| 101 | + |
| 102 | +If you encounter issues with the new version, you can roll back to the previous version: |
| 103 | + |
| 104 | +1. Return to the `Marketplace`/`OperatorHub` interface |
| 105 | +2. Select the `Alauda DevOps Pipelines` Operator |
| 106 | +3. `Uninstall` the current version |
| 107 | +4. Choose the previous version from the version list |
| 108 | +5. Follow the installation process for that version |
| 109 | + |
| 110 | +:::note |
| 111 | +Downgrading may require additional steps to ensure compatibility of your resources with the older version. |
| 112 | + |
| 113 | +This depends on the differences between the version you upgraded from and the version you upgraded to. If the differences are large, you may need to manually migrate resources. |
| 114 | +::: |
| 115 | + |
| 116 | +## Troubleshooting |
| 117 | + |
| 118 | +If you encounter issues during or after the upgrade: |
| 119 | + |
| 120 | +- Check the `Alauda DevOps Pipelines` Operator pod logs: |
| 121 | + ```bash |
| 122 | + $ kubectl logs -l name=tekton-operator -n tekton-operator |
| 123 | + ``` |
| 124 | + |
| 125 | +- Verify the status of your Tekton resources: |
| 126 | + ```bash |
| 127 | + $ kubectl get tektonconfig config -o yaml |
| 128 | + ``` |
| 129 | + |
| 130 | +- Ensure that all components have the expected status: |
| 131 | + ```bash |
| 132 | + $ kubectl get tektoninstallerset |
| 133 | + ``` |
| 134 | + |
| 135 | +## Next Steps |
| 136 | + |
| 137 | +After successfully upgrading the `Alauda DevOps Pipelines` Operator: |
| 138 | + |
| 139 | +- Explore new features introduced in the latest version |
| 140 | +- Update your CI/CD pipelines to leverage new capabilities |
| 141 | +- Consider enabling additional components that may be available in the new version |
0 commit comments