Thanks for the information. I would advise visiting the official documentation of each storage component to find out the best approach to backup and restore. There is a thread on something similar, so it could prove helpful.
Regarding the steps to follow, I have outlined a couple of important things to note below:
- Read the release notes of the target version you desire to upgrade to and watch out for gotchas and breaking changes e.g. v3.2 and above introduces new changes to GraphQL
- Visit the documentation of your storage components to understand how to backup and restore them in isolated situations
- Prepare a backup and a post upgrade checklist. I have assisted with a sample at the bottom of this reply
- Backup essential components, configuration files and services for restoration in case of service failure during/after upgrade
- Follow our upgrade guidance based on your Tyk offering and sequentially upgrade each component as outlined to thee target version
Backup Checklist
- Backup storage data - MongoDB (via mongodump or manually) and Redis (via BGSAVE)
- Backup config files (gateway, dashboard/analytics, and pump)
- Backup portal assets (/opt/tyk-dashboard/) if a custom portal has been created
- Backup definition files (API and Policy) if no persistent storage exists
Post Upgrade Checklist (not exhaustive)
- Examine the dashboard UI and establish no functionaly is broken
- Verify portal is working as expected
- Validate Gateway endppint is up and running with the “hello” endpoint
- Try out the dashboard APIs
- Check APIs are accessible via the gateway
- Test current and new keys. Check Redis for hash
- Evaluate output of plugins
- Confirm analytics data is visible in reports