This document describes the process for upgrading your system to the Cequence Unified API Protection (UAP) platform version 8.1.0, which includes upgrading Elasticsearch from version 7.17.21 to 8.18.4. The document also provides rollback instructions to version 8.0.3-ES8 if problems occur during or after the upgrade.
Pre-upgrade requirements
Before starting the upgrade process, confirm the following conditions.
- Confirm that your current system runs UAP version 8.0.3.
- Have a plan in place to roll back to the 8.0.3-ES8 release.
Upgrade procedure
Follow these steps in order to upgrade your system to UAP 8.1.0.
Export configuration
- Export all current system configurations to preserve settings for potential rollback scenarios.
Upgrade ECK operator
- Update the ECK operator to version 2.16.1.
- From the elastic-system namespace, verify the upgrade by checking pods and deployments.
- Confirm the operator image version displays 2.16.1.
SaaS only: enable mixed architecture support
- Edit the cluster service configuration to enable ARM/AMD mixed architecture support.
Upgrade UAP to version 8.1.0
- Run the Helm upgrade command to install version 8.1.0.
- Monitor the upgrade process as the system recreates pods.
- Monitor the health of the Elasticsearch cluster during the upgrade process.
- Confirm that all components have upgraded successfully.
Post-upgrade verification
- Confirm that all pods display a running status.
- Confirm that the UAP version displays as 8.1.0.
- Confirm the Elasticsearch version displays as 8.18.4.
- Confirmthat the Elasticsearch cluster health shows green status.
- Review system logs for errors or warnings.
Monitoring period
- Monitor system performance for several hours after upgrade completion.
- Check error logs for unusual behavior patterns.
- Confirm all system components function correctly.
- Monitor Elasticsearch performance metrics and resource usage.
Rollback
Use this procedure to roll back to version 8.0.3-ES8, which maintains compatibility with Elasticsearch 8.x.
About version 8.0.3-ES8
Elasticsearch does not support direct downgrades between major versions, such as from version 8.x to 7.x. Rolling back from the 8.1 release of the Cequence UAP to the 8.0 release involves such a downgrade. To work with this issue, use the 8.0.3-ES8 release as your fallback target.
The 8.0.3-ES8 release of the Cequence UAP has the following characteristics.
- Built on the stable UAP 8.0.3 release foundation.
- Modified for Elasticsearch 8.x compatibility instead of the original 7.x compatibility.
- Maintains identical UAP functionality to version 8.0.3 while supporting newer Elasticsearch versions.
- Serves as a universal rollback target regardless of your starting 8.0.x version (8.0.0, 8.0.1, 8.0.2, or 8.0.3).
This approach enables UAP functionality rollback while maintaining Elasticsearch on version 8.x, along with the improvements that stem from that upgrade.
(SaaS only) Disable mixed architecture support
- For SaaS deployments that enabled mixed architecture support during upgrade, disable this feature before proceeding with the rollback.
Downgrade to version 8.0.3-ES8
- Run the Helm upgrade command with version specification set to 8.0.3-ES8.
- Monitor the downgrade process as components revert to the earlier version.
- Confirm that all components complete the downgrade successfully.
- Confirm that Elasticsearch remains on version 8.x while becoming compatible with UAP 8.0.3-ES8.
Note: Regardless of your starting 8.0.x version, the system will roll back to version 8.0.3-ES8.
Scale down BA StatefulSet and recreate volume
- Scale the BA StatefulSet to zero replicas.
- Wait for all pods to terminate completely.
- Delete the persistent volume claim associated with the BA StatefulSet.
- Scale the StatefulSet to the desired number of replicas.
- Monitor pod recreation and initialization processes.
Post-rollback verification
- Confirm all pods display a running status.
- Verify the UAP version shows 8.0.3-ES8.
- Confirm that Elasticsearch remains on version 8.x and functions properly.
- Review system logs for errors or warnings.