Run the save_v10_source_configuration.py
script to gather the source
system configuration.
About this task
The
save_v10_source_configuration.py
script:
- Creates a data directory with all configuration saved in it.
- Generates two YAML files in the same directory as the script:
gateway_portal_mapping.yaml
provider_org_credentials.yaml
Important: The YAML files must be filled in:
To view script parameters:
python3 save_v10_source_configuration.py --help
Procedure
- Create a directory called
FFM
and copy all python scripts to this
directory.
-
Kubernetes, OpenShift, or Cloud Pak for Integration: Save configuration from the source
system.
To save the source system configuration, run
save_v10_source_configuration.py
with the appropriate parameters for your deployment:
- If all subsystems are in the same namespace, and you are using username/password authentication.
This command saves configuration of all the installed subsystems in the
namespace:
python3 save_v10_source_configuration.py -u USERNAME -p PASSWORD -s PLATFORM_API_HOSTNAME -r REALM_NAME -n NAMESPACE
- If a subsystem needs to be skipped so that its configuration is not saved:
- Skip Portal:
python3 save_v10_source_configuration.py -u USERNAME -p PASSWORD -s PLATFORM_API_HOSTNAME -r REALM_NAME -n NAMESPACE -skip_ptl
- Skip Analytics:
python3 save_v10_source_configuration.py -u USERNAME -p PASSWORD -s PLATFORM_API_HOSTNAME -r REALM_NAME -n NAMESPACE -skip_a7s
- If all subsystems are in the same namespace, and you are using SSO
authentication:
python3 save_v10_source_configuration.py --sso -s PLATFORM_API_HOSTNAME -n NAMESPACE
- If all subsystems are in different namespace, and you are using username/password
authentication:
python3 save_v10_source_configuration.py -u USERNAME -p PASSWORD -s PLATFORM_API_HOSTNAME -r REALM_NAME -mgmt_ns <mgmt_namespace> -ptl_ns <ptl_namespace> -gw_ns <gw_namespace> -a7s_ns <a7s_namespace>
- If the cluster has multiple Gateways, Portals, or Analytics
subsystems distributed across namespaces in the cluster, you can save the configuration of the
source system using one of the ways shown below. Multiple namespaces need to be separated by
"
|
" symbol. The namespaces used in below example command are ns1
,
ns2
, ns3
. Both commands work the same way.
-
python3 save_v10_source_configuration.py -u USERNAME -p PASSWORD -s PLATFORM_API_HOSTNAME -r REALM_NAME -n "ns1|ns2|ns3"
-
python3 save_v10_source_configuration.py -u USERNAME -p PASSWORD -s PLATFORM_API_HOSTNAME -r REALM_NAME -mgmt_ns "ns1" -ptl_ns "ns1|ns2" -gw_ns "ns1|ns2|ns3" -a7s_ns "ns1|ns2"
- If ingress-ca certificates must be saved or exported in the configuration, run
the previous commands with
-export_cert
flag. Applicable only when you are saving
management subsystem configuration.
- VMware: Save configuration from the source system.
On VMware appliance, save the source configuration by running the
save_v10_source_configuration.py
script on the Management and Portal nodes.
If you have a three replica
deployment, run the save_v10_source_configuration.py
script on just one of the VMs
in the cluster.
- Copy the
apic
toolkit and apicup
installer to the management
node.
- Copy the script
save_v10_source_configuration.py
to the management node:
- If
ingress-ca
and root-ca
certificates must be saved in the
configuration, copy this script to the project directory for this appliance and upload the project
directory to the appliance. The script must be run from inside the project directory.
- If
ingress-ca
and root-ca
certificates are not needed, just
copy this script to the appliance.
- Change to root user (
sudo -i
) and set PATH variable to the directory where the
apic toolkit is present. This directory must be at the beginning of the
path.
- Change to the directory where script is located. Check the PATH to verify that the
apic toolkit is present. To validate, use
apic login
and
apicup version
.
- Collect source system configuration. If certificates needed, add the flag
-export_cert
to the command.
python3 save_v10_source_configuration.py -u USERNAME -p PASSWORD -s PLATFORM_API_HOSTNAME -r REALM_NAME -mgmt_ns default
- On the Management node, from the location where the script is run, download the
data directory, gateway_portal_mapping.yaml, and
provider_org_credentials.yaml files. Copy them to the location where the form
factor migration scripts are present.
- Copy the
save_v10_source_configuration.py
script to the Portal node and run the
script as root user, using the following
command:python3 save_v10_source_configuration.py -ptl_ns default -skip_mgmt
On
the Portal node, from the location where the script is run, download the data
directory and merge it with the data
directory downloaded from the Management
node.If multiple Portal services are configured with the Management subsystem, repeat the same
operation for each Portal.
What to do next
Configure your target deployment: