Start a Migration
You can start a migration almost anywhere in the Gateway Manager:
Migrations & APIs
Environment
Resources
API: You can select the APIs to be migrated here.
Source Type: It is also possible to migrate an API from a local file to a node
Source: The source of the migration must be a node or cluster.
Target: Multiple nodes, entire clusters, and even environments can be selected as the target of the migration.
Skip Indexing: ???
Exececute Migrationn with Default Settings: ???
Migration OverviewMigration Overview
The source in this case is the git repository of the API demo in version 2.0. This API requires the library demo, which is not available on the target.
...
Perform
The migration is carried out with Perfrom. You will then receive a detailed overview.
https://apiida.atlassian.net/wiki/spaces/AAGM/pages/1520009389/Migrations#Performing-a-Migration
Test
With Test, the migration is only tested, not carried out.
https://apiida.atlassian.net/wiki/spaces/AAGM/pages/1520009389/Migrations#Testing-a-Migration
Assign
Assign can be used to commission another user to carry out the migration. If configured, this user is informed. Not every user must have the rights to carry out a migration.
https://apiida.atlassian.net/wiki/spaces/AAGM/pages/1534165110/Users#Permission-groups-(RBAC)
Download
With Download all resources of the migration can be downloaded. These include all folders that are necessary for a successful migration, the logs if the migration has already been tested or carried out, all mappings for each target, the original, unmodified bundle from Restman, the prepared bundle adapted by the Gateway Manager and prepared for the migration.
Mappings
For each resource to be migrated, there is a mapping for each target. You can use the search to search and filter by both the name and the type.
The mappings are split into two containers: In "Services and Policies" you can see all services, policies and encapsulated assertions and in "Environmental Configuration" everything else.
https://apiida.atlassian.net/wiki/spaces/AAGM/pages/1520009389/Migrations#Mappings
...
Services and Policies & Environmental Configuration
In the first column of the tables you will see the respective name of the resource for this mapping and, secondly, the type. By clicking on the eye symbol, you can view the source code of the resource and also detect the differences.
“Prediction" tells you what will happen to this resource on the target.
In "Mapping" you can see how the mapping of the source resource and the target resource came about. You can also adjust this manually here by clicking on "...".
The selected behavior for this mapping can be adjusted in "Action". For example, "Ignore" can be used to exclude a resource from the migration. A connection to the database should be set to "NewOrExisting".
The standard action can be adjusted globally in the configuration. The "Manage Default Mappings" button at the bottom takes you directly there.
The mappings can be linked using the checkbox in front of each action selection box and all of them can be changed at once using the selection box above, to the right of the search.
If you have several targets for this migration, you can also include all targets in this link by activating "Link Actions across Targets" above the selection box
can be used to save a mapping action individually for this resource.
With these tools, you can configure your migration very efficiently.
...
Requirements
APIs and libraries can have requirements and these are listed in the bottom container. Even before the migration, we check whether the requisitions are available on the target!
...
If the requirement needs to be updated or is not displayed at all, you will also receive a large warning message.
The resources of the libraries are taken from the local repositories of the Gateway Manager instance. So keep the git repositories of the libraries up to date.
Pipeline
In "Pipeline" you can perform various actions before and after the migration, such as "Disable via Admintools" or "Call an URL via GET". Default values can be set in Environments.
...
Template Variables
You should only edit the "Template Variables" if you know what you are doing.
...
Test the Migration
With "Create folder tree on destination(s)" the entire folder tree is mapped in the destination. Otherwise, the gateway would only create a maximum of two levels.
...
Perform the Migration
With "Deactivate Migrated APIs" you can play the newer version of the APIs on the gateways, but leave the old one active.
"Create folder tree on destination(s)" behaves identically as described in "Test".
...
Migration Results after
Test
After testing the migration, they get an overview of the results, the entire XML and the logs. You can also download the folders, mappings, the bundle and more.
In this case, you should evaluate why the resource could not be migrated according to the action and possibly select a different action. Also consult the logs. With "go Back to the Migration" you can return to the overview and make your adjustments. Contact our team if you have any questions! Don't forget to set your adjustment for this resource as the new default. This will save you time for the next migration!
...
Perform
There is no such thing as an only partially successful migration! If something fails in the migration, the entire migration is not carried out. Your gateway will not be in an undefined state.
...
Revert Migration
With "Revert Migration" you can completely undo a migration that has been carried out.
| Info |
|---|
This Feature is intended as an immediate recovery. If the gateway's resources have changed in the meantime, unpredictable things can happen. |