Rolling Upgrade

The nodes in the Data Plane (DP) will be upgraded using the rolling upgrade method.

Rolling upgrade means continuously adding new version DP nodes while shutting down old version DP nodes, allowing uninterrupted processing of API requests during the process.

Preparation

1. Read the upgrade guide and ensure you understand how the entire upgrade process is executed.
2. Control Plane (CP) upgrade is completed.

Rolling Upgrade Steps

info

The steps below are for reference only. The actual steps may vary depending on your deployment environment.

1. During the upgrade process, modifications to your data through API or other methods are prohibited.
2. Back up your current data, refer to the backup guide.
3. Read the upgrade considerations.
4. Check all changes between the current version and the target upgrade version.
   • Complete changelog
   • Breaking changes
5. Based on your gateway instance installation method (Docker, Kubernetes), modify the image versions of api7-ee-3-gateway in the corresponding configuration files (docker-compose, helm chart).
   • If the version update record includes changes to other configurations, please check the changelog description to confirm if other configurations need to be updated accordingly.
6. Restart the gateway instances using the modified configuration files.
   • After updating the instances in one gateway group, you can perform some tests on this gateway group to ensure normal operation. If the results are not as expected, please review the changelog again to confirm if anything was missed.
   • Continue updating and replacing the gateway instances in your other gateway groups.
7. Actively monitor all proxy metrics and send some test requests to verify normal operation after the upgrade.
8. If you encounter any issues, please refer to Rollback Upgrade.
9. After observing for a period of time with no additional issues, DP upgrade is complete.

You can now continue using API, Dashboard, and ADC to update and modify your configurations.