In-Place Upgrade

You can use the in-place upgrade strategy to upgrade the Control Plane (CP).

The in-place upgrade strategy reuses the existing database. During the upgrade process, modifications to your configuration through API or continued CP operations are prohibited.

Therefore, this upgrade method will result in some downtime for the CP, as shown in the diagram below:

Preparation

1. Read the upgrade guide and ensure you understand how the entire upgrade process is executed.
2. Note the downtime during this upgrade process and confirm an appropriate upgrade timing.
3. Backup your data.

In-Place Upgrade Steps

info

The implementation steps below are for reference only. The actual execution 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 API7 Enterprise installation method (Docker, Kubernetes), modify the image versions of api7-ee-dashboard and api7-ee-dp-manager in the corresponding configuration files (docker-compose, helm chart).
6. Restart the CP using the modified configuration files.
7. Access the Dashboard to check if it is running properly.
8. If you encounter any issues, please refer to Rollback Upgrade.
9. After observing for a period of time with no additional issues, the CP upgrade is complete.

Next Steps

After completing the CP upgrade, you can begin preparing to upgrade the DP.