Veritas CloudPoint Administrator's Guide
- Getting started with CloudPoint
- Section I. Installing and configuring CloudPoint
- Preparing for installation
- Deploying CloudPoint
- Deploying CloudPoint in the AWS cloud
- Using plug-ins to discover assets
- Configuring off-host plug-ins
- AWS plug-in configuration notes
- Google Cloud Platform plug-in configuration notes
- Microsoft Azure plug-in configuration notes
- HPE RMC plug-in configuration notes
- NetApp plug-in configuration notes
- Hitachi plug-in configuration notes
- InfiniBox plug-in configuration notes
- About CloudPoint plug-ins and assets discovery
- Configuring the on-host agents and plug-ins
- Oracle plug-in configuration notes
- Protecting assets with CloudPoint's agentless feature
- Preparing for installation
- Section II. Configuring users
- Section III. Protecting and managing data
- User interface basics
- Indexing and classifying your assets
- Protecting your assets with policies
- Tag-based asset protection
- Replicating snapshots for added protection
- Managing your assets
- About snapshot restore
- Single file restore requirements and limitations
- Additional steps required after a SQL Server snapshot restore
- Monitoring activities with notifications and the job log
- Protection and disaster recovery
- Section IV. Maintaining CloudPoint
- CloudPoint logging
- Troubleshooting CloudPoint
- Working with your CloudPoint license
- Managing CloudPoint agents and plug-ins
- Upgrading CloudPoint
- Uninstalling CloudPoint
- Section V. Reference
Upgrading CloudPoint
In the following upgrade steps, you replace the container that runs your current version of CloudPoint with a new container.
To upgrade CloudPoint
- Make sure that the CloudPoint host (physical host, virtual machine or a cloud instance) meets the requirements of the new CloudPoint version.
- Open the Veritas CloudPoint trial page.
In your browser's address bar, type the following URL:
- On the trial page, provide the requested details and then click Submit to register.
- 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_2.x.x_IE.img.gz
The numerical sequence in the file name represents the CloudPoint product version.
Note:
The actual compressed image file name may vary depending on the product release 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:
# docker load -i <imagefilename>
For example, if the CloudPoint version is
2.1.2
, the command syntax is as follows:# docker load -i Veritas_CloudPoint_2.1.2_IE.img.gz
Messages similar to the following appear on the command line:
644879075e24: Loading layer [===============>] 117.9MB/117.9MB d7ff1dc646ba: Loading layer [===============>] 15.87MB/15.87MB d73dd9qwer58: Loading layer [===============>] 1.812GB/1.812GB 3167ba895aec: Loading layer [===============>] 352.9MB/352.9MB fd22ad285778: Loading layer [===============>] 41.98kB/41.98kB Loaded image: veritas/flexsnap-cloudpoint:2.1.2.7542
Make a note of the loaded image name and version that appears on the last line. 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.
Log on to the CloudPoint user interface (UI) and from the top right corner, click Settings and then click About.
The Current Version field in the About dialog box displays the installed version.
- From the Job Log page, 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 --rm -it -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 step 7 earlier.
For example, if the installed CloudPoint version is 2.0.2.4722, the command will be as follows:
# sudo docker run --rm -it -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:2.0.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-agent.e425d969dd4 ...done Stopping container: flexsnap-agent.4704fd318322 ...done Stopping container: flexsnap-fluentd ...done Stopping container: flexsnap-mongodb ...done Stopping container: flexsnap-rabbitmq ...done Stopping container: flexsnap-authorization-service ...done Stopping container: flexsnap-auth ...done Stopping container: flexsnap-api-gateway ...done Stopping container: flexsnap-api ...done Stopping container: flexsnap-coordinator ...done Stopping container: flexsnap-agent ...done Stopping container: flexsnap-scheduler ...done Stopping container: flexsnap-vic ...done Stopping container: flexsnap-indexingsupervisor ...done Stopping container: flexsnap-telemetry ...done Stopping container: flexsnap-licensing ...done Stopping container: flexsnap-policy ...done Stopping container: flexsnap-cloudpointconsole ...done Stopping container: flexsnap-notification ...done Stopping container: flexsnap-identity-manager-service ...done Stopping container: flexsnap-email-service ...done Stopping container: flexsnap-onhostagent ...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 --rm -it -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 --rm -it -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 in step 6 earlier, the command will be as follows:
# sudo docker run --rm -it -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:2.1.2.7542 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: Thu Jul 11 09:58:02 UTC 2019 Do you wish to continue CloudPoint installation with older docker version. ? (y/n): y This is an upgrade to CloudPoint 2.1.2.7542 Previous CloudPoint version: 2.0.2.4722 Checking if a 1.0 release container exists ... Removing exited container flexsnap-agent.e425d969d ...done Removing exited container flexsnap-agent.47033896e ...done Removing exited container flexsnap-cloudpointconsole ...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-notification ...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-agent ...done Removing exited container flexsnap-coordinator ...done Removing exited container flexsnap-api ...done Removing exited container flexsnap-api-gateway ...done Removing exited container flexsnap-auth ...done Removing exited container flexsnap-rabbitmq ...done Removing exited container flexsnap-mongodb ...done Removing exited container flexsnap-fluentd ...done Deleting network : flexsnap-network ...done Loading images for the CloudPoint services ...done Creating network: flexsnap-network ...done Generating certificates for MongoDB server ...done Starting docker container: flexsnap-fluentd ...done Starting docker container: flexsnap-mongodb ...done Starting docker container: flexsnap-rabbitmq ...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 ...done Starting docker container: flexsnap-auth ...done Starting docker container: flexsnap-api-gateway ...done Starting docker container: flexsnap-api ...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-indexingsupervisor ...done Starting docker container: flexsnap-notification ...done Starting docker container: flexsnap-telemetry ...done Starting docker container: flexsnap-vic ...done Starting docker container: flexsnap-licensing ...done Starting docker container: flexsnap-identity-manager-service ...done Starting docker container: flexsnap-email-service ...done Starting docker container: flexsnap-authorization-service ...done Starting docker container: flexsnap-cloudpointconsole ...done
- Refresh your web browser and log in to the CloudPoint user interface.
- Verify the CloudPoint version.
From the UI, click on Settings from the top right corner and select About.
The Current Version field in the About dialog box should now indicate the new version you just installed.
- This concludes the upgrade process on the host. Verify that your CloudPoint configuration settings and data are preserved as is.
- After upgrading CloudPoint containers on the CloudPoint host, the next step is to upgrade the on-host agents on the Linux and Windows hosts.
Perform the following steps to upgrade the agent on Linux hosts:
Download the newer version of the agent installation package by logging in to the CloudPoint UI.
Stop the flexsnap agent service on the host where you want to upgrade the agent.
# sudo systemctl stop flexsnap-agent.service
Upgrade the agent on the Linux host.
# sudo rpm -Uvh cloudpoint_agent_rpm_name
Here, cloudpoint_agent_rpm_name is the name of the on-host agent rpm package you downloaded earlier.
Start the flexsnap agent service on the host.
# sudo systemctl start flexsnap-agent.service
Reload the daemon, if prompted.
# sudo systemctl daemon-reload
Repeat these steps on all the Linux hosts where you wish to upgrade the Linux-based on-host agent.
Perform the following steps to upgrade the agent on Windows hosts:
Download the newer version of the agent installation package by logging in to the CloudPoint UI.
Upgrade the agent on the Windows host.
Run 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.
Repeat these steps on all the Windows hosts where you wish to upgrade the Windows-based on-host agent.
For details on how to download the agent installation package from the CloudPoint UI, refer to the following:
- If you have deployed CloudPoint on an EC2 instance in the AWS cloud, you now have the option to configure CloudPoint to use AWS KMS service for encrypting and decrypting CloudPoint configuration.
This is an optional step and is applicable only if your CloudPoint 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.
A NetBackup configuration update (this step) is not required if CloudPoint is not deployed in the AWS cloud.
Run the following command on the NetBackup Master server:
# ./tpconfig -update -cloudpoint_server <cloudpoint_server_name> -cloudpoint_server_user_id <user_ID> [-requiredport <IP_port_number>]
Here,
<cloudpoint_server_name> is the fully qualified domain name (FQDN) of the CloudPoint host.
<cloudpoint_server_user> is the CloudPoint administrator user account that is configured on the CloudPoint server.
<IP_port_number> represents the port number used by the CloudPoint server. The default port number is 443. This parameter is required only if CloudPoint host is using a different port.
For example, if the CloudPoint host name is
mycphost.mydomain.dom
and the configured CloudPoint admin user ismycpuser@mycp.com
, then the command syntax is as follows:# ./tpconfig -update -cloudpoint_server mycphost.mydomain.com -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.
Once the NetBackup configuration is updated, you can start using CloudPoint with NetBackup immediately. All the existing CloudPoint configuration settings such as plug-ins, assets, snapshots, restore, and replication jobs are retained and continue to work as is. New assets discovery is performed as per the discovery schedule. 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 CloudPoint without removing deprecated plug-in configurations such as HPE 3PAR, then you may not be able to sign in to the CloudPoint UI after the upgrade. Contact Veritas Technical Support to help you clean the deprecated plug-in entries from the CloudPoint database and get your CloudPoint deployment up and running.