Veritas CloudPoint Administrator's Guide
- Getting started with CloudPoint
- Section I. Installing and configuring CloudPoint
- Preparing for installation
- About the deployment approach
- Deciding where to run CloudPoint
- 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
- 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
- Dell EMC Unity array plug-in configuration notes
- Pure Storage FlashArray plug-in configuration notes
- HPE RMC plug-in configuration notes
- NetApp plug-in configuration notes
- Configuring an off-host plug-in
- About CloudPoint plug-ins and assets discovery
- Configuring the on-host agents and plug-ins
- About agents
- Oracle plug-in configuration notes
- MongoDB plug-in configuration notes
- Microsoft SQL plug-in configuration notes
- About the installation and configuration process
- Preparing to install the Linux-based on-host agent
- Preparing to install the Windows-based on-host agent
- Downloading and installing the on-host agent
- Configuring the Linux-based on-host agent
- Configuring the Windows-based on-host agent
- Configuring the on-host plug-in
- Configuring VSS to store shadow copies on the originating drive
- 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
- About snapshot replication
- About cross-account snapshot replication in the AWS cloud
- Requirements for replicating snapshots
- Cross-account snapshot replication support matrix
- Cross-account snapshot replication limitations
- Configuring replication rules
- Editing a replication rule
- Deleting a replication rule
- Managing your assets
- Creating a snapshot manually
- Displaying asset snapshots
- Replicating a snapshot manually
- About snapshot restore
- About single file restore (granular restore)
- Single file restore requirements and limitations
- Restoring a snapshot
- Additional steps required after a SQL Server snapshot restore
- Additional steps required after an Oracle snapshot restore
- Additional steps required after a MongoDB snapshot restore
- Additional steps required after restoring an AWS RDS database instance
- Restoring individual files within a snapshot
- Deleting a snapshot
- Monitoring activities with notifications and the job log
- Protection and disaster recovery
- Section IV. Maintaining CloudPoint
- CloudPoint logging
- Troubleshooting CloudPoint
- Restarting CloudPoint
- Docker may fail to start due to a lack of space
- CloudPoint installation fails if rootfs is not mounted in a shared mode
- Some CloudPoint features do not appear in the user interface
- Off-host plug-in deletion does not automatically remove file system and application assets
- Disk-level snapshot restore fails if the original disk is detached from the instance
- Snapshot restore for encrypted AWS assets may fail
- Error while adding users to CloudPoint
- CloudPoint fails to revert restored snapshots if indexing, classification, or restore operations fail
- SQL snapshot or restore and SFR operations fail if the Windows instance loses connectivity with the CloudPoint host
- Troubleshooting CloudPoint logging
- Working with your CloudPoint license
- Upgrading CloudPoint
- Uninstalling CloudPoint
- Section V. Reference
Configuring AWS KMS in CloudPoint
This is applicable only if CloudPoint instance is deployed in the AWS cloud.
Perform the following steps if you wish to configure CloudPoint to use AWS Key Management Service (KMS) for encrypting and decrypting your CloudPoint configuration information. CloudPoint provides REST APIs that you can use to configure AWS KMS in your CloudPoint environment.
These steps are required only if you have manually deployed CloudPoint using the Docker image on an AWS EC2 instance in the AWS cloud. These steps are not required if you have deployed CloudPoint using the CloudFormation Template (CFT).
Note:
Veritas recommends that you use the CloudPoint CloudFormation Template to deploy CloudPoint in the AWS cloud. KMS is automatically configured as part of the template-based deployment workflow.
Ensure that you have successfully installed and configured CloudPoint on the EC2 instance in the AWS cloud.
Read about how CP integrates with AWS KMS and understand the limitations.
Ensure that you have created an AWS IAM role and attached it to the CloudPoint EC2 instance.
The IAM role must have the following permissions at a minimum:
kms:DescribeKey kms:GenerateDataKey kms:Decrypt
Refer to the following AWS KMS documentation for detailed instructions:
Ensure that you have created a customer managed Customer Master Key (CMK). The Key ID of the CMK is required for configuring AWS KMS in CloudPoint.
Refer to the following AWS KMS documentation for detailed instructions:
https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html
To configure AWS KMS in CloudPoint
- Generate an authentication token for the CloudPoint administrator user account by using the following CloudPoint Identity Management API:
POST /v2/idm/login
On any system that can connect to the CloudPoint instance, type the following cURL command:
# curl -k https://<cloudpointhostFQDN>/cloudpoint/api/v2/idm/login -X 'POST' -H "Content-Type: application/json" -d '{"email":"<username>", "password":"<password>"}'Replace the following parameters as per your environment:
Parameter
Description
<cloudpointhostFQDN>
Represents the Fully Qualified Domain Name (FQDN) that was specified while performing the initial CloudPoint configuration on the host.
<username>
Represents the user name that was specified as the CloudPoint administrator user during initial configuration.
<password>
Represents the password of the CloudPoint administrator user account.
- Observe the API output on the command prompt. You will see an output that resembles the following:
{ "accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJWZXJpdGFzIiwidXN", "applicationId": "", "applicationPath": "", "errorCode": "" }The alphanumeric entry that appears as the
accessTokenrepresents the token that is used to authorize all CloudPoint API requests on the host. Copy the token, it is required in the subsequent steps.Note:
The alphanumeric authentication token displayed here is for representation purpose only. Use the actual token that is generated when you run this command in your environment.
- Create a new AWS KMS configuration using the CloudPoint Key Management Service API POST /v3/kms.
Enter the following cURL command on the same command prompt:
# curl -k "https://<cloudpointhostFQDN>/cloudpoint/api/v3/kms" -X 'POST' -H "Content-Type: application/json" -H "Authorization: Bearer <authtoken>" -d "{"platform":"aws", "masterKeyId":"<cmk_keyid>", "credentials":{"type":"iamrole", "regionname":"<cmk_regionname>"}}"Replace the following parameters as per your environment:
Parameter
Description
<cloudpointhostFQDN>
Represents the Fully Qualified Domain Name (FQDN) that was specified while performing the initial CloudPoint configuration on the host.
<authtoken>
Represents the alpha numeric authentication token that you generated in the earlier step.
<cmk_keyid>
Represents the AWS customer managed Customer Master Keys (CMK) key ID that you created for CloudPoint.
<cmk_regionname>
Represents the CMK region where the CloudPoint instance is deployed.
- Observe the API output on the command prompt and wait for the task to complete.
- You can quickly verify if the AWS KMS is configured successfully by using the CloudPoint API GET /v3/kms.
Run the following cURL command:
# curl -k -X GET "https://<cloudpointhostFQDN>/cloudpoint/api/v3/kms" -H "accept: application/json" -H "Authorization: Bearer <authtoken>"
Replace the following parameters as per your environment:
Parameter
Description
<cloudpointhostFQDN>
Represents the Fully Qualified Domain Name (FQDN) that was specified while performing the initial CloudPoint configuration on the host.
<authtoken>
Represents the alpha numeric authentication token that you generated in step 2 earlier.
An HTTP 200 status indicates that the configuration was performed successfully.
- You must now configure the CloudPoint plug-ins or the agentless feature.