Search <book_title>...

Veritas NetBackup™ CloudPoint Install and Upgrade Guide

Last Published: 2021-01-01

Product(s): NetBackup & Alta Data Protection (9.0.0.1)

Platform: Linux

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

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.gz

Messages 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.
(Optional) Create a backup for CloudPoint folder and store it a different location.
For example:
# tar -cvzhf /<store-location>/CP_meta.tar.gz /cloudpoint

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 stop

Here, 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 stop

Note:

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 install
```
For 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 -y
```
Here, 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 -y
```
Note:
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.
If CloudPoint is not registered with the NetBackup master server, you must register it.
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 > Add 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 > Add 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 > Add 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 > Add 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:
See Downloading and installing the CloudPoint agent.
If you upgrading from version 8.2 or earlier, you must 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 is install_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

For more details about the tpconfig command and its options, refer to the Veritas NetBackup Commands Reference Guide.