Deploy the SSO Migration Utility

Run the SSO migration utility to migrate the existing Sponsor and Partner data.

You can migrate the data for sponsor organization and corresponding partner organization and their respective users. You can also migrate the data for a specific sponsor or for all sponsors. For more information on setting the properties, refer to section Configuring the properties of Setup.cfg file. For information on SSO migration, refer to section Migrating Data for Enabling Single Sign-On.

Perform the following prerequisite steps:
  • Take a back-up for your database before you run the SSO migration utility.
  • Configure the files that are present in your Mount directory. For more information, refer to section Configuring the files in Mount directory.

Run the following command: 

docker run --name="<container name>" --add-host=<host_name>:<IP address> -v <path to mount files>:/opt/IBM/Resources -v <path to data folder>:/opt/IBM/PEM_SSO_Migration_Utility/bin/data -v <path to log>:/opt/IBM/PEM_SSO_Migration_Utility/log -v /etc/localtime:/opt/IBM/localtime:ro -e application="ssomigration" -dt <image name>:<version>
where, --add-host is optional.
Note: Enter the appropriate parameter values within the angle (<>) brackets.
Important: As the application name is case-sensitive, you must enter the application name in the same case as provided in the run command. For example, application="SSOMigration" is invalid.
Here,
  • <container name> - refers to the user-defined container name. If you want to reuse the container name, remove the container by running the command docker rm <container name>. Otherwise, you can use a different container name.
  • <path to mount files> - provides the absolute path of the directory where the mount files are extracted. For the contents of the mount directory, refer to section Mount directory structure.
  • --add-host=<host_name>:<IP address> - can add other hosts into the /etc/hosts file of the container by using one or more --add-host flags.
  • <path to data folder > - this is the absolute path of the directory in your host machine that is mounted into the container's data path.
  • <path to logs> - this is the absolute path of the directory in your host machine that is mounted into the container's log path.
  • -v /etc/localtime:/opt/IBM/localtime:ro - synchronizes the container's time zone with the host machine's time zone.

Sample run command

docker run --name="SSOMigrationUtility" --add-host=<host_name>:<IP address> -v /home/MountResource/:/opt/IBM/Resources </home/data>:/opt/IBM/PEM_SSO_Migration_Utility/bin/data -v </home/ssomigration/log>:/opt/IBM/PEM_SSO_Migration_Utility/log -v /etc/localtime:/opt/IBM/localtime:ro -e application=" ssomigration" -dt registry.ng.bluemix.net/gold/pem:3.5.16
Note: Here, --add-host is optional.

Log Files

Log files help in analyzing and debugging the errors. You can find the log files in the logs directory. For SSO migration utility-specific error messages, refer to the SSOMigration_messages.log file.

Note: Before you deploy the container, ensure to back-up the container log directory.

Verifying whether the docker run command is successful

To verify whether the Docker run command is successful, run docker logs <container name> or refer to the logs directory for more details.

Configuring the properties of Setup.cfg file

Configure the following properties:
  • accept_license
  • proxy_host
  • proxy_port
  • customer_id
  • db_type
  • ssl_connection
  • db_port
  • db_host
  • db_name
  • db_schema
  • db_user
  • db_password
  • db_driver
  • db_sslTrustStoreName
  • db_sslTrustStorePassword
  • ssomigration.migration_action
  • ssomigration.sponsor_context
  • ssomigration.org_data_filename
  • ssomigration.user_data_filename
  • ssomigration.log_level
  • ssomigration.log_file_max_size
  • ssomigration.log_file_count