NetBackup™ for OpenStack Administrator's Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.5)
  1. Introduction
    1.  
      About NetBackup for OpenStack
    2. NetBackup for OpenStack Architecture
      1.  
        Backup as a Service
      2.  
        Main Components
      3.  
        Service Endpoints
      4.  
        Network topology
      5.  
        NetBackup for OpenStack ports
  2. Deploying NetBackup for OpenStack
    1. Requirements
      1. System requirements for NetBackup for OpenStack virtual machine
        1.  
          Software Requirements
    2. NetBackup for OpenStack network considerations
      1.  
        Existing endpoints in OpenStack
      2.  
        OpenStack endpoints required by NetBackup for OpenStack
      3.  
        Recommendation: Provide access to all OpenStack Endpoint types
      4.  
        Backup target access required by NetBackup for OpenStack
      5.  
        Example of a typical NetBackup for OpenStack network integration
      6.  
        Other examples of NetBackup for OpenStack network integrations
    3. Preparing the installation
      1.  
        Tenant quotas
      2.  
        NetBackup for OpenStack Cluster
    4. Spinning up the NetBackup for OpenStack virtual machine
      1. Creating the cloud-init image
        1.  
          Needed tools
        2.  
          Providing the metadata
        3.  
          Creating the image file
      2.  
        Spinning up the NetBackup for OpenStack appliance
      3.  
        Uninstalling cloud-init after first start
    5.  
      About NetBackup for OpenStack backup target types
    6. Installing NetBackup for OpenStack Components
      1. Installing on RHOSP
        1. Prepare for deployment
          1.  
            Copying nbos-cfg-scripts to the undercloud
        2.  
          Uploading the NetBackup for OpenStack puppet module
        3. Updating the overcloud roles data file to include NetBackup for OpenStack services
          1.  
            Adding the NetBackup for OpenStack datamover API service to role data file
          2.  
            Adding NetBackup for OpenStack datamover service to role data file
        4.  
          Preparing the NetBackup for OpenStack container images
        5.  
          Providing the environment details in nbos_env.yaml
        6.  
          Deploying the overcloud with NetBackup OpenStack environment
        7.  
          Verifying the deployment
        8. Additional Steps on NetBackup for OpenStack Appliance
          1.  
            Changing the nova user ID on the NetBackup for OpenStack Nodes
        9.  
          Troubleshooting for overcloud deployment failures
      2. Installing on Ansible OpenStack Ussuri
        1.  
          Verify that file-level logging is configured for OpenStack components on Horizon container
        2.  
          Changing the nova user ID on the NetBackup for OpenStack Nodes
        3.  
          Preparing the deployment host
        4.  
          Deploying the NetBackup for OpenStack components
        5.  
          Verifying the NetBackup for OpenStack deployment
      3. Installing on Kolla
        1.  
          Changing the nova user ID on the NetBackup for OpenStack Nodes
        2.  
          Copying the NetBackup for OpenStack deployment scripts
        3.  
          Copying the NetBackup for OpenStack deployment scripts to Kolla-ansible deploy scripts
        4. Pushing NetBackup for OpenStack images to the local registry
          1.  
            Running the local registry
          2.  
            Loading the images from tar and pushing them to the local repository
        5.  
          Editing globals.yml to set NetBackup for OpenStack parameters
        6.  
          Enabling the NetBackup for OpenStack backup mount feature
        7.  
          Pulling the NetBackup for OpenStack container images
        8.  
          Deploying the NetBackup for OpenStack components
        9.  
          Verifying the NetBackup for OpenStack deployment
    7. Configuring NetBackup for OpenStack
      1. Details needed for the NetBackup for OpenStack Appliance
        1.  
          NetBackup for OpenStack Cluster information
        2.  
          OpenStack Credentials information
      2. Advanced settings
        1.  
          Set up the NetBackup for OpenStack job manager and NetBackup for OpenStack datamover API
        2.  
          Configuring the secure communication for NBOSVM
        3.  
          Set up an external database
        4.  
          Define the NetBackup for OpenStack service user password
      3.  
        Starting the configurator
    8.  
      Resource throttling in NetBackup for OpenStack
    9. Post Installation Health-Check
      1.  
        Verify the NetBackup for OpenStack Appliance services are up
      2.  
        Check the NetBackup for OpenStack pacemaker and NGINX cluster
      3.  
        Verify API connectivity of the NetBackup for OpenStack Appliance
      4.  
        Verify that the nbosdm services are up and running
    10. Uninstalling NetBackup for OpenStack
      1. Uninstalling from RHOSP
        1.  
          Clean NetBackup for OpenStack datamover API service
        2.  
          Clean NetBackup for OpenStack datamover service
        3.  
          Clean NetBackup for OpenStack haproxy resources
        4.  
          Clean NetBackup for OpenStack Keystone resources
        5.  
          Clean NetBackup for OpenStack database resources
        6.  
          Revert overcloud deploy command
        7.  
          Revert back to original RHOSP Horizon container
        8.  
          Destroy the NetBackup for OpenStack virtual machine cluster
      2. Uninstalling from Ansible OpenStack
        1.  
          Uninstall NetBackup for OpenStack Services
        2.  
          Destroy NetBackup for OpenStack datamover API container
        3.  
          Clean openstack_user_config.yml
        4.  
          Remove NetBackup for OpenStack haproxy settings in user_variables.yml
        5.  
          Remove NetBackup for OpenStack datamover API inventory file
        6.  
          Remove NetBackup for OpenStack datamover API service endpoints
        7.  
          Delete NetBackup for OpenStack datamover API database and user
        8.  
          Remove nbosdmapi rabbitmq user from rabbitmq container
        9.  
          Clean haproxy
        10.  
          Remove certificates from Compute nodes
        11.  
          Destroy the NetBackup for OpenStack virtual machine cluster
      3. Uninstalling from Kolla Openstack
        1.  
          Cleaning NetBackupOpenStack_datamover_api container
        2.  
          Cleaning NetBackupOpenStack_datamover container
        3.  
          Cleaning haproxy of NetBackupOpenStack datamover API
        4.  
          Cleaning Kolla Ansible deployment procedure
        5.  
          Reverting to original Horizon container
        6.  
          Cleaning Keystone resources
        7.  
          Cleaning NetBackup for OpenStack database resources
        8.  
          Destroy the NetBackup for OpenStack virtual machine cluster
    11.  
      Install nbosjm CLI client
    12.  
      About log rotation in NetBackup for OpenStack
    13. Upgrading NetBackup for OpenStack
      1.  
        Deleting the orphaned snapshots
  3. Configuring NetBackup OpenStack Appliance
    1.  
      Reconfigure the NetBackup for OpenStack cluster
    2.  
      Configuring the NetBackup primary server details
    3.  
      Change NetBackup for OpenStack dashboard password
    4.  
      Reset NetBackup for OpenStack dashboard password
    5.  
      Downloading the NetBackup for OpenStack logs
    6.  
      Updating the API key
    7.  
      Uploading the API certificate
  4. Configuring NetBackup primary server
    1.  
      License for OpenStack plug-in for NetBackup
    2. About launching the OpenStack Horizon UI from the NetBackup web UI
      1.  
        Adding the OpenStack Horizon instance on NetBackup web UI
      2.  
        Creating the custom role for NetBackup for OpenStack administrator
      3.  
        Launching the Horizon UI from the NetBackup web UI
    3.  
      Configuring the NBOSVM service principal
    4.  
      About NetBackup for OpenStack protection plan
    5. About auto image replication in NetBackup for OpenStack
      1.  
        Configuring the AIR in NetBackup for OpenStack
  5. NetBackup for OpenStack protections
    1.  
      About protections
    2.  
      List of protections
    3.  
      Create a protection
    4.  
      Protection overview
    5.  
      Edit a protection
    6.  
      Delete a protection
    7.  
      Unlock a protection
  6. Performing snapshots, backups, and restores of OpenStack
    1.  
      About recovery points
    2.  
      List of recovery points
    3.  
      Creating a snapshot
    4.  
      Snapshot and backup overview
    5.  
      Expire recovery points
    6.  
      Cleaning up the volume snapshots
    7. About restores
      1.  
        About restoring the multi-attach volumes
    8.  
      List of Restores
    9.  
      Restores overview
    10.  
      Delete a restore
    11.  
      Cancel a restore
    12.  
      One-click restore
    13.  
      Selective restore
    14.  
      In-place restore
    15. Required restore.json file for CLI
      1.  
        General required information
      2. Selective restore required information
        1.  
          Information required in instances
        2.  
          Information required in network topology restore or network mapping
        3.  
          Full selective restore example
      3. In-place restore required information
        1.  
          Information required in instances
        2.  
          Network mapping information required
        3.  
          Full in-place restore example
    16.  
      About backup mount
    17.  
      Creating a file recovery manager instance
    18.  
      Mounting a backup copy
    19.  
      Accessing the file recovery manager
    20.  
      Identifying mounted backups
    21.  
      Unmounting a backup
    22. About schedules
      1.  
        Enabling or disabling a schedule
      2.  
        Modifying a schedule
    23.  
      About activating the email notifications
  7. Performing Backup Administration tasks
    1. NBOS Backup Admin Area
      1.  
        Access the NBOS Backup Admin area
      2.  
        Configuring the email settings
      3.  
        Enabling or disabling a job scheduler
    2. Protection plan
      1.  
        List the available protection plans
      2.  
        Subscribe a project to a protection plan
    3.  
      Managing the trusts
    4. Policy import and migration
      1.  
        Importing the policies
      2.  
        Orphaned policies
  8. Disaster recovery
    1.  
      About disaster recovery in NetBackup for OpenStack
  9. Troubleshooting
    1. General Troubleshooting Tips
      1. What is happening where
        1. NetBackup for OpenStack cluster
          1.  
            During a backup process
          2.  
            During a restore process
        2.  
          nbosdmapi
        3.  
          nbosdm
      2.  
        Everything on the Backup Target happens as the user nova
      3.  
        NetBackup for OpenStack Trustee Role
      4.  
        OpenStack Quotas
      5.  
        Ephemeral disk backup
    2.  
      Using the nbosjm CLI tool on the NetBackup for OpenStack Appliance
    3. Health check of NetBackup for OpenStack
      1.  
        On the NetBackup for OpenStack Cluster
      2.  
        The nbosdmapi service
      3.  
        The nbosdm service
    4. Important log files
      1.  
        On the NetBackup for OpenStack Nodes
      2.  
        NetBackup for OpenStack data mover service logs on RHOSP
      3.  
        NetBackup for OpenStack data mover service logs on Ansible OpenStack
      4.  
        NetBackup for OpenStack data mover service logs on Kolla
    5.  
      Troubleshooting NBOSDM container in offline state due to unavailable mount point
    6.  
      After restore of the Windows instance, the disk is in an offline state
    7.  
      Selective restore from snapshot copy fails
    8.  
      A backup fails due to an old nova ID in the universal share path
    9.  
      Using the NetBackup support utility in NetBackup for OpenStack
    10.  
      Cannot create volumes if the metadata size for physical volume and volume group is small
    11.  
      NBOSVM configuration fails if DNS server cannot resolve IP address or IP address is wrong
    12.  
      Error when storage unit is created with multiple storage servers
    13.  
      Snapshot job fails if the OpenStack image is not accessible to the OpenStack user
    14.  
      One-click restore fails if the subnet attached to the instance is not accessible to the OpenStack user
    15.  
      The NBOSVM configurator UI does not detect the primary server
    16.  
      A recovery point name is updated to a default name
    17.  
      NBOS Backups and NBOS Backup Admin tabs disappear from Horizon UI after stack is updated
    18.  
      The protection creation fails on the Horizon UI
    19.  
      The NetBackup for OpenStack services do not start after NBOSVM is restarted
    20.  
      The NBOSVM is not able to communicate with the nbosdmapi on the controller node
    21.  
      Troubleshooting the OpenStack Keystone authentication failure
  10.  
    Index

Loading the images from tar and pushing them to the local repository

Ensure that the proper tar files of nbosdmapi, nbosdm and nbos-horizon-plugin are available on the deployment node.

NBOS_Version

NetBackup for OpenStack version number.

kolla-base-distro

Ubuntu

kolla-install-type

Binary or source

FQDN

Hostname of kolla deployment server.

To load the images from tar and push them to the local repository

  1. Load NetBackup for OpenStack images from the tar file.

    Run the following commands:

    • nbosdmapi

      docker load --input nbosdmapi-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri.tar

      For example,

      docker load --input nbosdmapi-ubuntu-9.1.2.20211021104525-ussuri.tar

    • nbosdm

      docker load i-input nbosdm-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri.tar

      For example,

      docker load --input nbosdm-ubuntu-9.1.2.20211021104525-ussuri.tar

    • nbos-horizon-plugin

      docker load --input nbos-horizon-plugin-{{ kolla-install-type }}-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri.tar

      For example,

      docker load --input nbos-horizon-plugin-source-ubuntu-9.1.2.20211021104525-ussuri.tar

  2. Tag the NetBackup for OpenStack images with appropriate name.

    Run the following commands:

    • nbosdmapi

      • docker tag nbosdmapi-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri nbos/nbosdmapi-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri

      • docker tag nbosdmapi-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri FQDN:5001/nbos/nbosdmapi-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri

      Examples,

      • docker tag nbosdmapi-ubuntu:9.1.2.20211021104525-ussuri nbos/nbosdmapi-ubuntu:9.1.2.20211021104525-ussuri

      • docker tag nbosdmapi-ubuntu:9.1.2.20211021104525-ussuri deployment-vm.vxindia.veritas.com:5001/nbos/nbosdmapi-ubuntu:9.1.2.20211021104525-ussuri

    • nbosdm

      • docker tag nbosdm-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri nbos/nbosdm-<kolla-base-distro>:<NBOS_version>-ussuri

      • docker tag nbosdm-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri FQDN:5001/nbos/nbosdm-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri

      Examples,

      • docker tag nbosdm-ubuntu:9.1.2.20211021104525-ussuri nbos/nbosdm-ubuntu:9.1.2.20211021104525-ussuri

      • docker tag nbosdm-ubuntu:9.1.2.20211021104525-ussuri deployment-vm.vxindia.veritas.com:5001/nbos/nbosdm-ubuntu:9.1.2.20211021104525-ussuri

    • nbos-horizon-plugin

      • docker tag nbos-horizon-plugin-{{ kolla-install-type }}-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri nbos/nbos-horion-plugin-{{ kolla-install-type }}-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri

      • docker tag nbos-horizon-plugin-{{ kolla-install-type }}-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri FQDN:5001/nbos/nbos-horizon-plugin-{{ kolla-install-type }}-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri

      Examples,

      • docker tag nbos-horizon-plugin-source-ubuntu:9.1.2.20211021104525-ussuri nbos/nbos-horizon-plugin-source-ubuntu:9.1.2.20211021104525-ussuri

      • docker tag nbos-horizon-plugin-source-ubuntu:9.1.2.20211021104525-ussuri deployment-vm.vxindia.veritas.com:5001/nbos/nbos-horizon-plugin-source-ubuntu:9.1.2.20211021104525-ussuri

  3. Push the tagged image to local registry.

    Run the following commands:

    • nbosdmapi

      docker push FQDN:5001/nbos/nbosdmapi-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri

      For example,

      docker push deployment-vm.vxindia.veritas.com:5001/nbos/nbosdmapi-ubuntu:9.1.2.20211021104525-ussuri

    • nbosdm

      docker push FQDN:5001/nbos/nbosdm-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri

      For example,

      docker push deployment-vm.vxindia.veritas.com:5001/nbos/nbosdm-ubuntu:9.1.2.20211021104525-ussuri

    • nbos-horizon-plugin

      docker push FQDN:5001/nbos/nbos-horizon-plugin-{{ kolla-install-type }}-{{ kolla-base-distro }}:{{ NBOS_version }}-ussuri

      For example,

      docker push deployment-vm.vxindia.veritas.com:5001/nbos/nbos-horizon-plugin-source-ubuntu:9.1.2.20211021104525-ussuri

  4. Add the insecure-registries entry in /etc/docker/daemon.json on all controller and compute nodes.

    Open the daemon.json file and make the changes as follows:

    cat /etc/docker/daemon.json
{
  "log-opts": {
    "max-file": "5",
    "max-size": "50m"
  },
  "registry-mirrors": [
    "http://<deployment node ip>:4000"
  ],
  "insecure-registries": [
    "FQDN:5001"
  ]
}
  5. Add the insecure-registries entry in /etc/docker/daemon.json on deployment nodes.

    If /etc/docker/ directory does not exist, create it and create daemon.json file.

    Open the daemon.json file and make the changes as follows:

    cat /etc/docker/daemon.json
{ "insecure-registries":["FQDN:5001"] }
  6. Restart the docker.

    systemctl restart docker

  7. Verify that the specified images are pushed in the registry.

    • Controller and compute nodes: curl -X GET http://FQDN:5001/v2/_catalog

    • Deployment node: docker info

    For example,

    curl -X GET http://deployment-vm.vxindia.veritas.com:5001/v2/_catalog

    Sample output:

    curl -X GET http://deployment-vm.vxindia.veritas.com:
5001/v2/_catalog
//Output should look like below:
{"repositories":["nbos/nbos-horizon-plugin-source-ubuntu",
"nbos/nbosdm-ubuntu","nbos/nbosdmapi-ubuntu"]}