CP Admin 21 Ubuntu
CP Admin 21 Ubuntu
CP Admin 21 Ubuntu
1
Administrator's Guide
Linux
Veritas CloudPoint Administrator's Guide
Last updated: 2018-10-04
Legal Notice
Copyright © 2018 Veritas Technologies LLC. All rights reserved.
Veritas, the Veritas Logo, Veritas InfoScale, and NetBackup are trademarks or registered
trademarks of Veritas Technologies LLC or its affiliates in the U.S. and other countries. Other
names may be trademarks of their respective owners.
This product may contain third-party software for which Veritas is required to provide attribution
to the third party (“Third-Party Programs”). Some of the Third-Party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the third-party legal notices document accompanying this
Veritas product or available at:
https://www.veritas.com/licensing/process
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:
https://www.veritas.com/support
You can manage your Veritas account information at the following URL:
https://my.veritas.com
If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:
Japan [email protected]
Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:
You can also see documentation information or ask a question on the Veritas community site:
http://www.veritas.com/community/
Contents
■ About CloudPoint
About CloudPoint
Before you work with CloudPoint, it's helpful to have an overview. The following
figure traces your path through CloudPoint, from installation and configuration
through to data protection. Knowing this process makes getting started much easier.
Getting started with CloudPoint 10
What kinds of assets can you protect?
The following table shows the types of assets CloudPoint protects. The specific
assets you can protect depends on the type of CloudPoint license you have.
■ Cloud - This license supports only cloud plug-ins. It lets you take
application-consistent snapshots of your workloads, such as AWS, GCP, and
Azure.
■ On-prem - This license supports only on-prem plug-ins. It lets you take
application-consistent snapshots of your workloads, such as array plug-ins,
hypervisor, and so on.
The perpetual licenses are based on capacity. You can buy the perpetual licenses
as per your capacity requirements. For information on how to purchase these
licenses, contact your Veritas representative.
Subscriptions are 12, 24, or 36 months, and the cost of the licenses depends on
the amount of FETB or instance that you protect. For information on how to purchase
these licenses, contact your Veritas representative.
The following table summarizes what each license provides.
■ Azure
■ GCP
Meter FETB <=10GB Per FETB or per Per FETB Per FETB
10-pack instance
■ Verifying that specific ports are open on the instance or physical host
Category Support
Operating systems Red Hat Enterprise Linux (RHEL) 7.5; Oracle has been
verified on RHEL 7.1, 7.2, and 7.3
Microsoft Azure
Google Cloud
Category Support
■ Model: FA-405
■ Firmware: 4.10.6
■ Software revision: - clab-purestorage
201707072301+e0bed39
The host on which you install CloudPoint must meet the following requirements.
Amazon Web Services ■ Elastic Compute Cloud (EC2) instance type: t2.large
■ vCPUs: 2
■ RAM: 8 GB
■ Root disk: 64 GB with a solid-state drive (GP2)
■ Data volume: 50 GB Elastic Block Store (EBS) volume of
type GP2 with encryption for the snapshot asset database;
use this as a starting value and expand your storage as
needed.
Preparing for installation 19
Meeting system requirements
The host on which you install CloudPoint must have enough free space to
accommodate the following components.
Preparing for installation 20
Creating an instance or preparing the physical host to install CloudPoint
The browser on which you access the CloudPoint user interface must meet the
following requirements.
Browser Versions
CloudPoint only runs on desktop devices. Mobile devices are not supported.
# systemctl daemon-reload
Table 2-5 Volume creation steps for each support cloud vendor
Vendor Procedure
Amazon Web The procedure creates a volume and file system to store CloudPoint
Services (AWS) data.
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/
ebs-using-volumes.html
Google Cloud ◆ Create the disk for the virtual machine, initialize it, and mount it to
Platform /cloudpoint.
https://cloud.google.com/compute/docs/disks/add-persistent-disk
Microsoft Azure 1 Create a new disk and attach it to the virtual machine.
https://docs.microsoft.com/en-us/
azure/virtual-machines/linux/attach-disk-portal
https://docs.microsoft.com/en-us/azure/virtual-machines/linux/
attach-disk-portal#use-azure-managed-disks
https://docs.microsoft.com/en-us/
azure/virtual-machines/linux/add-disk
Port Description
443 The CloudPoint user interface uses this port as the default HTTPS port.
Preparing for installation 23
Verifying that specific ports are open on the instance or physical host
Port Description
5671 The CloudPoint RabbitMQ server uses this port for communications. This
port must be open to support multiple agents.
■ Deploying CloudPoint
Deploying CloudPoint
The following figure shows where you are at in the CloudPoint installation and
configuration process.
Figure 3-1 You are here in the installation and configuration process
Before you complete the steps in this section, make sure that you complete the
following:
■ Decide where to install CloudPoint.
See “Deciding where to run CloudPoint” on page 16.
Note: If you plan to install CloudPoint on multiple hosts, read this section carefully
and understand the implications of this approach.
■ Create the instance on which you install CloudPoint or prepare the physical
host.
See “Creating an instance or preparing the physical host to install CloudPoint”
on page 20.
■ Install Docker for Ubuntu.
See “Installing Docker for Ubuntu” on page 20.
■ Install Docker for RHEL
See “Installing Docker for RHEL” on page 21.
■ Create and mount a volume to store CloudPoint data.
See “Creating and mounting a volume to store CloudPoint data” on page 21.
■ Verify that specific ports are open on the instance or physical host.
See “Verifying that specific ports are open on the instance or physical host”
on page 22.
Veritas distributes a Docker image with CloudPoint already installed. The image is
located on the Veritas' customer portal, MyVeritas.
Note: When you deploy CloudPoint, you may want to copy the commands below
and paste them in your command line interface. If you do, replace the information
in these examples that is different from your own: the product and build version,
the download directory path, and so on.
To deploy CloudPoint
1 Download the CloudPoint image from https://my.veritas.com.
The CloudPoint image name has the following format:
Veritas_CloudPoint_2.x.x_IE.img.gz
For example:
The last line of the output displays the image name. You specify the image
name in the next step.
5 Type the following command to run the CloudPoint container:
For example:
In this step, CloudPoint does the following and displays the results on the
screen:
■ Creates containers for each of the CloudPoint services.
Deploying CloudPoint 27
Configuring CloudPoint from your browser and signing in
The deployment process is complete. The next step is to launch the CloudPoint
user interface in your browser and complete the final configuration steps.
See “Configuring CloudPoint from your browser and signing in” on page 27.
Note: If you ever need to restart CloudPoint, use the docker run command so that
your environmental data is preserved.
Figure 3-2 You are here in the installation and configuration process
Before you complete the steps in this section, make sure that you have deployed
CloudPoint on your instance or physical machine.
Deploying CloudPoint 28
Configuring CloudPoint from your browser and signing in
Browser Versions
https://ubuntu_docker_host_name
For RHEL:
https://rhel_docker_host_name
The configuration screen is displayed and the host name is added to the list
of hosts on which to configure CloudPoint.
2 Enter a username and password. They are used as the CloudPoint admin
username and password.
Note: Use a valid email address for the username. That way, if you forget the
admin password, you can recover it through the Forgot Password link.
■ No spaces
■ No & (ampersand) character
3 (Optional) If you want to add more hosts, enter the URL in the Hosts field and
click +. The host is added to the list of hosts to configure.
Your next step is to configure one or more "plug-ins." Plug-ins are the software
modules that discover assets in your cloud or on-premises environment.
See “Verifying that CloudPoint installed successfully” on page 31.
■ Verify that the following CloudPoint services are running and have UP status.
# sudo docker ps -a
CONTAINER ID IMAGE
64d8cfa67d45 veritas/flexsnap-cloudpointconsole:2.x.x.build_number
9c473d149b61 veritas/flexsnap-api:2.x.x.build_number
0b8bcda79230 veritas/flexsnap-authorization-service:2.x.x.build_number
65a2513cfd40 veritas/flexsnap-email-service:2.x.x.build_number
dde026af67ec veritas/flexsnap-identity-manager-service:2.x.x.build_number
0c77c17226d1 veritas/flexsnap-licensing:2.x.x.build_number
04e2ee045662 veritas/flexsnap-vic:2.x.x.build_number
b8c0b4701a3b veritas/flexsnap-telemetry:2.x.x.build_number
a2ef16eefb1b veritas/flexsnap-indexingsupervisor:2.x.x.build_number
2ea01c1bdde4 veritas/flexsnap-policy:2.x.x.build_number
dc9c4d876af5 veritas/flexsnap-scheduler:2.x.x.build_number
fed212873d4b veritas/flexsnap-agent:2.x.x.build_number
26587cf34a97 veritas/flexsnap-coordinator:2.x.x.build_number
3580990e16c3 veritas/flexsnap-mongodb:2.x.x.build_number
9f6a297da6dc veritas/flexsnap-rabbitmq:2.x.x.build_number
87734a3dcc0d veritas/flexsnap-auth:2.x.x.build_number
Chapter 4
Using plug-ins to discover
assets
This chapter includes the following topics:
■ About plug-ins
About plug-ins
The following figure shows where you are in the CloudPoint installation and
configuration process.
Figure 4-1 You are here in the installation and configuration process
■ You can run multiple instances of a plug-in to gather information from multiple
sources within a particular type of asset. For example, you can deploy a separate
AWS plug-in for each AWS account.
■ You can also run multiple instances of a plug-in for the same data source but
in separate processes or hosts for load-balancing or high availability purposes.
■ Each plug-in is wrapped in an agent.
See “About agents” on page 51.
See “Determining the types of plug-ins and agents to install” on page 33.
See “Dell EMC Unity array plug-in configuration notes” on page 43.
See “Google Cloud Platform plug-in configuration notes” on page 44.
See “Hewlett-Packard Enterprise 3PAR plug-in configuration notes” on page 46.
See “Microsoft Azure plug-in configuration notes” on page 47.
See “Nutanix plug-in configuration notes” on page 49.
See “Pure Storage FlashArray plug-in configuration notes” on page 50.
The following procedure configures an AWS plug-in.
Configuring off-host plug-ins 37
Configuring an off-host plug-in
2 On the Clouds and Arrays page, select the plug-in to configure. (This example
configures an Azure plug-in. When you select the plug-in, the Details page for
the plug-in is displayed.
Note: If you configure a Google Cloud plug-in, make sure you that format the
private key data properly before you enter it in the Private Key field.
See “Google Cloud Platform plug-in configuration notes” on page 44.
Note: Before you configure the AWS plug-in, make sure that you have configured
the proper permissions so CloudPoint can work with your AWS assets.
When you configure on the AWS plug-in on the CloudPoint user interface, specify
the information in the following table.
Access key The access key ID, when specified with the secret access
key, authorizes CloudPoint to interact with the AWS APIs.
When CloudPoint connects to AWS, it uses the following endpoints. You can use
this information to create a whitelist on your firewall.
■ ec2.*.amazonaws.com
■ sts.amazonaws.com
■ rds.*.amazonaws.com
■ kms. *.amazonaws.com
In addition, you must specify the following resources and actions:
■ ec2.SecurityGroup.*
■ ec2.Subnet.*
■ ec2.Vpc.*
■ ec2.createInstance
■ ec2.runInstances
See “Configuring an off-host plug-in” on page 35.
AWS permission policy lists the policy that you should use with CloudPoint.
KMS permission policy lists the policy that you should use with CloudPoint.
To configure permissions on Amazon Web Services
1 Create or edit an AWS user account from Identity and Access Management
(IAM).
2 Do one of the following.
■ To create a new AWS user account, do the following:
■ From IAM, select the Users pane and click Add user.
■ In the User name field, enter a name for the new user.
■ Select the Access type. This value determines how AWS accesses the
permission policy. (This example uses Programmatic access).
■ Select Next: Permissions.
■ On the Set permissions for username screen, select Attach existing
policies directly.
■ Select the previously created permission policy (shown below) and
select Next: Review.
■ On the Permissions summary page, select Create user.
■ Obtain the Access Key and Secret Key for the newly created user.
"Effect": "Allow",
"Action": [
"ec2:DetachVolume",
"ec2:AttachVolume",
"ec2:RebootInstances",
"ec2:DeleteSnapshot",
"ec2:DeleteTags",
"ec2:CreateTags",
"ec2:RunInstances",
"ec2:StopInstances",
"ec2:CreateVolume",
"ec2:DeleteVolume",
"ec2:ModifySnapshotAttribute",
"ec2:StartInstances",
"ec2:CreateSnapshot"
],
"Resource": [
"arn:aws:ec2:*:*:subnet/*",
"arn:aws:ec2:*:*:instance/*",
"arn:aws:ec2:*::snapshot/*",
"arn:aws:ec2:*:*:volume/*",
"arn:aws:ec2:*:*:security-group/*",
"arn:aws:ec2:*:*:network-interface/*",
"arn:aws:ec2:*::image/*"
]
},
{
"Sid": "VisualEditor1",
"Effect": "Allow",
"Action": [
"ec2:CopySnapshot",
"ec2:DescribeInstances",
"ec2:MonitorInstances",
"ec2:DescribeVolumesModifications",
"ec2:CreateImage",
"ec2:CopyImage",
"ec2:DescribeSnapshots",
"ec2:DescribeVolumeStatus",
"ec2:ModifySnapshotAttribute",
"ec2:DescribeVolumes",
"rds:ModifyDBInstance",
"rds:ModifyDBClusterSnapshotAttribute",
"ec2:ImportImage",
Configuring off-host plug-ins 42
Amazon Web Services plug-in configuration notes
"ec2:ResetImageAttribute",
"ec2:ImportKeyPair",
"rds:DescribeDBSnapshots",
"ec2:DescribeSnapshotAttribute",
"ec2:RegisterImage",
"ec2:RunInstances",
"rds:DeleteDBSnapshot",
"ec2:DescribeVolumeAttribute",
"ec2:DescribeImportSnapshotTasks",
"ec2:CreateNetworkInterface",
"ec2:CreateDefaultVpc",
"rds:CreateDBSnapshot",
"rds:RestoreDBInstanceFromDBSnapshot",
"rds:ModifyDBCluster",
"rds:CreateDBClusterSnapshot",
"ec2:CreateSubnet",
"ec2:DescribeSubnets",
"rds:ModifyDBSnapshotAttribute",
"ec2:CreateVpnConnection",
"ec2:DeregisterImage",
"ec2:ImportVolume",
"ec2:DeleteSnapshot",
"rds:RestoreDBClusterFromSnapshot",
"rds:DescribeDBSubnetGroups",
"ec2:DescribeInstanceAttribute",
"ec2:DescribeRegions",
"ec2:CreateVpc",
"ec2:ModifyImageAttribute",
"ec2:CreateDefaultSubnet",
"ec2:DescribeAvailabilityZones",
"rds:CreateDBInstance",
"ec2:CreateSnapshot",
"rds:DescribeDBInstances",
"rds:RestoreDBClusterToPointInTime",
"ec2:DescribeInstanceStatus",
"ec2:ImportInstance",
"ec2:AttachVpnGateway",
"rds:CopyDBSnapshot",
"ec2:ResetSnapshotAttribute",
"ec2:ImportSnapshot",
"rds:DescribeDBSnapshotAttributes",
"ec2:DescribeHosts",
"ec2:DescribeImages",
Configuring off-host plug-ins 43
Dell EMC Unity array plug-in configuration notes
"rds:DeleteDBClusterSnapshot",
"rds:ListTagsForResource",
"rds:CreateDBSecurityGroup",
"rds:CreateDBCluster",
"ec2:DescribeVpcs",
"rds:DescribeDBClusterSnapshots",
"ec2:AttachNetworkInterface",
"sts:GetCallerIdentity",
"rds:DescribeDBClusters",
"rds:RestoreDBInstanceToPointInTime"
],
"Resource": "*"
}
]
}
CloudPoint Description
configuration parameter
For more information, see the EMC Unity™ Quick Start Guide.
See “Configuring an off-host plug-in” on page 35.
Configuring off-host plug-ins 44
Google Cloud Platform plug-in configuration notes
Project ID The ID of the project from which the resources are managed.
Listed as project_id in the JSON file.
Client Email The email address of the Client ID. Listed as client_email
in the JSON file.
Private Key The private key. Listed as private_key in the JSON file.
Note: You must enter this key without quotes (neither single
quotes nor double quotes). Do not enter any spaces or return
characters at the beginning or end of the key.
{
"type": "service_account",
"project_id": "fake-product",
"private_key_id": "somelogguid1234567890",
"private_key": "-----BEGIN PRIVATE KEY-----\n
N11EvA18ADAN89kq4k199w08AQEFAA5C8KYw9951A9EAAo18AQCnvpuJ3oK974z4\n
.
.
.
weT9odE4ryl81tNU\nV3q1XNX4fK55QTpd6CNu+f7QjEw5x8+5ft05DU8ayQcNkX\n
4pXJoDol54N52+T4qV4WkoFD5uL4NLPz5wxf1y\nNWcNfru8K8a2q1/9o0U+99==\n
-----END PRIVATE KEY-----\n",
"client_email": "[email protected]",
"client_id": "000000000000001",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://accounts.google.com/o/oauth2/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com \
/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1 \
/metadata/x509/ email%40xyz-product.iam.gserviceaccount.com"
}
3 When you configure the plug-in from the CloudPoint user interface, copy and
paste the reformatted private key into the Private Key field. The reformatted
private_key should look similar to the following:
Note: You can restore a COW snapshot, but not a clone snapshot.
CloudPoint Description
configuration parameter
"Microsoft.Resources/subscriptions/resourceGroups/ \
validateMoveResources/action",
"Microsoft.Resources/subscriptions/tagNames/tagValues/write",
"Microsoft.Resources/subscriptions/tagNames/write",
"Microsoft.Subscription/*/read",
"Microsoft.Authorization/*/read" ],
"NotActions": [ ],
"AssignableScopes": [
"/subscriptions/subscription_GUID",
"/subscriptions/subscription_GUID/ \
resourceGroups/myCloudPointGroup" ] }
To create a custom role using power shell, follow the steps in the following Azure
documentation:
https://docs.microsoft.com/en-us/azure/role-based-access-control/tutorial-custom-role-powershell
For example:
To create a custom role using Azure CLI, follow the steps in the following Azure
documentation:
https://docs.microsoft.com/en-us/azure/role-based-access-control/tutorial-custom-role-cli
For example:
Note: You must copy the json in the input file like ReaderSupportRole.json
CloudPoint Description
configuration parameter
■ About agents
About agents
CloudPoint agents do the following:
Configuring the on-host agents and plug-ins 52
About agents
Application x
Table 6-1 Asset types and the type of agent required (continued)
File system x
■ Linux
■ Windows 2012 and 2016
# yum install \
https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm -y
■ Type the following command to install the Open SSL version 1.0.2k or higher:
If you are installing the Linux-based agent to discover Oracle applications, optimize
your Oracle database files and metadata files.
See “Optimizing your Oracle database data and metadata files” on page 54.
Configuring the on-host agents and plug-ins 54
Preparing to install the Windows-based on-host agent
Figure 6-1 Your path through the installation and configuration process
5 On the Connect dialog box, make sure the RPM tab is selected. Do one of
the following:
■ To download the Linux-based agent, click Download RPM.
■ To download the Windows-based agent, click Download EXE.
Configuring the on-host agents and plug-ins 57
Downloading and installing an on-host agent
Do not close the Connect dialog box. When you configure the agent, you will
return to this dialog box to get a token.
Note: You can also download the agent software by clicking the Settings
(gear) icon at the top of the dashboard and selecting Download Agent PRM
or Download Agent EXE.
For example:
Configuring the on-host agents and plug-ins 58
Configuring a Linux-based on-host agent
C: unzip CloudPoint_agent_EXE_name
# rm -rf /opt/VRTScloudpoint/keys
2 Type the following command in the /etc directory to create a configuration file
called flexsnap.conf.
# vi /etc/flexsnap.conf
[global]
target = IP_address_where_CloudPoint_is_installed
4 On the CloudPoint dashboard, return to the Connect dialog box. If you closed
the dialog box, do the following:
■ On the dashboard, in the Host area, click Manage.
■ On the Asset Management page, select the host.
Configuring the on-host agents and plug-ins 59
Configuring a Linux-based on-host agent
5 On the Connect dialog box, on the RPM tab, click Create Token. This token
is used to authorize the host to CloudPoint.
# flexsnap-agent copied_token
Note: During configuration, when the plug-in tries to load pymongo for the first time,
the Linux on-host agent crashes. Restart the on-host agent. You can then configure
the MongoDB plug-in successful and begin to take snapshots.
2 Using Notepad, open flexsnap.conf, add the following lines, and save the
file:
[global]
target = CloudPoint_Public_Name or
IP_address_where_CloudPoint_is_installed
3 On the CloudPoint dashboard, return to the Connect dialog box. If you closed
the dialog box, do the following:
■ On the dashboard, in the Host area, click Manage.
■ On the Asset Management page, select the host.
Configuring the on-host agents and plug-ins 62
Configuring a Windows-based on-host agent
4 On the Connect dialog box, on the RPM tab click Create Token. This token
is used to authorize the host to CloudPoint.
flexsnap-agent_name.exe jointoken
flexsnap-agent_name.exe
[global]
target = CloudPoint_Public_Name or
IP_address_where_CloudPoint_is_installed
4 From the Connect dialog box on the CloudPoint user interface copy the token.
5 Copy the token and start the flexsnap-agent. Navigate to where you installed
the .zip file, and enter the following:
flexsnap-agent_name.exe jointoken
flexsnap-agent_name.exe
Where maxsize equals the maximum free space usage on the shadow storage
drive.
For example:
3 Click Configure and select the MS SQL plug-in from the drop-down list.
4 Return to the dashboard.
5 In the Applications widget, click Manage.
The Asset Management page lists the Microsoft SQL databases on the
Windows host. If the databases are not displayed, wait for a minute and refresh
your browser.
2 Verify that the flexsnap-agent.exe is not running in memory. Open the Task
Manager check the Processes tab.
Configuring the on-host agents and plug-ins 67
Running the Windows agent as a service
cd C:\Program Files\Veritas\CloudPoint\ ^
flexsnap-windows-svc.exe --startup=delayed install
If you want to run the service under a domain or other (non-system) account,
use the following command instead:
cd C:\Program Files\Veritas\CloudPoint\ ^
flexsnap-windows-svc.exe --username=DOMAIN\username ^
--password=password --startup=delayed install
sc start CloudPointService
If the operation succeeds, the Windows Task Manager displays the following
processes:
flexsnap-agent.exe
flexsnap-windows-svc.exe (x2)
Chapter 7
Protecting assets with
CloudPoint's agentless
feature
This chapter includes the following topics:
Before you configure the agentless feature on a host, have the following information
ready:
■ The host user name
■ The host password or SSH key
■ On the Azure RHEL machine enter the following command with sudo user:
/etc/sudoers file
cpuser ALL=(ALL) NOPASSWD: ALL
You need to provide this information so that CloudPoint can gain access to the
host.
To configure the agentless feature
1 On the CloudPoint dashboard, in the Environment card, locate the Hosts
area, and click Manage.
2 On the Asset Management page, select the host on which you want to use
the agentless feature.
3 On the Details page, click Connect
Protecting assets with CloudPoint's agentless feature 70
About the agentless feature
5 Enter the SSH user name, and either the SSH password or SSH key.
6 Click Save.
Section 2
Configuring users
■ Configuring email
■ Adding a user
■ Deleting a user
Configuring email
The following figure shows where you are in the CloudPoint user configuration
process.
The first part of configuring CloudPoint users is to configure an email address that
is the source of CloudPoint communications. For example, if the status of an asset
changes, and CloudPoint notifies users from this address. When you specify this
address, you can use an existing email address.
You configure the email address using one the following email services:
■ Amazon Web Services Simple Email Service (AWS SES)
Setting up email and adding users 73
Configuring email
To configure email
1 On the CloudPoint dashboard, click the Settings (gear) icon, and select Email
Settings from the drop-down list.
3 Complete the form using the email service-specific parameters you compiled.
If you use AWS SES or SendGrid, verify your email ID.
4 Click Finish.
When you add users to CloudPoint, you have the following options:
■ Import user data from a Lightweight Directory Access Protocol (LDAP) directory.
This approach enables you to quickly and accurately create a large number of
CloudPoint users.
Importing users from LDAP ■ The name and password of the LDAP administrator
account
■ The LDAP base domain
■ The LDAP URL
■ The network port used by the LDAP server
■ The search base that is used for LDAP searches
■ The LDAP email domain
Creating users locally For each user you want to add, obtain:
3 Complete the page with the information that you gathered in the table above.
4 Click Finish.
5 On the Changing LDAP Setting dialog box, click Proceed.
CloudPoint gathers a list of available users from the LDAP search base.
6 On the Add LDAP users page, you can select one or more users and click
Assign Selected or click Assign All.
The Assigned Users column is updated with your selections.
7 When you are done, click Save.
See “Adding a user” on page 77. to add users locally.
Adding a user
The following figure shows where you are in the CloudPoint user configuration
process.
Setting up email and adding users 78
Adding a user
Before you can add a user to CloudPoint, you must configure an email address.
This address sends out all CloudPoint related emails.
See “Configuring email” on page 72.
Setting up email and adding users 79
Adding a user
To add a user
1 On the dashboard, in the Administration card, locate Users, and click Manage.
The user receives an email that they have been added to CloudPoint. The
email includes a temporary password they can use to access the product.
The email is sent from the address you specified when you configured email
earlier.
Setting up email and adding users 80
Deleting a user
Deleting a user
To delete a user
1 On the dashboard, in the Administration widget, locate Users, and click
Manage.
2 On the User Details page, click Delete.
3 On the Please confirm ... dialog box, click Delete.
CloudPoint displays a message that the user has been removed.
4 On the LDAP Users page, verify that the user is no longer displayed.
Chapter 9
Assigning roles to users
for greater efficiency
This chapter includes the following topics:
■ Creating a role
■ Editing a role
■ Deleting a role
Tab Description
You can also use the Role Details page to edit or delete the role.
See “Editing a role” on page 86.
See “Deleting a role” on page 87.
Creating a role
Only the CloudPoint admin or a user with Role management permission can create
a role.
Assigning roles to users for greater efficiency 83
Creating a role
To create a role
1 On the dashboard, in the Administration card, locate Roles, and click Manage.
■ Permissions
Assigning roles to users for greater efficiency 84
Creating a role
■ Assets
The left side of this tab displays a list of all available CloudPoint assets.
The right side displays the assets that are assigned to the role. When you
first assign assets to a role, the right side of the tab is blank.
Note: As the CloudPoint admin, you see all assets, regardless of whether
they are appropriate for the permissions you set. The asset list is not
automatically filtered based on the permission you select. If you are a
non-admin user with Role management permission, you only see the
assets assigned to you.
In the available list, select assets you want to add to the role, and click
Assigned Selected. You can also use the buttons Assign Selected,
Assign All, Remove All, and Remove Selected to create your assigned
asset list.
Assigning roles to users for greater efficiency 85
Creating a role
5 Click Save.
CloudPoint displays a message that the role is added.
6 Note the new entry on the Role Management page.
Assigning roles to users for greater efficiency 86
Editing a role
Editing a role
To edit a role
1 On the dashboard, in the Administration card, locate Roles, and click Manage.
2 On the Roles page, select the check box for the role you want to view.
Assigning roles to users for greater efficiency 87
Deleting a role
3 Click Edit.
The Edit Role page displays with the Users tab shown by default.
Deleting a role
You can delete one or more CloudPoint roles in a single operation.
To delete a role
1 On the dashboard, in the Administration widget, locate Roles, and click
Manage.
2 On the Roles page, select the check boxes for the roles you want to delete.
The Role Details page is displayed. If you select one role to delete, it displays
the Users tab, Permissions tab, and Assets tab. If you select multiple roles
to delete, the page displays the number of roles you selected.
3 On the Role Details page, click Delete.
4 On the Please confirm ... dialog box, click Delete.
CloudPoint displays a message that the role has been deleted.
5 Note that the role is no longer on the Roles page.
Section 3
Protecting and managing
data
■ Chapter 14. Monitoring activities with notifications and the job log
■ Signing in to CloudPoint
Signing in to CloudPoint
After you configure CloudPoint, the sign in screen is automatically displayed. It is
also displayed any time you point your browser to the URL of the host running
CloudPoint.
User interface basics 90
Focusing on an asset type
To sign in to CloudPoint
1 On the sign in screen, enter your CloudPoint user name and password.
You can filter your results further by entering a string in the Filter field.
Note: If the string you filter on includes enter includes a hyphen, put the string in
double quotes. For example, to show only the assets that include the string
prod-pipeline, you would enter "prod-pipeline".
From here, you can select an application and perform a number of tasks.
The following table lists the ways you can navigate to the Asset Management page
and what is displayed.
Protection
Summary >
Manage
Protect Everything
Assets
User interface basics 93
Using the action icons
Hosts >
Manage
File Systems
> Manage
Disks >
Manage
Notifications
Settings
■ About policies
■ Creating a policy
■ Editing a policy
■ Deleting a policy
About policies
A policy lets you automate your asset protection. When you create a policy, you
define the following:
■ The type of snapshot to take, either a crash-consistent snapshot (the default)
or an application-consistent snapshot.
■ Whether or not to replicate the snapshot. For added protection, you can specify
that CloudPoint stores a copy of the snapshot at another physical location.
Note: You cannot replicate any encrypted asset, including encrypted Elastic
Block Store (EBS) snapshots and encrypted Amazon Machine Images (AMIs).
Protecting your assets with policies 95
About policies
Note: If you have an asset in multiple policies and the policy run times overlap, one
of the policies may fail. For example, suppose an asset is in both Policy 1 and Policy
2. If Policy 1 is running when Policy 2 starts, Policy 2 may fail. It takes an average
of 10 minutes to create an Oracle snapshot. Allow at least a 10 minute gap between
two policies that have the same asset.
Creating a policy
To create a policy
1 On the dashboard, in the Administration widget, locate Policies, and click
Manage.
Field Description
Field Description
■ Retention
Use the up and down arrows and the retention tabs to specify how many
snapshots of the asset you want to retain or for how long. The following
table shows some sample settings.
■ Scheduling
Use this part of the page to determine how often the policy runs.
Tab Description
Tab Description
4 Click Save.
CloudPoint displays a message that the new policy is created.
5 Note the new entry on the Policies page.
in addition to weekly snapshots, you can assign a second policy to your database
applications to snapshot them once a month.
When you complete the steps in this section, keep in mind the following:
■ The steps for assigning a policy are the same regardless of the type of asset
you assign it to.
■ Also use these steps when you want to change the policy that is associated with
an asset.
Note: If you have an asset in multiple policies and the policy run times overlap, one
of the policies may fail. For example, suppose an asset is in both Policy 1 and Policy
2. If Policy 1 is running when Policy 2 starts, Policy 2 may fail. It takes an average
of 10 minutes to create an Oracle snapshot. Allow at least a 10 minute gap between
two policies that have the same asset.
3 On the Policies for asset name screen assign one or more policies to the
asset. In the Available Policies column, select the policy you want to assign
and click Assign Selected.
You can also assign or remove multiple policies at the same time.
4 Click Save.
Protecting your assets with policies 102
Listing policies and displaying policy details
Editing a policy
To edit a policy
1 On the dashboard, in the Administration widget, locate Policies, and click
Manage.
2 On the Policies page, select the check box for the policy you want to modify.
The remaining steps this procedure are the same as creating a new policy.
See “Creating a policy” on page 96.
5 After you edit the policy, click Save.
CloudPoint displays a message that the policy is updated.
See “About policies” on page 94.
Protecting your assets with policies 106
Deleting a policy
Deleting a policy
To delete a policy
1 On the dashboard, in the Administration card, locate Policies, and click
Manage.
2 On the Policies page, select the check box for the policy you want to delete.
You can select multiple policies.
■ About replication
About replication
When you replicate a snapshot, you save a copy of it to another physical location.
For example, suppose that you administer an Amazon Web Services (AWS) cloud
and your assets are in the region us-east-1. Your asset snapshots are also be
stored in us-east-1. However, you can also replicate the snapshots to the region
us-west-1 for an added level of protection. In CloudPoint terminology, the original
location (us-east-1) is the replication source, and the location where snapshots
are replicated (us-west-1) is the replication destination.
As an administrator, you can configure up to three replication targets for each source
region. When you create a policy, you can specify whether replication is enabled.
You can also replicate a snapshot manually.
■ Encryption key (KMS key) used for encryption in both region must have same
name; that is alias (in terms of AWS)
■ If encryption key with same name is not present then replication fails with the
following error:
KMS key <encryption_key_arn> not present in target region:
<target_region>
4 Click Save.
CloudPoint displays a message that a new rule has been created.
5 Note that the Replication Settings screen displays the new rule.
Replicating snapshots for added protection 111
Editing a replication rule
3 Select the source location whose replication rules you want to edit.
4 Click Edit.
5 Use the drop-down lists to change the replication locations or the order of the
locations.
6 Click Save.
CloudPoint displays a message that a new rule has been updated.
Replicating snapshots for added protection 112
Deleting a replication rule
2 Select the replication rules you want to delete. You can select more than one
rule.
3 Click Delete.
4 On the Please confirm ... dialog box, click Delete.
CloudPoint displays a message that the rule has been deleted
Chapter 13
Managing your assets
This chapter includes the following topics:
■ Restoring a snapshot
■ Deleting a snapshot
Hewlett Packard Enterprise 3PAR array COW and clone snapshot types
Hitachi HDS array COW snapshots; Hitachi Thin Image (HTI) volumes
P-VOL or S-VOL
Regardless of the asset type you work with, the steps for creating a snapshot are
the same. Depending on the asset, some parameters you enter may be slightly
different. They are explained in the procedure.
To create a snapshot manually
1 Navigate to your list of assets.
On the CloudPoint dashboard, in the Environment card, select the asset type
you want to work with, and click Manage. This example creates an application
snapshot.
2 On the Asset Management page, select the application you want to snapshot.
You can select multiple applications.
Managing your assets 115
Creating a snapshot manually
Field Description
Field Description
5 Click Save.
CloudPoint displays a message that the snapshot is created.
By default, AWS allows up to 100 RDS manual snapshots per region. If you try to
take more than 100 snapshots, you may get an error. As a workaround, you can
either:
■ Contact AWS support and ask them to increase the number of snapshots
allowed. Once they do that, you will not get an error unless you reach the new
limit.
■ Or reduce the retention in your policies.
Managing your assets 117
Displaying asset snapshots
2 On the Asset Management page, select the application whose snapshots you
want to view. You can select multiple applications.
From this page, you can select a snapshot and perform the following actions:
■ Restore a snapshot
See “Restoring a snapshot” on page 120.
■ Replicate a snapshot
See “Replicating a snapshot manually” on page 118.
■ Classify a snapshot
■ Delete a snapshot
See “Deleting a snapshot” on page 128.
2 On the Asset Management page, select the application whose snapshot you
want to replicate. You can select multiple applications.
3 On the Details page click View Snapshots
Managing your assets 120
Restoring a snapshot
4 On the Snapshot Management page, select the snapshot you want to replicate.
You can only select one.
6 On the Replicate page, use the Target Destination drop-down list to select
an alternate physical location.
7 Click Replicate.
8 On the Please Confirm ... dialog box, click Replicate.
CloudPoint displays a message that replication has started.
Restoring a snapshot
The types of snapshots you can restore and where you can restore them varies
depending on the asset type. Before you complete this section, review the following
table.
Managing your assets 121
Restoring a snapshot
Hewlett Packard Enterprise 3PAR array Restore a COW volume snapshot to the same
volume with the Overwrite Existing option.
■ us-east-1 standard
■ eu-west-1
■ eu-central-1
■ us-west-2
■ us-west-1
■ sa-east-1
■ ap-northeast-1
■ ap-northeast-2
■ ap-southeast-1
■ ap-southeast-2
■ ap-south-1
■ us-gov-west-1
■ cn-north-1
To restore a snapshot
1 Navigate to your list of assets.
On the CloudPoint dashboard, in the Environment card, select the asset type
you want to work with, and click Manage. This example restores an application
snapshot.
2 On the Asset Management page, select the application whose snapshot you
want to restore. You can select multiple applications.
Managing your assets 123
Restoring a snapshot
4 On the Snapshot Management page, select the snapshot you want to restore.
6 Click Restore.
Managing your assets 125
Restoring a snapshot
Note: Beginning in Release 2.0.2, you can restore an Azure instance snapshot to
a private network. The instance does not require a public IP address.
5 On the Granule Management page, select one or more files to restore, and
Restore Selected Granules.
Note: If you restore the same granule multiple times, then the existing copy is
overwritten.
Deleting a snapshot
Regardless of the asset type you work with, the steps for deleting a snapshot are
the same.
Managing your assets 129
Deleting a snapshot
To delete a snapshot
1 Navigate to your list of assets.
On the CloudPoint dashboard, in the Environment card, locate the asset type
you want to work with and click its Manage link. This example deletes an
application snapshot.
2 On the Asset Management page, select the application whose snapshot you
want to restore. You can select multiple applications.
4 On the Snapshot Management page, select the snapshot (or snapshots) you
want to delete. You can select multiple snapshots.
3 Use the filter and sorting tools as needed to locate the job you are interested
in.
4 Click a job to display detailed information about it.
Monitoring activities with notifications and the job log 133
Using the job log
Indexing, which is also Technical Preview software, creates an index of the files in
a snapshot. Having an index of the files enables you to restore a single file from a
snapshot. Classification goes deeper into the data than indexing. During
classification, indexing is performed automatically before the classification process
identifies items that contain tags from the Veritas Information Classifier. Tags indicate
the type of data that is in a file, such as a credit card number, but not the actual
data. For any snapshot, you can choose to index without classifying or to index and
classify.
After a snapshot has been classified, you can reclassify it. Reclassifying is useful
if you have changed the settings in the Veritas Information Classifier since the last
classification of a snapshot. By reclassifying, CloudPoint can locate any new tags
that you added to the Veritas Information Classifier.
If you want to work with classification, but do not have an Enterprise license, please
upgrade your license.
See “Upgrading your CloudPoint license” on page 158.
3 (Optional) If you selected the Index Only option in step 2, click Classify if you
want to classify this snapshot.
4 (Optional) If you want to reclassify this snapshot, click Reclassify.
Reclassifying is useful if you have changed the settings in the Veritas
Information Classifier since the last classification of a snapshot.
See “Statuses for indexing and classification” on page 137.
Indexing and classifying your assets 137
Statuses for indexing and classification
Status Description
■ Backing up CloudPoint
■ Restoring CloudPoint
Backing up CloudPoint
To backup CloudPoint when it is deployed in a cloud
1 Log out of CloudPoint.
2 Stop CloudPoint services. Use the following format:
For example:
Use the following API to determine CloudPoint version installed and configured
on user setup
3 Make sure that all CloudPoint containers are stopped. This step is important
because all activity and connections to and from CloudPoint must be stopped
to get a consistent CloudPoint backup. Enter the following:
This command should not return any actively running CloudPoint containers.
4 (Optional) If there are still active containers, repeat step 3. If that does not
work, run the following command on each active container:
For example:
5 After all the containers are stopped, take a snapshot of the volume on which
you installed CloudPoint. Use the cloud provider's snapshot tools.
6 When the snapshot completes start CloudPoint services. Use the following
format:
For example:
For example:
3 Make sure that all CloudPoint containers are stopped. This step is important
because all activity and connections to and from CloudPoint must be stopped
to get a consistent CloudPoint backup. Enter the following
This command should not return any actively running CloudPoint containers.
Protection and disaster recovery 141
Restoring CloudPoint
4 (Optional) If there are still active containers, repeat step 3. If that does not
work, run the following command on each active container:
For example:
5 Backup the folder /cloudpoint. Use any backup method you prefer. For
example:
Restoring CloudPoint
To restore CloudPoint, you can do one of the following:
■ Recover CloudPoint using a snapshot you have in the cloud
■ Recover CloudPoint using a backup on-premises
To recover CloudPoint using a snapshot you have in the cloud
1 Using your cloud provider's dashboard or console, create a volume from the
existing snapshot.
2 Create a new virtual machine with specifics equal to or better than your previous
CloudPoint server.
3 Install docker on the new server.
See “Deploying CloudPoint” on page 24.
4 Attach the newly-created volume to this CloudPoint server instance.
5 Create the CloudPoint installation directory on this server. Use the following
syntax:
$ mkdir /full_path_to_cloudpoint_installation_directory
For example:
$ mkdir /cloudpoint
Protection and disaster recovery 142
Restoring CloudPoint
6 Mount the attached volume to the installation directory you just created. Use
the following syntax:
For example:
7 Verify that all CloudPoint related configuration data and files are in the directory.
Enter the following:
$ ls -l /cloudpoint
10 When the installation completes, you can resume working with CloudPoint with
your existing credentials.
Protection and disaster recovery 143
Restoring CloudPoint
Note: If you are using CloudPoint version 2.1.0.x then you must install the licenses
manually. When CloudPoint recovers, no licenses are installed. Hence, you must
install the licenses manually.
Section 4
Maintaining CloudPoint
■ CloudPoint logs
CloudPoint logs
CloudPoint maintains the following logs to monitor activity and troubleshoot issues.
The logs are stored on the path installation_path/cloudpoint/logs. CloudPoint
retains multiple versions of each log, with a number appended to the log name; for
example, flexsnap-agent.log.2.
Log Description
The log file for the agents that stores all the error
logs related to agent and the plugins that the agent
is managing. The offhost-agent only deals with
offhost plugins like AWS, Azure, GCP, or array
plugins. All the tasks like discovering the assets,
creating, restoring, and deleting snapshots which
are done by the agent and the plugin are stored in
this log file. The flexsnap-coordinator requests the
agent services based on the asset type to create,
restore, delete, or find asset in the cloud.
CloudPoint logs 146
CloudPoint logs
Log Description
flexsnap-api.log The log for the service that translates RESTful API
requests into JSON-formatted requests. These
requests are sent to the coordinator.
flexsnap-telemetry.log The log file for the telemetry service which contains
information about service life cycle including
successful telemetry operations as well as any
errors related to that service.
flexsnap-classifier.log The log file for storing the error logs related to the
classification and indexing activity performed on
the snapshot. As the flexsnap-classifier interfaces
with VIC and MongoDB you can also find logs
related to connection to these containers.
Note: This log file is available in CloudPoint
Release 2.0.1 and later.
flexsnap-agent-offhost.log The log file for the parent offhost agent that stores
the error logs related to the new plugins
configuration addition. This log file is generated by
parent agent. Parent agent is a stand alone agent
which validate to new plugin configuration which
is not owned any configuration. It does not contain
any specific plugin discovery log. This file contains
initial configuration validation log before spawning
child agent. Once child agent is spawned to handle
plugin configuration, the configuration log is
redirected to new log file with the name
flexsnap-agent-<agentid>.log
CloudPoint logs 147
CloudPoint logs
Log Description
flexsnap-agent-onhost.log The log file for the agents that stores all the error
logs related to agent and the plugins that the agent
is managing. The onhost-agent deals with plugins
that can run inside a host like the application
plugins like Oracle, Linux, Mongo, and so on.
email_service.log The log file for storing the logs related to the email
service. The log file stores the start up information
of the service, the RabbitMQ calls made to the
service, connection issues while setting up
RabbitMQ. and any errors during an internal call.
api-gateway.log The log file for storing the details of the proxy that
routes requests/responses between the
application's web console and back-end services.
This log file is configured by the API and not from
the flexsnap.conf file.
Chapter 18
Troubleshooting
CloudPoint
This chapter includes the following topics:
■ Restarting CloudPoint
Restarting CloudPoint
If you need restart CloudPoint after an error, it's important that you restart it correctly
so your environmental data is preserved.
Warning: Do not use commands such as docker restart or docker stop and
docker start. Use the docker run command described below,
Troubleshooting CloudPoint 149
Docker may fail to start due to a lack of space
To restart CloudPoint
◆ On the instance where CloudPoint is installed, enter the following command
format:
For example:
The following procedure shows the steps to take if the image fails to start.
1 Check the log file /mount-point-from-host/logs/init.log. Note that
MongoDB starts, then immediately stops. (See the information messages in
bold.)
2 Verify the amount of available space on the host boot disk. MongoDB needs
about 4 GB of space. In the example below, only 1.6 GB is available.
# sudo df -kh /
Filesystem Size Used Avail Use% Mounted on
/dev/xvda1 7.7G 6.2G 1.6G 80% /
Troubleshooting CloudPoint 150
Some CloudPoint features do not appear in the user interface
■ Per FETB
subscription
■ Per instance
subscription (a
bundle 10)
■ Upgrading CloudPoint
■ Later, on the CloudPoint 1.0.2 host, the administrator restores the virtual machine
snapshot. CloudPoint 1.0.2 does not have access to the virtual machine's
metadata. It restores the snapshot, but it does not know the virtual machine's
specific configuration. Instead, it substitutes default values for the storage size
configuration. The result is a restored virtual machine that does not match the
original.
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
1 Make sure that your virtual machine or physical host meets the requirements
of the new version.
See “Meeting system requirements” on page 17.
2 From your browser, navigate to the CloudPoint trial page.
3 On the trial page, register and click Submit.
4 On the CloudPoint download page, click Download Now.
The CloudPoint image name has the following format:
docker load -i Veritas_CloudPoint_new_version.IE.img.gz
10 The installation of the new CloudPoint container detects old CloudPoint running
containers and asks for confirmation before removing it.
Press Y to remove the old CloudPoint container.
11 Refresh your web browser and log in to the CloudPoint user interface.
12 Verify the CloudPoint version. Click on Settings and select About. The Current
Version field should indicate the new version you just installed.
13 Verify that your CloudPoint data is still present.
Chapter 20
Working with your
CloudPoint license
This chapter includes the following topics:
■ Under the License summary you can view the type of license in effect and
the amount of license used.
■ Under License summary, you can, view the license metering type; Instance
or FETB, current license in effect, current consumption, number of remaining
ronths in case of subscription based licensing, and the last date.
When you upgrade from free license to paid license, your free license
consumption is transferred to the paid license.
8 The License page lists the new license. The following example shows that the
Enterprise license is active and in effect. The license is measure in terms of
front-end terra byte (FETB) data. You can also purchase an Enterprise license
based on the number of instances to protect.
CloudPoint Description
configuration parameter
Table 21-2
Category Supported
Library storops
Note: You cannot snapshot LUNs which are under a consistency group. The reason
for this limitation is that to restore a single LUN snapshot would restore the entire
consistency group.
Storage array support 164
Hewlett-Packard Enterprise (HPE) 3PAR array
Library hpe3parclient
CloudPoint Description
configuration parameter
Category Supported
Category Supported
CloudPoint Description
configuration
parameter
Table 21-7
Category Supported
Version V300R006C10
Patch SPC100
Series Model
Series Model
■ Delete a snapshot.
■ Restore the original lun from a snapshot. The snapshot overwrites the original
lun.
Chapter 22
Working with CloudPoint
using APIs
This chapter includes the following topics:
https://docker_host_name/CloudPoint/docs