NetBackup™ for OpenStack Administrator's Guide
- Introduction
- Deploying NetBackup for OpenStack
- Requirements
- NetBackup for OpenStack network considerations
- Existing endpoints in OpenStack
- OpenStack endpoints required by NetBackup for OpenStack
- Recommendation: Provide access to all OpenStack Endpoint types
- Backup target access required by NetBackup for OpenStack
- Example of a typical NetBackup for OpenStack network integration
- Other examples of NetBackup for OpenStack network integrations
- Preparing the installation
- Spinning up the NetBackup for OpenStack VM
- About NetBackup for OpenStack backup target types
- Installing NetBackup for OpenStack Components
- Installing on RHOSP
- Prepare for deployment
- Uploading the NetBackup for OpenStack puppet module
- Updating the overcloud roles data file to include NetBackup for OpenStack services
- Preparing the NetBackup for OpenStack container images
- Providing the environment details in nbos_env.yaml
- Deploying the overcloud with NetBackup OpenStack environment
- Verifying the deployment
- Additional Steps on NetBackup for OpenStack Appliance
- Troubleshooting for overcloud deployment failures
- Installing on Ansible OpenStack Ussuri
- Installing on Kolla Ussuri
- Changing the nova user ID on the NetBackup for OpenStack Nodes
- Copying the NetBackup for OpenStack deployment scripts
- Copying the NetBackup for OpenStack deployment scripts to Kolla-ansible deploy scripts
- Pushing NetBackup for OpenStack images to the local registry
- Editing globals.yml to set NetBackup for OpenStack parameters
- Enabling the NetBackup for OpenStack snapshot mount feature
- Pulling the NetBackup for OpenStack container images
- Deploying the NetBackup for OpenStack components
- Verifying the NetBackup for OpenStack deployment
- Installing on RHOSP
- Configuring NetBackup for OpenStack
- Post Installation Health-Check
- Uninstalling NetBackup for OpenStack
- Uninstalling from RHOSP
- Clean NetBackup for OpenStack Datamover API service
- Clean NetBackup for OpenStack Datamover Service
- Clean NetBackup for OpenStack haproxy resources
- Clean NetBackup for OpenStack Keystone resources
- Clean NetBackup for OpenStack database resources
- Revert overcloud deploy command
- Revert back to original RHOSP Horizon container
- Destroy the NetBackup for OpenStack VM Cluster
- Uninstalling from Ansible OpenStack
- Uninstall NetBackup for OpenStack Services
- Destroy NetBackup for OpenStack Datamover API container
- Clean openstack_user_config.yml
- Remove NetBackup for OpenStack haproxy settings in user_variables.yml
- Remove NetBackup for OpenStack Datamover API inventory file
- Remove NetBackup for OpenStack Datamover API service endpoints
- Delete NetBackup for OpenStack Datamover API database and user
- Remove nbosdmapi rabbitmq user from rabbitmq container
- Clean haproxy
- Remove certificates from Compute nodes
- Destroy the NetBackup for OpenStack VM Cluster
- Uninstalling from Kolla Openstack
- Cleaning NetBackupOpenStack_datamover_api container
- Cleaning NetBackupOpenStack_datamover container
- Cleaning haproxy of NetBackupOpenStack Datamover API
- Cleaning Kolla Ansible deployment procedure
- Reverting to original Horizon container
- Cleaning Keystone resources
- Cleaning NetBackup for OpenStack database resources
- Destroy the NetBackup for OpenStack VM Cluster
- Uninstalling from RHOSP
- Install nbosjm CLI client
- Configuring NetBackup OpenStack Appliance
- Configuring NetBackup Master Server
- NetBackup for OpenStack policies
- Performing backups and restores of OpenStack
- About snapshots
- List of snapshots
- Creating a snapshot
- Snapshot overview
- Delete snapshots
- Cleaning up the volume snapshots
- Snapshot Cancel
- About restores
- List of Restores
- Restores overview
- Delete a Restore
- Cancel a Restore
- One-Click Restore
- Selective Restore
- In-place restore
- Required restore.json for CLI
- About file search
- Navigating to the file search tab in Horizon
- Configuring and starting a file search in Horizon
- Start the File Search and retrieve the results in Horizon
- Doing a CLI File Search
- About snapshot mount
- Creating a file recovery manager instance
- Mounting a snapshot
- Accessing the File Recovery Manager
- Identifying mounted snapshots
- Unmounting a snapshot
- About schedulers
- Disable a schedule
- Enable a schedule
- Modify a schedule
- About email notifications
- Requirements to activate email Notifications
- Activate/Deactivate the email Notifications
- Performing Backup Administration tasks
- NBOS Backup Admin Area
- Policy Attributes
- Policy Quotas
- Managing Trusts
- Policy import and migration
- Disaster Recovery
- Example runbook for disaster recovery using NFS
- Scenario
- Prerequisites for the disaster recovery process
- Disaster recovery of a single policy
- Copy the policy directories to the configured NFS Volume
- Make the Mount-Paths available
- Reassign the policy
- Add admin-user to required domains and projects
- Discover orphaned policies from NFS-Storage of Target Cloud
- List available projects on Target Cloud in the Target Domain
- List available users on the Target Cloud in the Target Project that have the right backup trustee role
- Reassign the policy to the target project
- Verify that the policy is available at the desired target_project
- Restore the policy
- Clean up
- Disaster recovery of a complete cloud
- Reconfigure the Target NetBackup for OpenStack installation
- Make the Mount-Paths available
- Reassign the policy
- Add admin-user to required domains and projects
- Discover orphaned policies from NFS-Storage of Target Cloud
- List available projects on Target Cloud in the Target Domain
- List available users on the Target Cloud in the Target Project that have the right backup trustee role
- Reassign the policy to the target project
- Verify that the policy is available at the desired target_project
- Restore the policy
- Reconfigure the Target NetBackup for OpenStack installation back to the original one
- Clean up
- Troubleshooting
- General Troubleshooting Tips
- Using the nbosjm CLI tool on the NetBackup for OpenStack Appliance
- Health check of NetBackup for OpenStack
- Important log files
- Troubleshooting NBOSDM container in offline state due to unavailable mount point
- About permission denied error when same NFS share path is used across multiple OpenStack distributions
- Index
Providing the environment details in nbos_env.yaml
Provide backup target details and other necessary details in the provided environment file. This environment file is used in the overcloud deployment to configure NetBackup for OpenStack components. Container image names have already been populated in the preparation of the container images. Still it is recommended to verify the container URLs.
The following information is required additionally:
Network for the nbosdmapi
nbosdm password
Backup target type {nfs/s3}
In case of NFS
List of NFS Shares
NFS options
In case of S3
S3 type {amazon_s3/ceph_s3}
S3 Access key
S3 Secret key
S3 Region name
S3 Bucket
S3 Endpoint URL
S3 Signature Version
S3 Auth Version
S3 SSL Enabled {true/false}
S3 SSL Cert
Note:
Use ceph_s3 for any non-aws S3 backup targets.
resource_registry:
OS::TripleO::Services::nbosdm: ../services/nbosdm.yaml
OS::TripleO::Services::nbosdmapi: ../services/nbosdmapi.yaml
# NOTE: If there are addition customizations to the endpoint map
(e.g. for
# other integratiosn), this will need to be regenerated.
OS::TripleO::EndpointMap: endpoint_map.yaml
parameter_defaults:
## Enable NetBackup for OpenStack's quota functionality on horizon
ExtraConfig:
horizon::customization_module: 'dashboards.overrides'
## Define network map for NetBackup OpenStack Datamover API Service
ServiceNetMap:
nbosdmapiNetwork: internal_api
## NetBackup for OpenStack Datamover Password for keystone and database
nbosdmPassword: "test1234"
## NetBackup for OpenStack container pull urls
docker_nbosdm_image: nbos-undercloud:8787/nbosdm:9.0.1017-rhosp16.1
docker_nbosdmapi_image: nbos-undercloud:8787/nbosdmapi:9.0.1017-rhosp16.1
## If you do not want NetBackup for OpenStack's horizon plugin
to replace your horizon container, just comment following line.
ContainerHorizonImage: nbos-undercloud:8787/nbos-horizon-plugin:
9.0.1017-rhosp16.1
## Backup target type nfs/s3, used to store snapshots taken by
NetBackup for OpenStack
BackupTargetType: 'nfs'
## For backup target 'nfs'
NfsShares: '192.168.122.101:/opt/nbos'
NfsOptions: 'nolock,soft,timeo=180,intr,lookupcache=none'
## For backup target 's3'
## S3 type: amazon_s3/ceph_s3
S3Type: 'amazon_s3'
## S3 access key
S3AccessKey: ''
## S3 secret key
S3SecretKey: ''
## S3 region, if your s3 does not have any region, just keep the
parameter as it is
S3RegionName: ''
## S3 bucket name
S3Bucket: ''
## S3 endpoint url, not required for Amazon S3, keep it as it is
S3EndpointUrl: ''
## S3 signature version
S3SignatureVersion: 'default'
## S3 Auth version
S3AuthVersion: 'DEFAULT'
## If S3 backend is not Amazon S3 and SSL is enabled on S3 endpoint u
rl then change it to 'True', otherwise keep it as 'False'
S3SslEnabled: False
## If S3 backend is not Amazon S3 and SSL is enabled on S3 endpoint
URL and SSL certificates are self signed, then
## user need to set this parameter value to:
'/etc/nbosdm/s3-cert.pem', otherwise keep it's value
as empty string.
S3SslCert: ''
## Don't edit following parameter
EnablePackageInstall: True