Veritas NetBackup™ CloudPoint Install and Upgrade Guide
- Section I. CloudPoint installation and configuration
- Preparing for CloudPoint installation
- About the deployment approach
- Deciding where to run CloudPoint
- About deploying CloudPoint in the cloud
- Meeting system requirements
- CloudPoint host sizing recommendations
- Creating an instance or preparing the physical host to install CloudPoint
- Installing Docker
- Creating and mounting a volume to store CloudPoint data
- Verifying that specific ports are open on the instance or physical host
- Deploying CloudPoint using the Docker image
- CloudPoint cloud plug-ins
- CloudPoint storage array plug-ins
- NetApp plug-in configuration notes
- Nutanix Files plug-in configuration notes
- Dell EMC Unity array plug-in configuration parameters
- Pure Storage FlashArray plug-in configuration notes
- HPE RMC plug-in configuration notes
- Hitachi plug-in configuration notes
- InfiniBox plug-in configuration notes
- How to configure the CloudPoint storage array plug-ins?
- CloudPoint application agents and plug-ins
- Microsoft SQL plug-in configuration notes
- Oracle plug-in configuration notes
- MongoDB plug-in configuration notes
- About the installation and configuration process
- Preparing to install the Linux-based agent
- Preparing to install the Windows-based agent
- Downloading and installing the CloudPoint agent
- Registering the Linux-based agent
- Registering the Windows-based agent
- Configuring the CloudPoint application plug-in
- Configuring VSS to store shadow copies on the originating drive
- Creating a NetBackup protection plan for cloud assets
- Subscribing cloud assets to a NetBackup protection plan
- About snapshot restore
- Restore requirements and limitations for Microsoft SQL Server
- Restore requirements and limitations for Oracle
- Restore requirements and limitations for MongoDB
- Steps required before restoring SQL AG databases
- Recovering a SQL database to the same location
- Recovering a SQL database to an alternate location
- Additional steps required after a SQL Server snapshot restore
- Additional steps required after restoring SQL AG databases
- SQL snapshot or restore and granular restore operations fail if the Windows instance loses connectivity with the CloudPoint host
- Disk-level snapshot restore fails if the original disk is detached from the instance
- Additional steps required after a MongoDB snapshot restore
- Additional steps required after an Oracle snapshot restore
- Additional steps required after restoring an AWS RDS database instance
- Protecting assets with CloudPoint's agentless feature
- Preparing for CloudPoint installation
- Section II. CloudPoint maintenance
Upgrading CloudPoint
The following procedures describe how to upgrade your CloudPoint deployment. During the upgrade, you replace the container that runs your current version of CloudPoint with a newer container.
To upgrade CloudPoint server that is registered with NetBackup version 8.2.x or older
- On the NetBackup master server, run the following command to stop all NetBackup processes:
UNIX: /usr/openv/netbackup/bin/bp.kill_all
Windows: install_path\NetBackup\bin\bpdown -f
- Upgrade CloudPoint to the latest supported version.
- Upgrade the NetBackup master server.
Refer to the Veritas NetBackup Upgrade Guide for instructions.
- Restart the NetBackup processes.
- Update the NetBackup configuration so that the upgraded CloudPoint configuration details are available with NetBackup.
Perform one of the following actions:
From the NetBackup Web UI, edit the CloudPoint server information.
In the Web UI, click Workloads > Cloud from the left navigation pane and then click the CloudPoint servers tab.
Select the CloudPoint server that you just upgraded, and then click Edit from the ellipsis action button on the right.
In the Edit CloudPoint server dialog, specify all the requested details.
Click Validate to validate the CloudPoint server certificate.
Click Save to update the CloudPoint server configuration.
Or, on the NetBackup master server, run the following command:
# ./tpconfig -update -cloudpoint_server cp-hostname-cloudpoint_server_user_id admin -manage_workload <manage_workload>
On UNIX systems, the directory path to this command is
/usr/openv/volmgr/bin/. On Windows systems, the directory path to this command isinstall_path\Volmgr\bin\. Refer to the Veritas NetBackup Commands Reference Guide for details.Or, make a PATCH API call to the NetBackup master server using the following URL:
https://nbu-master/netbackup/config/servers/snapshot-mgmt-servers/cp-hostname
To upgrade CloudPoint server that is not registered with NetBackup
- Download the CloudPoint upgrade installer.
On the CloudPoint download page, click Download Now to download the CloudPoint installer.
The CloudPoint software components are available in the form of Docker images and these images are packaged in a compressed file. The file name has the following format:
Veritas_CloudPoint_8.x.x.x.img.gz
The numerical sequence in the file name represents the product version.
- Copy the downloaded compressed image file to the computer on which you want to deploy CloudPoint.
- Load the image file using the following command:
# sudo docker load -i <imagefilename>For example, if the version is
8.3.0.8549, the command syntax is as follows:# sudo docker load -i Veritas_CloudPoint_8.3.0.8549.img.gzMessages similar to the following appear on the command line:
Load -i VRTScloudpoint-docker-8.3.0.8549.img.gz 3b48714f4630: Loading layer [====================>] 26.62kB/26.62kB e2be05255641: Loading layer [====================>] 1.022GB/1.022GB f4019e787431: Loading layer [====================>] 71.16MB/71.16MB 8fa41882618d: Loading layer [====================>] 2.56kB/2.56kB 2eb7b5f07188: Loading layer [====================>] 433.6MB/433.6MB 9a80f5e55187: Loading layer [====================>] 3.072kB/3.072kB Loaded image: veritas/flexsnap-policy:8.3.0.8549 4610240a3245: Loading layer [====================>] 2.56kB/2.56kB 009536fb1f1f: Loading layer [====================>] 4.096kB/4.096kB e281e184c054: Loading layer [====================>] 51.31MB/51.31MB 01455a2a7aca: Loading layer [====================>] 38.89MB/38.89MB 0cd7f5d9561b: Loading layer [====================>] 803.8kB/803.8kB cbe0c1de2aeb: Loading layer [====================>] 3.072kB/3.072kB bf3c086d3dc8: Loading layer [====================>] 99.56MB/99.56MB Loaded image: veritas/flexsnap-api-gateway:8.3.0.8549 0c5d3de7e49e: Loading layer [====================>] 38.26MB/38.26MB ecc5f9d1a612: Loading layer [====================>] 57.34kB/57.34kB 02b122e862b3: Loading layer [====================>] 4.327MB/4.327MB Loaded image: veritas/flexsnap-cloudpoint:8.3.0.8549 Loaded image: veritas/flexsnap-fluentd:8.3.0.8549 60b2acb680f6: Loading layer [====================>] 3.584kB/3.584kB f595300c08bc: Loading layer [====================>] 3.584kB/3.584kB Loaded image: veritas/flexsnap-mongodb:8.3.0.8549 Loaded image: veritas/flexsnap-agent:8.3.0.8549 Loaded image: veritas/flexsnap-scheduler:8.3.0.8549 8df81d5ea017: Loading layer [====================>] 7.68kB/7.68kB 7d0351be3c82: Loading layer [====================>] 3.072kB/3.072kB Loaded image: veritas/flexsnap-nginx:8.3.0.8549 2ab7b82b7b67: Loading layer [====================>] 433.6MB/433.6MB cb5786a5d4da: Loading layer [====================>] 3.072kB/3.072kB Loaded image: veritas/flexsnap-coordinator:8.3.0.8549 82845be8152d: Loading layer [====================>] 2.56kB/2.56kB 4335a9dd8761: Loading layer [====================>] 433.6MB/433.6MB 7726c32b0a94: Loading layer [====================>] 3.072kB/3.072kB Loaded image: veritas/flexsnap-onhostagent:8.3.0.8549 ee9829847a2f: Loading layer [====================>] 10.12MB/10.12MB e821f4ed533d: Loading layer [====================>] 2.56kB/2.56kB b2ca6971711b: Loading layer [====================>] 17.92kB/17.92kB ac4489fdf0fb: Loading layer [====================>] 38.26MB/38.26MB 7a3246be4423: Loading layer [====================>] 12.92MB/12.92MB 663007ab9b7a: Loading layer [====================>] 31.74kB/31.74kB Loaded image: veritas/flexsnap-config:8.3.0.8549 7eb7d2ecf33a: Loading layer [====================>] 12.92MB/12.92MB 4cbef47218cf: Loading layer [====================>] 3.072kB/3.072kB Loaded image: veritas/flexsnap-certauth:8.3.0.8549 44ed763d4f00: Loading layer [====================>] 38.29MB/38.29MB a6d54a76196f: Loading layer [====================>] 4.096kB/4.096kB e0340c5d3b40: Loading layer [====================>] 3.072kB/3.072kB Loaded image: veritas/flexsnap-rabbitmq:8.3.0.8549 Loaded image: veritas/flexsnap-notification:8.3.0.8549 45358ab4ca0b: Loading layer [====================>] 42.52MB/42.52MB 31b87f996cd9: Loading layer [====================>] 3.072kB/3.072kB fe498c617335: Loading layer [====================>] 48.66MB/48.66MB Loaded image: veritas/flexsnap-idm:8.3.0.8549 Loaded image: veritas/flexsnap-cloudpoint:8.3.0.8549
Make a note of the loaded image name and version that appears towards the end of the status messages on the command prompt. This represents the new CloudPoint version that you wish to upgrade to. You will need this information in the subsequent steps.
Note:
The version displayed here is used for representation only. The actual version will vary depending on the product release you are installing.
- Make a note of the current CloudPoint version that is installed. You will use the version number in the next step.
- Verify that there are no protection policy snapshots or other operations in progress and then stop CloudPoint by running the following command:
# sudo docker run -it --rm -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:current_version stopHere, current_version represents the currently installed CloudPoint version. Use the version number you noted in the earlier step.
For example, if the installed CloudPoint version is 2.2.2.4722, the command will be as follows:
# sudo docker run -it --rm -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:2.2.2.4722 stopNote:
This is a single command. Ensure that you enter the command without any line breaks.
The CloudPoint containers are stopped one by one. Messages similar to the following appear on the command line:
Stopping the services Stopping container: flexsnap-onhostagent ...done Stopping container: flexsnap-email-service ...done Stopping container: flexsnap-identity-manager-service ...done Stopping container: flexsnap-notification ...done Stopping container: flexsnap-cloudpointconsole ...done Stopping container: flexsnap-policy ...done Stopping container: flexsnap-licensing ...done Stopping container: flexsnap-telemetry ...done Stopping container: flexsnap-indexingsupervisor ...done Stopping container: flexsnap-vic ...done Stopping container: flexsnap-scheduler ...done Stopping container: flexsnap-agent ...done Stopping container: flexsnap-coordinator ...done Stopping container: flexsnap-api ...done Stopping container: flexsnap-api-gateway ...done Stopping container: flexsnap-auth ...done Stopping container: flexsnap-authorization-service ...done Stopping container: flexsnap-rabbitmq ...done Stopping container: flexsnap-mongodb ...done Stopping container: flexsnap-fluentd ...done
Wait for all the CloudPoint containers to be stopped and then proceed to the next step.
- Upgrade CloudPoint by running the following command:
# sudo docker run -it --rm -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:new_version installFor an unattended installation, use the following command:
# sudo docker run -it --rm -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:new_version install -yHere, new_version represents the CloudPoint version you are upgrading to.
The -y option passes an approval for all the subsequent installation prompts and allows the installer to proceed in a non-interactive mode.
For example, using the version number specified earlier, the command will be as follows:
# sudo docker run -it --rm -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:8.3.0.8549 install -yNote:
This is a single command. Ensure that you enter the command without any line breaks.
- The new CloudPoint installer detects the existing CloudPoint containers that are running and asks for a confirmation for removing them.
Press Y to confirm the removal of the old CloudPoint containers.
Note:
No inputs are required if the installer is run in a non-interactive mode.
The installer first loads the individual service images and then launches them in their respective containers.
Wait for the installer to display messages similar to the following and then proceed to the next step:
Installing the services Configuration started at time: Wed Apr 1 14:37:53 UTC 2020 WARNING: No swap limit support Docker server version: 18.09.1 This is an upgrade to CloudPoint 8.3.0.8549 Previous CloudPoint version: 2.2.2.4722 Checking if a 1.0 release container exists ... Removing exited container flexsnap-cloudpointconsole ...done Removing exited container flexsnap-api ...done Removing exited container flexsnap-fluentd ...done Removing exited container flexsnap-authorization-service ...done Removing exited container flexsnap-email-service ...done Removing exited container flexsnap-identity-manager-service ...done Removing exited container flexsnap-licensing ...done Removing exited container flexsnap-vic ...done Removing exited container flexsnap-telemetry ...done Removing exited container flexsnap-indexingsupervisor ...done Removing exited container flexsnap-policy ...done Removing exited container flexsnap-scheduler ...done Removing exited container flexsnap-onhostagent ...done Removing exited container flexsnap-notification ...done Removing exited container flexsnap-agent ...done Removing exited container flexsnap-coordinator ...done Removing exited container flexsnap-mongodb ...done Removing exited container flexsnap-rabbitmq ...done Removing exited container flexsnap-api-gateway ...done Removing exited container flexsnap-auth ...done Deleting network : flexsnap-network ...done Generating certificates for MongoDB server ...done Generating certificates for API-gateway container ...done Generating certificates for few other service container ...done Generating certificates for OnhostAgent container ...done Adding MongoDB certificate to the trust store ... Importing keystore /cloudpoint/keys/idm_store to /cloudpoint/keys/.idm_store_tmp... Entry for alias cacert successfully imported. Entry for alias mongodb successfully imported. Import command completed: 2 entries successfully imported, 0 entries failed or cancelled done Renewing IDM https certificates ...done Starting to generate nginx ssl configuration ...done Creating network: flexsnap-network ...done Starting docker container: flexsnap-fluentd ...done Starting docker container: flexsnap-mongodb ...done Starting docker container: flexsnap-rabbitmq ...done Starting docker container: flexsnap-certauth ...done Starting docker container: flexsnap-api-gateway ...done Starting docker container: flexsnap-coordinator ...done Starting docker container: flexsnap-agent ...done Starting docker container: flexsnap-onhostagent ...done Starting docker container: flexsnap-scheduler ...done Starting docker container: flexsnap-policy ...done Starting docker container: flexsnap-notification ...done Starting docker container: flexsnap-idm ...done Starting docker container: flexsnap-config ...done Starting docker container: flexsnap-nginx ...done
- To verify the CloudPoint version, run the following command:
# sudo docker ps | grep flexsnap-coordinator
- This concludes the upgrade process. Verify that your CloudPoint configuration settings and data are preserved as is.
- Register the CloudPoint server with the NetBackup master server.
Refer to the NetBackup Web UI Cloud Administrator's Guide for instructions.
- Upgrade the CloudPoint agents on the Linux and Windows application hosts.
Perform the following steps to upgrade the agent on Linux hosts:
Sign in to NetBackup UI and download the newer agent package.
Navigate to Cloud > CloudPoint servers > Actions > Download agent.
Stop the flexsnap agent service on the Linux host where you want to upgrade the agent.
Run the following command on the Linux host:
# sudo systemctl stop flexsnap-agent.service
Upgrade the agent on the Linux host.
Run the following command on the Linux host:
# sudo rpm -Uvh --force cloudpoint_agent_rpm_name
Here, cloudpoint_agent_rpm_name is the name of the agent rpm package you downloaded earlier.
Generate the token for agent configuration. Navigate to NetBackup Web UI > Cloud > CloudPoint Servers > Actions > Download agent > Create Token.
Start the flexsnap agent service on the Linux host.
Run the following command on the Linux host:
# sudo systemctl start flexsnap-agent.service --renew --token <auth_token>
Reload the daemon, if prompted.
Run the following command on the Linux host:
# sudo systemctl daemon-reload
Repeat these steps on all the Linux hosts where you wish to upgrade the Linux-based agent.
Perform the following steps to upgrade the agent on Windows hosts:
Sign in to NetBackup UI and download the newer agent package.
Navigate to Cloud > CloudPoint servers > Actions > Download agent.
Stop the Veritas CloudPoint Agent service that is running on the host.
Run the newer version of the agent package file and follow the installation wizard workflow to upgrade the on-host agent on the Windows host.
The installer detects the existing installation and upgrades the package to the new version automatically.
Generate the token for agent configuration. Navigate to NetBackup Web UI > Cloud > CloudPoint Servers > Actions > Download agent > Create Token.
Register the agent on the host again.
From the command prompt, navigate to the agent installation directory (C:\Program Files\Veritas\CloudPoint\) and run the following command:
# flexsnap-agent.exe --renew --token <auth_token>
Repeat these steps on all the Windows hosts where you wish to upgrade the Windows-based agent.
For details on how to download the agent installation package from the NetBackup UI, refer to the following:
- If you have deployed NetBackup on an EC2 instance in the AWS cloud, you now have the option to configure NetBackup to use AWS KMS service for encrypting and decrypting NetBackup configuration.
This is an optional step and is applicable only if your NetBackup deployment is using the default encryption mechanism and AWS KMS is not already configured in that environment.
- If CloudPoint is deployed in the AWS cloud and is integrated into a Veritas NetBackup environment, the next step is to update the NetBackup configuration so that the upgraded CloudPoint configuration details are available with NetBackup.
Performing this step ensures that the AWS IAM configuration settings in CloudPoint are updated in the NetBackup configuration.
Perform one of the following actions:
From the NetBackup Web UI, add the CloudPoint server information.
In the Web UI, click Workloads > Cloud from the left navigation pane and then click the CloudPoint servers tab.
Click the Add button on the right and then in the Add CloudPoint server dialog, specify all the requested details.
Click Validate to validate the CloudPoint server certificate.
Click Add to add the CloudPoint server configuration.
Or, run the following command on the NetBackup master server:
# ./tpconfig -add -cloudpoint_server <cloudpoint_server_name> -cloudpoint_server_user_id <user_ID> -manage_workload manage_workload [-requiredport <IP_port_number>]
For example, if the CloudPoint host name is
mycphost.mydomain.domand the configured CloudPoint admin user ismycpuser@mycp.com, then the command syntax is as follows:# ./tpconfig -add -cloudpoint_server mycphost.mydomain.com -manage_workload manage_workload -cloudpoint_server_user_id mycpuser@mycp.com
When prompted, enter the password for the CloudPoint user that you specified in the command earlier, and then enter the password again to confirm.
Or, make a PATCH API call to the NetBackup master server using the following URL: https://nbu-master/netbackup/config/servers/snapshot-mgmt-servers/
Once the NetBackup configuration is updated, you can start using CloudPoint with NetBackup immediately. After the CloudPoint is upgraded, the asset discovery is triggered again. All the existing CloudPoint configuration settings such as plug-ins, assets, snapshots, restore, and replication jobs are retained and continue to work as is. If you add a new AWS region, AWS IAM is used to discover and perform operations on the assets in that region.
For more details about the tpconfig command and its options, refer to the Veritas NetBackup Commands Reference Guide. For more information about CloudPoint and Veritas NetBackup integration, refer to the Veritas NetBackup Web UI Cloud Administrator's Guide.
Note:
If you have upgraded NetBackup without removing deprecated plug-in configurations such as HPE 3PAR, then you may not be able to sign in to the NetBackup UI after the upgrade. Contact Veritas Technical Support to help you clean the deprecated plug-in entries from the NetBackup database and get your NetBackup deployment up and running.