How to migrate flows
Prerequisites
Install docker and obtain necessary credentials.
Migration
Depending on which version
it is necessary upgrade to, you may want to use different version
of upgrade script.
curl -sS -0 "https://dev.ace-community.sapienspaas.com/scripts/ace-4.6.migration.sh" -o ace-4.6.migration.sh &&\
chmod 755 ace-4.6.migration.sh
Please backup flows before doing migration, either by exporting flows as a ZIP file or by exporting them to a GIT repository
In case if a local environment (by default: http://localhost:5005) has to be migrated, run
URL parameter is URL of Flow Manager API layer, rather than Flow Manager UI
./ace-4.6.migration.sh http://host.docker.internal:3000
I case if remote environment (for example: https://dev.ace-api.sapienspaas.com/) has to be migrated, run
URL parameter is URL of Flow Manager API layer, rather than Flow Manager UI
./ace-4.6.migration.sh https://dev.ace-orch.sapienspaas.com
Best practices for ACE upgrade
For production environments, follow these steps:
- Export flows to the feature branch in target environment
- Install desired ACE version locally
- Import feature branch locally
- Migrate Flows locally
- Test if Flows work as expected locally
- Push changes to the feature branch
- Create pull request and review changes
- Complete the pull request
- Install desired ACE version in target environment
- Load changes into target environment
- Restart Flow Runner and Dynamic APIs runtime services if cache is enabled (see
CACHE_FLOWS
option in system design document)
In case of large workspaces it may be necessary to increase timeout, see timeout troubleshooting details