CPS Backup and Restore Guide, Release 11.0.0

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

CPS Backup and Restore Guide, Release 11.0.0

Chapter Title

Restore CPS

Results

Updated:
November 2, 2016

Chapter: Restore CPS

Restore CPS

Restore Cluster Manager VM in OpenStack

    Step 1   Copy the cluster manager VM snapshot to the controller blade as shown in the following command:

    ls —ltr *snapshot*

    Example output:

    -rw-r--r--. 1 root root 10429595648 Aug 16 02:39 snapshot.raw

    Step 2   Upload the snapshot image to OpenStack from Datastore:

    glance image-create --name <snapshot_upload_image_name> --file <snapshot_file_path> --disk-format qcow2 --container-format bare

    Step 3   Verify whether the snapshot is uploaded with a Nova command as shown in the following example:

    nova image-list

    Figure 1. Example Output



    Step 4   Depending on whether the cluster manager VM exists or not, you can choose to create the cluman or rebuild the cluman:
    • If the Cluster Manager VM instance does not exist, create the Cluman VM with an Heat or Nova command as shown in the following example:

      nova boot --config-drive true --image "<imported_image_name>" --flavor "<flavour_name>" --nic net-id="<network_id>,v4-fixed-ip=<ip_address>" --nic net-id="network_id,v4-fixed-ip=ip_address" --block-device-mapping "/dev/vdb=2edbac5e-55de-4d4c-a427-ab24ebe66181:::0" --availability-zone "az-2:megh-os2-compute2.cisco.com" --security-groups cps_secgrp "cluman"

    • If the Cluster Manager VM instance exists, use a nova rebuild command to rebuild the Cluman VM instance with the uploaded snapshot as shown:

      nova rebuild <instance_name> <snapshot_image_name>

      For example:

      nova rebuild cps-cluman-5f3tujqvbi67 cluman_snapshot

    Step 5   List all the instances as shown and verify that the new cluster manager instance is created and running:

    nova list

    Figure 2. Example Output



    Restore Cluster Manager VM in VMware

    The following section describe how to restore the cluster manager VM using that OVF template.

    Restore a Cluster Manager Using an OVF Template Backup


    Note

    Before restoring the Cluster Manager, configure the ESX server to have enough memory and CPU available. Confirm that the network port group is configured for the internal network.

    1. Login to ESX server using vSphere Client.

    2. Select File > Deploy OVF Template… The Deploy OVF Template wizard opens.

    3. Click Browse to select the required OVF template file and click Next.

    4. Enter the name for the VM in the Name field and click Next.

    5. Select the required destination datastore from the Storage windows where the OVF template will be deployed and click Next.

    6. From Disk Format window, select the format in which you want to store the template and click Next.

    7. From Network Mapping window, select the network (map the networks used in OVF template to the network in your inventory) and click Next.

    8. Verify the settings from Ready to Complete window and click Finish.

    9. After the OVF template is deployed is successfully deployed, power on the VM. The Cluster Manager VM is deployed successfully.

    Restore a CPS VM

    The Cluster Manager VM is the cluster deployment host that maintains all the necessary CPS software and deployment configurations. If a VM in the CPS cluster becomes corrupted, the VM can be recreated. For more information, see the CPS Installation Guide for OpenStack.


    Note
    Because of its role in the cluster, the Cluster Manager cannot be redeployed using these steps. To restore the Cluster Manager VM, refer to one of the previous two sections.

    Restore a Single VM in the Cluster

    The following sections describe how to restore/redeploy specific VM in the CPS cluster (other than the Cluster Manager).

    pcrfclient01 VM

    To redeploy the pcrfclient01 VM:

      Step 1   Log in to the Cluster Manager VM as the root user.
      Step 2   Note the UUID of SVN repository using the following command:

      svn info http://pcrfclient02/repos | grep UUID

      The command will output the UUID of the repository. For example:

      Repository UUID: ea50bbd2-5726-46b8-b807-10f4a7424f0e

      Step 3   Import the backup Policy Builder configuration data on the Cluster Manager, as shown in the following example:

      config_br.py -a import --etc-oam --svn --stats --grafanadb --auth-htpasswd --users /mnt/backup/oam_backup_27102016.tar.gz

      Note    Many deployments run a cron job that backs up configuration data regularly. See Subversion Repository Backup, for more details.
      Step 4   To generate the VM archive files on the Cluster Manager using the latest configurations, execute the following command:

      /var/qps/install/current/scripts/build/build_svn.sh

      Step 5   To deploy the pcrfclient01 VM, perform one of the following:
      • In VMware, execute the following command: /var/qps/install/current/scripts/deployer/deploy.sh pcrfclient01
      • In OpenStack, use the HEAT template or the Nova command to re-create the VM. For more information, see CPS Installation Guide for OpenStack.
      Step 6   Re-establish SVN master/slave synchronization between the pcrfclient01 and pcrfclient02 with pcrfclient01 as the master by executing the following series of commands.
      Note    If SVN is already synchronized, do not issue these commands. To check if SVN is in sync, run the following command from pcrfclient02. If a value is returned, then SVN is already in sync:

      /usr/bin/svn propget svn:sync-from-url --revprop -r0 http://pcrfclient01/repos

      Execute the following commands from pcrfclient01:

      /bin/rm -fr /var/www/svn/repos

      /usr/bin/svnadmin create /var/www/svn/repos

      /usr/bin/svn propset --revprop -r0 svn:sync-last-merged-rev 0 http://pcrfclient02/repos-proxy-sync

      /usr/bin/svnadmin setuuid /var/www/svn/repos/ "Enter the UUID captured in step 2"

      /etc/init.d/vm-init-client

      /var/qps/bin/support/recover_svn_sync.sh

      Step 7   If pcrfclient01 is also the arbiter VM, then execute the following steps:
      1. Create the mongodb start/stop scripts based on the system configuration.
        Note    Not all deployments have all these databases configured. Refer to /etc/broadhop/mongoConfig.cfg to determine which databases need to be set up.

        cd /var/qps/bin/support/mongo

        build_set.sh --session --create-scripts

        build_set.sh --admin --create-scripts

        build_set.sh --spr --create-scripts

        build_set.sh --balance --create-scripts

        build_set.sh --audit --create-scripts

        build_set.sh --report --create-scripts

      2. Start the mongo process:

        /etc/init.d/sessionmgr-XXXXX start

      3. Wait for the arbiter to start, then run diagnostics.sh --get_replica_status to check the health of the replica set.

      pcrfclient02 VM

      To redeploy the pcrfclient02 VM:

        Step 1   Log in to the Cluster Manager VM as the root user.
        Step 2   To generate the VM archive files on the Cluster Manager using the latest configurations, execute the following command:

        /var/qps/install/current/scripts/build/build_svn.sh

        Step 3   To deploy the pcrfclient02 VM, perform one of the following:
        • In VMware, execute the following command: /var/qps/install/current/scripts/deployer/deploy.sh pcrfclient02
        • In OpenStack, use the HEAT template or the Nova command to re-create the VM. For more information, see CPS Installation Guide for OpenStack.
        Step 4   Secure shell to the pcrfclient01:

        ssh pcrfclient01

        Step 5   Run the following script to recover the SVN repos from pcrfclient01:

        /var/qps/bin/support/recover_svn_sync.sh

        sessionmgr VMs

        To redeploy a sessionmgr VM:

          Step 1   Log in to the Cluster Manager VM as the root user.
          Step 2   To deploy the sessionmgr VM and replace the failed or corrupt VM, perform one of the following:
          • In VMware, execute the following command: /var/qps/install/current/scripts/deployer/deploy.sh sessionmgrXX
          • In OpenStack, use the HEAT template or the Nova command to re-create the VM. For more information, see CPS Installation Guide for OpenStack.
          Step 3   Create the mongodb start/stop scripts based on the system configuration.
          Note    Not all deployments have all these databases configured. Refer to /etc/broadhop/mongoConfig.cfg to determine which databases need to be set up.

          cd /var/qps/bin/support/mongo

          build_set.sh --session --create-scripts

          build_set.sh --admin --create-scripts

          build_set.sh --spr --create-scripts

          build_set.sh --balance --create-scripts

          build_set.sh --audit --create-scripts

          build_set.sh --report --create-scripts

          Step 4   Secure shell to the sessionmgr VM and start the mongo process:

          ssh sessionmgrXX

          /etc/init.d/sessionmgr-XXXXX start

          Step 5   Wait for the members to start and for the secondary members to synchronize, then run diagnostics.sh --get_replica_status to check the health of the database.
          Step 6   To restore Session Manager database, use one of the following example commands depending on whether the backup was performed with --mongo-all or --mongo option:
          • config_br.py -a import --mongo-all --users /mnt/backup/sm_backup_27102016.tar.gz
          • config_br.py -a import --mongo --users /mnt/backup/sm_backup_27102016.tar.gz

          Policy Director (Load Balancer) VM

          To redeploy the Policy Director (Load Balancer) VM:

            Step 1   Log in to the Cluster Manager VM as the root user.
            Step 2   To import the backup Policy Builder configuration data on the Cluster Manager, execute the following command:

            config_br.py -a import --network --haproxy --users /mnt/backup/lb_backup_27102016.tar.gz

            Step 3   To generate the VM archive files on the Cluster Manager using the latest configurations, execute the following command:

            /var/qps/install/current/scripts/build/build_svn.sh

            Step 4   To deploy the lb01 VM, perform one of the following:
            • In VMware, execute the following command: /var/qps/install/current/scripts/deployer/deploy.sh lb01
            • In OpenStack, use the HEAT template or the Nova command to re-create the VM. For more information, see CPS Installation Guide for OpenStack.

            QNS VM

            To redeploy the Policy Server (QNS) VM:

              Step 1   Log in to the Cluster Manager VM as the root user.
              Step 2   Import the backup Policy Builder configuration data on the Cluster Manager, as shown in the following example:

              config_br.py -a import --users /mnt/backup/qns_backup_27102016.tar.gz

              Step 3   To generate the VM archive files on the Cluster Manager using the latest configurations, execute the following command:

              /var/qps/install/current/scripts/build/build_svn.sh

              Step 4   To deploy the qns VM, perform one of the following:
              • In VMware, execute the following command: /var/qps/install/current/scripts/deployer/deploy.sh qns
              • In OpenStack, use the HEAT template or the Nova command to re-create the VM. For more information, see CPS Installation Guide for OpenStack.

              Mongo Database Restore

              To restore databases in a production environment that use replica sets with or without sharding, a maintenance window is required as the CPS software on all the processing nodes and the sessionmgr nodes must be stopped. A database restore is needed after an outage or problem with the system and/or its hardware. In that case, service has been impacted and to properly fix the situation, service will need to be impacted again. From a database perspective, the main processing nodes must be stopped so that the system is not processing incoming requests while the databases are stopped and restored. If replica sets are used with or without sharding, then all the database instances must be stopped to properly restore the data and have the replica set synchronize from the primary to the secondary database nodes.

              For reference, the following Mongo DB documentation was used to develop the CPS restore procedures:

              Determine Health of Database After Outage

              The following SNMP Notifications (Alarms) are indicators of issues with the CPS databases.

              • All DB Member of a replica set Down- CPS is unable to connect to any member of the replica set.

              • No Primary DB Member Found- CPS is unable to find the primary member for a replica set.

              • Secondary DB Member Down- In a replica set, a secondary DB member is not able to connect.

              To determine the status of the databases, run the following command:

              diagnostics.sh --get_replica_status

              If the mongod process is stopped on any VM, try to manually start it using the following command, where (XXXXX is the DB port number):

              /etc/init.d/sessionmgr-XXXXX start

              If the mongod process will not start (stops immediately), or reports errors (either command line or in monogdb log file), refer to the following sections for more information:

              General Procedure for Database Restore

              The following steps describe how to import data from a previous backup (as described in General Procedure for Database Backup).

              If the database is damaged, refer to Repair a Damaged Database, or Rebuild a Damaged Database, before proceeding with these database restoration steps.

                Step 1   Execute the following command to restore the database:

                config_br.py –a import --mongo-all /mnt/backup/backup_$date.tar.gz

                where $date is the timestamp when the export was made.

                For example,

                config_br.py –a import --mongo-all /mnt/backup/backup_27092016.tgz

                Step 2   Log in to the database and verify whether it is running and is accessible:

                1. Log into session manager:

                  mongo --host sessionmgr01 --port $port

                  where $port is the port number of the database to check. For example, 27718 is the default Balance port.

                2. Display the database by executing the following command:

                  show dbs

                3. Switch the mongo shell to the database by executing the following command:

                  use $db

                  where $db is a database name displayed in the previous command. The 'use' command switches the mongo shell to that database.

                  For example,

                  use balance_mgmt

                4. To display the collections, execute the following command:

                  show collections

                5. To display the number of records in the collection, execute the following command:

                  db.$collection.count()

                  For example,

                  db.account.count()

                  The above example will show the number of records in the collection “account” in the Balance database (balance_mgmt).

                Repair a Damaged Database

                After an outage, the database may be in a state where the data is present but damaged. When you try to start the database process (mongod), it will start, and then stop immediately. You can also observe a “repair required” message in the /var/log/mongodb log file.

                If this occurs, you can attempt to repair the database using the following commands:


                Note
                Because the session database (session_cache - 27717) stores only transient session data of active network sessions, you should not try to repair this database. If the session database is damaged, refer to Rebuild a Damaged Database to rebuild it.

                Run the following commands:

                /etc/init.d/sessionmgr-$port stop

                /etc/init.d/sessionmgr-$port repair

                Verify that the mongod process is running on the VM:

                ps –ef | grep mongo | grep $port

                If it is not running, then start the mongod process:

                /etc/init.d/sessionmgr-$port start

                After repairing the database, you can proceed to import the most recent data using config_br.py as described in General Procedure for Database Backup.

                Rebuild a Damaged Database

                If the existing data in the database is damaged and cannot be repaired/recovered (using the steps in Repair a Damaged Database), the database must be rebuilt.

                  Step 1   Secure shell to the pcrfclient01 VM as the root user:

                  ssh pcrfclient01

                  Step 2   To rebuild the failed database:

                  cd /var/qps/bin/support/mongo

                  Step 3   To rebuild a specific replica-set:

                  build_set.sh --$db_name --create

                  where:

                  $db_name: Database name

                  Step 4   After repairing the database, you can proceed to import the most recent data using config_br.py as described in General Procedure for Database Backup.

                  Subversion Repository Restore

                  To restore the Policy Builder Configuration Data from a backup, execute the following command:

                  config_br.py –a import --svn /mnt/backup/backup_$date.tgz

                  where, $date is the date when the cron created the backup file.

                  Validating the Restore

                  After restoring the data, verify the working system by executing the following command:

                  /var/qps/bin/diag/diagnostics.sh

                  Restore Grafana Dashboard

                  You can restore Grafana dashboard using the following command:

                  config_br.py -a import --grafanadb /mnt/backup/<backup_filename>

                  Was this Document Helpful?

                  FeedbackFeedback

                  Contact Cisco