v1.3.* to v1.4.* Migration notes
Last updated
Last updated
If you are working on behalf of a government that is considering implementing OpenCRVS, we can help you to migrate your version of OpenCRVS.
Please contact us at
Before you start migrating, consider these questions which we would ask you if we were offering support:
What version number you are currently using?
What version number you wish to upgrade to?
3. Have you made any NodeJS or React code customisations of any kind to opencrvs-core?
4. Have you integrated OpenCRVS to another system using an API, or documented system client?
5. Have you completely configured OpenCRVS?
6. Have you setup real registrar users in the system?
7. Are you already registering real citizens in testing or production?
8. Have you deployed OpenCRVS to a server environment? If so, answer these additional questions:
Please tell us if you have dedicated or shared servers
Do you have independent development (staging), quality assurance and production servers? Tell us what you have.
What are the specifications of your servers?
Are you running OpenCRVS on a cluster of 1, 3 or 5 servers?
Have you provisioned a backup server and automated emergency backups as documented?
How much free disk space and RAM is generally available on each server?
The changes in 1.4.0 are all to do with DevOps and infrastructure improving security in many ways.
The next task requires you to pull latest changes in core and our countryconfig repository, resolve conflicts in your countryconfig repository and merge.
Navigate to your opencrvs-core directory, checkout the release-v1.4.0 or master branch and pull latest changes. Yarn install any dependency upgrades:
You will now have the core release code. Your next step is to pull countryconfig release code.
Navigate to your forked country configuration repo
Checkout the release-v1.4.0 or master branch and pull latest changes from our repo into a branch that is dedicated for this upgrade.
Fix conflicts, merge and test according to your strategy.
Refer to our release notes in order to understand breaking changes
If you have hosted AND CONFIGURED OpenCRVS on a server and are capturing live registrations in production, YOU MUST: make a backup of your data before proceeding so that you can restore in the event of any migration problems. THIS BACKUP MUST BE DOWNLOADED, SO YOU HAVE A 2ND COPY STORED EXTERNALLY FROM YOUR SERVER BEFORE PROCEEDING. THIS BACKUP MUST BE RESTORED SUCCESSFULLY ON A QUALITY ASSURANCE / STAGING / TEST SERVER TO ENSURE IT WORKS BEFORE CONTINUING.
The cleanest approach for upgrading server environments is to provision an entirely new set of servers and then restore your back up onto them.
When your new servers are running with your restored backup, login to Kibana, and visit Observability > Logs. Search for the migration microsevice logs like this:
You want to check that any database migrations ran successfully and that there were no errors.
The best thing to do is to read the entire section again before planning how best to upgrade and migrate your code.
Follow all the steps in
Follow the documentaion in