CA API Gateway 9.1

9.4 9.1

Tips, Tricks, and Best Practices for Migration

Tips, Tricks, and Best Practices for Migration
gateway91
Topic
Tips, Tricks, and Best Practices
Deleting entities
WARNING:
 Use caution when using the command,
manageMappings --action=delete
. The command has no safeguards to prevent you from losing data, or locking yourself out of the 
API Gateway
.
Templating
The
template
 command changes the bundle. To avoid loss of data, back up the bundle before templating.
Changing the names or GUIDs of entities
Use the
manageMappings
 command.
Policy design
  • Treat policies as code and give them similar attention
  • Develop policies with a deliberate consideration for migration
  • Use cluster properties to reference environment-specific dependencies
  • Organize
    API Gateway
    content in functional folders
  • Avoid using special characters in folder, policy, and service names
  • Use policy fragments to reuse and isolate migration-sensitive policy
  • Define and enforce an entity-naming strategy
  • Use secure passwords for policies
Migration bundles
Migration bundles can contain sensitive data. Protect migration bundles with restricted file permissions.
Secure communication between
API Gateway
s
Mutual authentication is the best practice for secure communications between source and target
API Gateway
s for migrations.
Migration administrators
Create separate Administrators for migrations.
Encoding passwords and passphrases
Encoding passwords and passphrases are optional. Although not recommended,
--plaintextPassword
 and
--plaintextEncryptionPassphrase
 arguments are available.
--encryptionPassphrase
 argument
Use an explicit encryption passphrase for stronger encryption.
 
--encryptUsingClusterPassphrase
 argument
  • Use the --encryptUsingClusterPassphrase argument only if you know that the source and target Gateways have the same cluster passphrase.
  • Do not share the cluster passphrase and keep the actual passphrase secure.
Common argument files
Although optional, creating property files for common GMU arguments are more efficient and makes the command line easier to read. See
Get Started and Run GMU
.
Override mapping file
You can create a mappings file (
manageMappings
 command) to override the bundle mappings for
migrateIn
 (
--map
<
filename
>
). Although optional, it is useful for preserving the original bundle.
Solution Kits
To include Solution Kits as part of a backup routine (and restoring on a fresh Gateway), add the "--includeSolutionKits" parameter to the migrateOut command. However if migrating from one environment to another, do not use this parameter. Instead, create a replay script. See Migrate Solution Kits for details.

Content feedback and comments