Migration from on-premises deployment to SaaS instance

Foreword

Migration is a very time consuming process if you have a lot of data stored in your on-premises instance. So, please plan the downtime and request our assistance if you 100% certain you are going to move to SaaS.

Availability of SaaS instance

Start of the migration process requires ready for use cloud instance, so please request to create one before the start of the migration procedure. Provide the payment information for the created instance (Administration > License >. Manage) to prevent any data loss.

On premises instance release requirements

It is possible to migrate the data from 3.193.0 and above. If your on-premises instance has release id less than 3.193.0, you need to upgrade to at least to 3.193.0

Data migration support request

Create a support request.

type: Support

subject: "Migration to SaaS <instance_name>.testops.cloud for <your_company_name>". 

Add information about the release of the instance you have deployed on premises.

Add one more time URL of the created SaaS instance to restore data to.

Preparation

Cleaning the artefacts. 

Please read the following article covering the data types stored in Allure TestOps.

Please read the article covering the creation of the cleanup rules.

Check out these scripts, which could help you save a little of time on the creation of the cleaner schema.

1. Enable aggressive cleanup rules as the storage of an instance in SaaS is limited by 60 Gigabytes of data. 
   • Rules must include the following (creating global rules for all projects would be sufficient):
     • Passed tests: scenarios, fixtures, attachments. Preferably keep last 48 hours.
     • Failed tests: scenarios, fixtures, attachments. Preferably keep last 48 hours.
     • Unknown tests: scenarios, fixtures, attachments. Preferably keep last 48 hours.
     • Broken tests: scenarios, fixtures, attachments. Preferably keep last 48 hours.
2. Manually trigger the cleanup process start by executing the following API calls in the order as it is displayed on the picture below
   • access the swagger page (ALLURE-URL/swagger-ui.html) and locate the section "Cleanup controller"
   • execute following three methods in the displayed order

• if you have a huge amount of the artefacts the commands 1 and 2 could result in an error in the UI, but on the backend the process will be completed.
• you need to wait each command to complete before executing the next one

The deletion of the artefacts will take considerable time, especially if you haven't had any cleanup rules created. You can check the progress by executing the SQL command against the report service database, see the command here. 

As soon as the queue is zero, you can proceed to the next steps.

Prepare the data for migration

1. Stop all activities on Allure TestOps instance (stop gateway service or a load balancer or turn off routes towards Allure TestOps on your ingress controller).
2. Stop report and uaa services.
3. Create dump of uaa database, see here.
   • Archive the data with a strong password.
4. Create dump of report database, see here.
   • Archive the data with a strong password.
5. Create an archive with full backup of the artefacts storage (full backup of v2 folder and all folders on the same level as v2).
   • Consult with the support on how to locate the artefacts storage if you have any concerns.
6. Upload the gathered data (protected archives) to a cloud storage of your choice.
7. Provide links to the uploaded files to the current request alongside with the passwords if any to the created support request.

Data restoration

Timeline

The data restoration usually takes up to 24 hours in case of many small artefacts.As soon as the databases are restored, files are copied, you will be informed by the support ticket in the created request.