Backup, import and export of Requirement Yogi data across Confluence and Jira instances
New in 3.4.8
The backup / export / re-import feature was added in Requirement Yogi 3.4.8 (November 2022).
Prologue
Some customers in the situation of a merger-acquisition, decide to centralize all their Confluence and Jira instances, by migrating space-by-space to a new large Data Center cluster. The major difficulty is that database tables of Requirement Yogi can't simply materialize the foreign keys to entities of Confluence, because the plugin data is isolated from Confluence entities (and this is generally an excellent choice, albeit with this drawback). Therefore, the customers who chose to perform this move had to understand the data, reimport in the new instance and update the foreign keys on the fly, to point to new space keys, new page IDs, etc. It can take weeks to perform this operation, with an EDI, a database consultant and our help.
The goal is to accelerate this process to a few hours, however we can't totally automate it given the complexity of situations.
In what situations can this be used?
Situation | Is it supported? |
---|---|
Confluence* DC** instance → New Confluence DC instance Export and reimport a whole instance, with all the data. * Same with Jira ** Server and Data Center are both supported. | Yes, it is supported.
Note that Confluence and Jira are imported separately, therefore:
|
Confluence DC → Same Confluence DC, but later in time. | Yes, but if it is for an entire Confluence instance, there is no reason to do that.
|
Confluence DC space → Same space, later in time. | Yes, with the following pitfalls:
[1] The range is calculated automatically when the schema changes, so we cannot publish a matrix |
Confluence DC space → another Confluence DC instance. Ideal for merger-acquisitions, Ideal for centralization into a large Confluence/Jira DC cluster. | Yes, it is supported.
|
Confluence space → New Confluence space with different key. Rename a space | Yes, it is supported.
|
Migrate from DC to the Cloud | Use CCMA/JCMA to migrate to the Cloud: https://confluence.intranet.requirementyogi.com/wiki/spaces/RY/pages/1808662529 |
Migrate from the Cloud to DC | Not supported. |
Of course, before committing to using the software in a particular way, please test that it fits your situation. As a reminder, to the maximum extent permitted by applicable law, this software is provided by Requirement Yogi "as is". Any express or implied warranties, including, but not limited to, the implied warranties of fitness for a particular purpose are disclaimed.
In what situations will it be difficult?
Situation | Difficulty |
---|---|
A space is renamed | Requirement entities will be fine, but:
|
A Jira project is renamed | Same as above: Please also update the references in Confluence, since there are links to Jira, and this can be performed by exporting-then-reimporting the Confluence side. |
Requirements are moved to a new instance | No difficulty, you just have to remap to a new Applink URL. |
All page IDs have changed. | This happens when you import on a new Confluence instance.
|
There are requirements in Excel files. | We will reimport as-is, but the Excel attachment IDs will be wrong, since we do not remap them. Links to the Excel files will be broken, but the requirements will still exist. |
What are the steps of the export / re-import process?
See What are the steps of export / re-import? for an overview of the process.
See How to carefully perform the mappings for the backup import/export step? for the most important part of it.
How to script it or schedule it?
We don’t have automatic backups because it is only used in the situation of backups, and we don’t want to encourage customers to add workload and disk usage on their instance.
The backups are made in background jobs. They can be triggered using a REST API request,
To see which call, open the network panel while performing a backup, and monitor all calls to POST /rest/reqs/1/backups. It will provide the correct payload to send.
If you are unable to extract the information using this general instruction, it will be too difficult for you to manage the rest of the process. In this situation, we recommend just relying on global Confluence backups.
After extracting the correct calls, you can write a script on your servers to make it happen automatically (cronjob).
Thank you