Cisco Software Manager Server 4.

0
Data Migration Guide
Table of Contents
Introduction ............................................................................................................................... 2
To back up database and logs from the existing CSM Server that is version 3.5 and prior ........ 2
Migration Script.................................................................................................................................. 2
Shutdown CSM Server ........................................................................................................................ 2
Backup database and logs .................................................................................................................. 3
Store the migration file outside of the CSM Server ............................................................................ 3
To restore database and logs in CSM Server 4.0 ........................................................................ 4
Upload the migration file ................................................................................................................... 4
Restore database and logs.................................................................................................................. 7
Migration Log ............................................................................................................................ 9
Introduction
This database migration guide provides instructions to migrate database and other user data
from Cisco Software Manager (CSM) Server 3.5 to 4.0. In high level, the migration procedure
includes two phases. The first phase is to back up the user data including the database from an
existing CSM Server. The second phase is to restore them in the new CSM Server that is running
version 4.0. At the end, users can review the migration log or provide the migration log to cs-
software-manager@cisco.com for questions and debugging.

To back up database and other user data from the existing CSM Server
that is version 3.5 and prior

Migration Script

A python script is created to help the backup of user data for CSM Server 3.5.

The python script is available to be installed via pip from the location below. If pip is not
already installed in the host Linux, please install pip first by referring to the pip installation
URL, https://pip.pypa.io/en/stable/installing/.

pip install https://devhub.cisco.com/artifactory/software-manager-install-release/migrate-

tool/csm_35_migration-1.0.0.tar.gz

After the installation, the migration script is available for execution.

$ which csm35migrate
/usr/local/bin/csm35migrate

Shutdown CSM Server

From CSM Server release 3.5, locate where the CSM Server is started, then shutdown CSM
Server.

The CSM Server folder is usually located in /usr/local/csm/csmserver. Please change

directory into it.

# cd /usr/local/csm/csmserver

If Python virtual environment is used, please enter the virtual environment. For example,

# source env/bin/activate
 After activating the virtual environment, you should see a new shell prompt with ‘(env)’ as
the prefix. This indicates that you are inside the virtual environment.

Finally, please enter the following command to shut down the CSM Server:

# sudo ./csmserver stop

Backup database and logs

Please execute the following command with root privilege to create the migration tar.

$ sudo csm35migrate /usr/local/csm

where /usr/local/csm is the directory that CSM 3.5 has been installed.

Below is an example that you may see the following output and be prompted to enter ‘y’ to
create the backup file.

$ sudo csm35migrate /usr/local/csm

This script will create a data migration file to help you upgrade from CSM v3.5 to CSM v4.0
Cloud Environment. The data file consists of the current database dump and all install job
log files. The creation may take a minute or so depending on the data size. After the data
file is created, store it outside of your virtual machine. Once you have CSM v4.0 running,
upload this data file and restore all previous CSM v3.5 data.

To upload, from CSM, goto Tools - Snapshots - Actions, and select Upload
To restore after upload, select Restore next to the data file just uploaded
Type "y" to proceed (y/n): y
Migration file already exists: csmcloud_migration_file.tar
Overwrite (y/n): y
Acquiring a database dump...
mysqldump: [Warning] Using a password on the command line interface can be insecure.
Compressing the database dump...
Archiving installation logs...
Creating the metadata...
Finalizing the data file...
The data file, csmcloud_migration_file.tar, has been created.
Cleaning up the temporary files...

Store the migration file outside of the CSM Server

In the subsequent phase, the migration file will be uploaded to CSM Server 4.0 via a
browser.
 Please store the migration file to the local disk or a network location that can be directly
accessed by your computer that runs the browser with CSM Server 4.0 Web User Interface.

To restore database and logs in CSM Server 4.0

Upload the migration file

From the top menu bar in CSM Server 4.0 Web GUI, please click on ‘Tools’, then ‘Snapshots’
as follows:

Then from the System Snapshots dashboard, please click on the ‘Actions’ tab, then select
‘Upload’:

A new window will appear as follows.

Please click on ‘Browse …’ to select the folder and the migration file that was backed up
from CSM Server 3.5.3 and earlier. Then click on ‘Open’.

Then, click on the ‘Upload’ button to upload the migration file into CSM Server 4.0.
The upload will start and the following window with the message “Snapshot operation in
progress… Please wait.” will appear to indicate that the restoration is in progress.

After the migration file is successfully uploaded, the Snapshot Upload window will report
the upload status. Please note that the successful status background is green. If the upload
fails, the status background will be red.
 Finally, please click on ‘Close’ to return to the System Snapshot dashboard.

Restore database and logs

After back to the System Snapshots dashboard, under the ‘Snapshots’ tab there will be a
new Migration Data entry. From the ‘Action’ pull-down menu, please click on ‘Restore’ as
given in the following picture.

The following window will pop up. Please click ‘OK’ to proceed the restoration.
The restoration will start and the following window with the message “Snapshot operation
in progress… Please wait.” will appear to indicate that the restoration is in progress.

Depending on the size of the database and log files, the restoration may take a short while
from several minutes to much longer. This window will disappear after the restoration
completes. The Web GUI will return to System Snapshots dashboard.
 You may click on ‘Home’ from the top menu bar to review the restored configurations such
as Hostname, Jump Servers, Regions, and Server Repositories.

Migration Log
To view the Snapshot migration log, please login the Linux host that runs the CSM Server and
issue the following command. Below is an example of the successful migration file upload and
restoration.

# docker logs csm-supervisor

18-12-18 03:13:29 INFO (MainThread) [csmcloud.snapshots] Found 1 snapshot files

18-12-18 03:13:34 INFO (MainThread) [csmcloud.api.snapshots] Download snapshot e5cda444
18-12-18 03:13:40 INFO (MainThread) [csmcloud.snapshots] Removed snapshot file e5cda444
18-12-18 03:21:45 INFO (MainThread) [csmcloud.snapshots] Found 0 snapshot files
18-12-18 03:30:52 INFO (MainThread) [csmcloud.api.snapshots] Downloading:
csmcloud_migration_file.tar
18-12-18 03:30:52 INFO (MainThread) [csmcloud.snapshots] Success import e5cda444
18-12-18 03:33:45 INFO (MainThread) [csmcloud.snapshots] Partial-Restore e5cda444 start
18-12-18 03:33:45 INFO (SyncWorker_4) [csmcloud.docker.interface] Stop
containers.cisco.com/spnscsm/qemux86-64-csm-server docker application
18-12-18 03:33:46 INFO (SyncWorker_4) [csmcloud.docker.interface] Clean
containers.cisco.com/spnscsm/qemux86-64-csm-server docker application
18-12-18 03:33:46 INFO (MainThread) [csmcloud.snapshots] Restore e5cda444 run folders
18-12-18 03:33:46 INFO (SyncWorker_4) [csmcloud.snapshots.snapshot] Restore folder
database
18-12-18 03:33:46 INFO (SyncWorker_2) [csmcloud.snapshots.snapshot] Restore folder
csm_data/logs
18-12-18 03:33:46 INFO (SyncWorker_2) [csmcloud.snapshots.snapshot] Restore folder
csm_data/logs done
18-12-18 03:33:46 INFO (SyncWorker_4) [csmcloud.snapshots.snapshot] Restore folder
database done
18-12-18 03:33:46 INFO (MainThread) [csmcloud.database] Importing database
18-12-18 03:33:57 INFO (MainThread) [csmcloud.database] Result: ExecResult(exit_code=0,
output=b'')
18-12-18 03:33:57 INFO (MainThread) [csmcloud.snapshots] Partial-Restore e5cda444 done
18-12-18 03:33:58 INFO (SyncWorker_8) [csmcloud.docker.csmserver] Start CSM Server
containers.cisco.com/spnscsm/qemux86-64-csm-server with version 4.0.0-beta.8
18-12-18 03:34:08 WARNING (MainThread) [csmcloud.csm] No response from
172.33.32.1:5000
18-12-18 03:34:18 INFO (MainThread) [csmcloud.csm] Detected running CSM Server instance
18-12-18 03:48:36 INFO (MainThread) [csmcloud.snapshots] Partial-Restore e5cda444 start
18-12-18 03:48:36 INFO (SyncWorker_6) [csmcloud.docker.interface] Stop
containers.cisco.com/spnscsm/qemux86-64-csm-server docker application
18-12-18 03:48:37 INFO (SyncWorker_6) [csmcloud.docker.interface] Clean
containers.cisco.com/spnscsm/qemux86-64-csm-server docker application
18-12-18 03:48:37 INFO (MainThread) [csmcloud.snapshots] Restore e5cda444 run folders
18-12-18 03:48:37 INFO (SyncWorker_7) [csmcloud.snapshots.snapshot] Restore folder
database
18-12-18 03:48:37 INFO (SyncWorker_1) [csmcloud.snapshots.snapshot] Restore folder
csm_data/logs
18-12-18 03:48:37 INFO (SyncWorker_1) [csmcloud.snapshots.snapshot] Restore folder
csm_data/logs done
18-12-18 03:48:37 INFO (SyncWorker_7) [csmcloud.snapshots.snapshot] Restore folder
database done
18-12-18 03:48:37 INFO (MainThread) [csmcloud.database] Importing database
18-12-18 03:48:48 INFO (MainThread) [csmcloud.database] Result: ExecResult(exit_code=0,
output=b'')
18-12-18 03:48:48 INFO (MainThread) [csmcloud.snapshots] Partial-Restore e5cda444 done
18-12-18 03:48:50 INFO (SyncWorker_6) [csmcloud.docker.csmserver] Start CSM Server
containers.cisco.com/spnscsm/qemux86-64-csm-server with version 4.0.0-beta.8
18-12-18 03:49:00 WARNING (MainThread) [csmcloud.csm] No response from
172.33.32.1:5000
18-12-18 03:49:10 INFO (MainThread) [csmcloud.csm] Detected running CSM Server instance