Veritas CloudPoint Administrator's Guide

Last Published:
Product(s): CloudPoint (2.2.2)
Platform: Linux
  1. Getting started with CloudPoint
    1.  
      About CloudPoint
    2.  
      What kinds of assets can you protect?
    3.  
      Understanding your CloudPoint license
  2. Section I. Installing and configuring CloudPoint
    1. Preparing for installation
      1.  
        About the deployment approach
      2.  
        Deciding where to run CloudPoint
      3.  
        Meeting system requirements
      4.  
        CloudPoint host sizing recommendations
      5.  
        Creating an instance or preparing the physical host to install CloudPoint
      6.  
        Installing Docker
      7.  
        Creating and mounting a volume to store CloudPoint data
      8.  
        Verifying that specific ports are open on the instance or physical host
    2. Deploying CloudPoint
      1.  
        About deploying CloudPoint in a non-interactive mode
      2.  
        Installing CloudPoint
      3.  
        Configuring CloudPoint from your browser and signing in
      4.  
        Verifying that CloudPoint installed successfully
      5.  
        Configuring AWS KMS in CloudPoint
    3. Deploying CloudPoint in the AWS cloud
      1.  
        About CloudPoint deployment in the AWS cloud
      2.  
        About CloudPoint integration with AWS KMS
      3. About CloudPoint support for AWS IAM roles
        1.  
          About source account and cross-account configurations
        2.  
          How to configure CloudPoint to use IAM roles
        3.  
          CloudPoint IAM role configuration limitations
      4. About the CloudPoint AWS CloudFormation template
        1.  
          Resources created by the CloudPoint template
        2.  
          CloudPoint EC2 instance configuration details
        3.  
          Instance failures and Auto Scaling Group behavior
      5.  
        Prerequisites for using the CloudPoint template
      6.  
        Launching a CloudPoint CloudFormation stack
    4. Using plug-ins to discover assets
      1.  
        About plug-ins
      2.  
        Determining the types of plug-ins and agents to install
    5. Configuring off-host plug-ins
      1. AWS plug-in configuration notes
        1.  
          Prerequisites for configuring the AWS plug-in
        2.  
          Configuring AWS permissions for CloudPoint
        3.  
          AWS permissions required by CloudPoint
        4.  
          Before you create a cross account configuration
      2. Google Cloud Platform plug-in configuration notes
        1.  
          Google Cloud Platform permissions required by CloudPoint
        2.  
          Configuring a GCP service account for CloudPoint
        3.  
          Preparing the GCP service account for plug-in configuration
      3. Microsoft Azure plug-in configuration notes
        1.  
          Configuring permissions on Microsoft Azure
      4.  
        Dell EMC Unity array plug-in configuration notes
      5.  
        Pure Storage FlashArray plug-in configuration notes
      6. HPE RMC plug-in configuration notes
        1.  
          RMC plug-in configuration parameters
        2.  
          Supported HPE storage systems
        3.  
          Supported CloudPoint operations on HPE storage arrays
      7. NetApp plug-in configuration notes
        1.  
          NetApp plug-in configuration parameters
        2.  
          Supported NetApp arrays
        3.  
          Supported CloudPoint operations on NetApp storage
      8. Hitachi plug-in configuration notes
        1.  
          Hitachi plug-in configuration parameters
        2.  
          Supported Hitachi storage arrays
        3.  
          Supported CloudPoint operations on Hitachi arrays
      9. InfiniBox plug-in configuration notes
        1.  
          InifiniBox plug-in configuration parameters
        2.  
          Supported CloudPoint operations on InfiniBox arrays
      10.  
        Configuring an off-host plug-in
      11. About CloudPoint plug-ins and assets discovery
        1.  
          Plug-in discovery interval requirements and limitations
        2.  
          Viewing the assets discovery interval setting
    6. Configuring the on-host agents and plug-ins
      1.  
        About agents
      2. Oracle plug-in configuration notes
        1.  
          Optimizing your Oracle database data and metadata files
      3.  
        MongoDB plug-in configuration notes
      4.  
        Microsoft SQL plug-in configuration notes
      5.  
        About the installation and configuration process
      6.  
        Preparing to install the Linux-based on-host agent
      7.  
        Preparing to install the Windows-based on-host agent
      8.  
        Downloading and installing the on-host agent
      9.  
        Configuring the Linux-based on-host agent
      10.  
        Configuring the Windows-based on-host agent
      11.  
        Configuring the on-host plug-in
      12.  
        Configuring VSS to store shadow copies on the originating drive
    7. Protecting assets with CloudPoint's agentless feature
      1.  
        About the agentless feature
      2. Prerequisites for the agentless configuration
        1.  
          Granting password-less sudo access to host user account
      3.  
        Configuring the agentless feature
  3. Section II. Configuring users
    1. Setting up email and adding users
      1.  
        Configuring the CloudPoint sender email address
      2.  
        About adding users to CloudPoint
      3.  
        Adding AD users to CloudPoint using LDAP
      4.  
        Adding users to CloudPoint manually
      5.  
        Deleting a user from CloudPoint
    2. Assigning roles to users for greater efficiency
      1.  
        About role-based access control
      2.  
        Displaying role information
      3.  
        Creating a role
      4.  
        Editing a role
      5.  
        Deleting a role
  4. Section III. Protecting and managing data
    1. User interface basics
      1.  
        Signing in to CloudPoint
      2.  
        Focusing on an asset type
      3.  
        Navigating to your assets
      4.  
        Using the action icons
    2. Indexing and classifying your assets
      1.  
        About indexing and classifying snapshots
      2.  
        Configuring classification settings using VIC
      3.  
        Indexing and classifying snapshots
      4.  
        Indexing and classification statuses
    3. Protecting your assets with policies
      1.  
        About policies
      2.  
        How a CloudPoint protection policy works
      3.  
        Creating a policy
      4.  
        Assigning a policy to an asset
      5.  
        Listing policies and displaying policy details
      6.  
        Editing a policy
      7.  
        Deleting a policy
    4. Tag-based asset protection
      1.  
        About tag-based asset protection
      2.  
        How to use tag-based asset protection feature
      3.  
        Tag-based asset protection support
      4.  
        Tag-based asset protection considerations and limitations
    5. Replicating snapshots for added protection
      1.  
        About snapshot replication
      2.  
        About cross-account snapshot replication in the AWS cloud
      3.  
        Requirements for replicating snapshots
      4.  
        Cross-account snapshot replication support matrix
      5.  
        Cross-account snapshot replication limitations
      6.  
        Configuring replication rules
      7.  
        Editing a replication rule
      8.  
        Deleting a replication rule
    6. Managing your assets
      1.  
        Creating a snapshot manually
      2.  
        Displaying asset snapshots
      3.  
        Replicating a snapshot manually
      4. About snapshot restore
        1.  
          Restore requirements and limitations for Microsoft SQL Server
        2.  
          Restore requirements and limitations for Oracle
        3.  
          Restore requirements and limitations for MongoDB
      5.  
        About single file restore (granular restore)
      6. Single file restore requirements and limitations
        1.  
          Single file restore support on Linux
        2.  
          Single file restore limitations on Linux
        3.  
          Single file restore support on Windows
        4.  
          Single file restore limitations on Windows
      7.  
        Restoring a snapshot
      8.  
        Additional steps required after restoring disk-level snapshots
      9. Additional steps required after a SQL Server snapshot restore
        1.  
          Steps required after a SQL Server host-level restore
        2.  
          Steps required after a SQL Server disk-level snapshot restore to new location
      10.  
        Additional steps required after an Oracle snapshot restore
      11.  
        Additional steps required after a MongoDB snapshot restore
      12.  
        Additional steps required after restoring an AWS RDS database instance
      13.  
        Restoring individual files within a snapshot
      14.  
        Deleting a snapshot
    7. Monitoring activities with notifications and the job log
      1.  
        About CloudPoint notifications
      2.  
        Viewing notifications in the CloudPoint UI
      3.  
        CloudPoint notification methods
      4.  
        CloudPoint notification limitations
      5.  
        Configuring email-based CloudPoint notifications
      6.  
        Configuring AWS SNS-based CloudPoint notifications
      7.  
        Using the Job Log
    8. Protection and disaster recovery
      1.  
        About protection and disaster recovery
      2.  
        Backing up CloudPoint
      3.  
        Restoring CloudPoint
  5. Section IV. Maintaining CloudPoint
    1. CloudPoint logging
      1.  
        About CloudPoint logging mechanism
      2. How fluentd-based CloudPoint logging works
        1.  
          About the CloudPoint fluentd configuration file
        2.  
          Modifying the fluentd configuration file
        3.  
          Fluentd-based logging requirements and considerations
      3.  
        Viewing CloudPoint logs
    2. Troubleshooting CloudPoint
      1.  
        Restarting CloudPoint
      2.  
        Docker may fail to start due to a lack of space
      3.  
        CloudPoint installation fails if rootfs is not mounted in a shared mode
      4.  
        Some CloudPoint features do not appear in the user interface
      5.  
        Off-host plug-in deletion does not automatically remove file system and application assets
      6.  
        Disk-level snapshot restore fails if the original disk is detached from the instance
      7.  
        Snapshot restore for encrypted AWS assets may fail
      8.  
        Error while adding users to CloudPoint
      9.  
        CloudPoint fails to revert restored snapshots if indexing, classification, or restore operations fail
      10.  
        SQL snapshot or restore and SFR operations fail if the Windows instance loses connectivity with the CloudPoint host
      11.  
        Troubleshooting CloudPoint logging
      12.  
        Swagger UI-based authorization for CloudPoint REST API calls may fail
      13.  
        Policy retention count is not honored for file system and application assets if there is an issue with the CloudPoint plug-in
    3. Working with your CloudPoint license
      1.  
        Displaying CloudPoint license and protection information
      2.  
        Upgrading your CloudPoint license
    4. Managing CloudPoint agents and plug-ins
      1.  
        Unconfiguring CloudPoint plug-ins
      2.  
        Unconfiguring the CloudPoint agent
      3.  
        Uninstalling CloudPoint on-host agents
    5. Upgrading CloudPoint
      1. About CloudPoint upgrades
        1.  
          Supported upgrade path
      2. Preparing to upgrade CloudPoint
        1.  
          Removing CloudPoint plug-in configuration
      3.  
        Upgrading CloudPoint
      4.  
        Upgrading a CloudPoint CloudFormation stack
    6. Uninstalling CloudPoint
      1.  
        Preparing to uninstall CloudPoint
      2.  
        Removing the CloudPoint on-host agents
      3.  
        Removing CloudPoint from a standalone Docker host environment
  6. Section V. Reference
    1. Storage array support
      1. Dell EMC Unity arrays
        1.  
          Dell EMC Unity array plug-in configuration parameters
        2.  
          Supported Dell EMC Unity arrays
        3.  
          Supported CloudPoint operations on Dell EMC Unity arrays
      2. Pure Storage FlashArray
        1.  
          Pure Storage FlashArray plug-in configuration parameters
        2.  
          Supported Pure Storage FlashArray models
        3.  
          Supported CloudPoint operations on Pure Storage FlashArray models
    2. Working with CloudPoint using APIs
      1.  
        Accessing the Swagger-based API documentation

Installing CloudPoint

The following figure shows where you are at in the CloudPoint installation and configuration process.

Figure: You are here in the installation and configuration process

You are here in the installation and configuration process

Before you complete the steps in this section, make sure that you complete the following:

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.

    You can use the free edition or purchase a licensed version. Refer to the following for more information:

    https://www.veritas.com/product/backup-and-recovery/cloudpoint/buy

    The CloudPoint image name has the following format:

    Veritas_CloudPoint_2.x.x_IE.img.gz

  2. (Optional) If necessary, copy the downloaded image to the system on which you want to deploy CloudPoint.
  3. Change directories to where you have downloaded the CloudPoint image.
  4. Type the following command to load the image into Docker:

    # sudo docker load -i Veritas_CloudPoint_2.x.x_IE.img.gz

    For example:

    # sudo docker load -i Veritas_CloudPoint_2.0.2_IE.img.gz

    Messages similar to the following appear on the command line:

    788ce2310e2f: Loading layer [============>] 126.8 MB/126.8 MB
    aa4e47c45116: Loading layer [============>] 15.87 kB/15.87 kB
    b3968bc26fbd: Loading layer [============>] 14.85 kB/14.85 kB
    c9748fbf541d: Loading layer [============>] 5.632 kB/5.632 kB
    2f5b0990636a: Loading layer [============>] 3.072 kB/3.072 kB
    d1348a46025a: Loading layer [============>] 214.2 MB/214.2 MB
    de54ad3327fe: Loading layer [============>] 12.06 MB/12.06 MB
    a8f411dfb821: Loading layer [============>] 1.35 GB/1.35 GB
    dc3db1bf7ffd: Loading layer [============>] 25.6 kB/25.6 kB
    e2344be00294: Loading layer [============>] 25.6 kB/25.6 kB
    Loaded image: veritas/flexsnap-cloudpoint:2.0.2.5300

    Make a note of the loaded image name and version that appears on the last line of the output. The version represents the CloudPoint product version that is being installed. You will specify these details in the next step.

  5. Type the following command to run the CloudPoint container:
    # sudo docker run -it --rm 
    -v /<full_path_to_volume_name>:/<full_path_to_volume_name> 
    -v /var/run/docker.sock:/var/run/docker.sock 
    veritas/flexsnap-cloudpoint:<version> install

    If the CloudPoint host is behind a proxy server, use the following command instead:

    # sudo docker run -it --rm 
    -v /<full_path_to_volume_name>:/<full_path_to_volume_name> 
    -e VX_HTTP_PROXY=<http_proxy_value>
    -e VX_HTTPS_PROXY=<https_proxy_value>
    -e VX_NO_PROXY=<no_proxy_value>
    -v /var/run/docker.sock:/var/run/docker.sock 
    veritas/flexsnap-cloudpoint:<version> install

    Replace the following parameters as per your environment:

    Parameter

    Description

    <full_path_to_volume_name>

    Represents the path to the CloudPoint data volume, which typically is /cloudpoint.

    <version>

    Represents the CloudPoint product version that you noted in the earlier step.

    <http_proxy_value>

    (required only if the instance uses a proxy server)

    Represents the value to be used as the HTTP proxy for all connections.

    For example, "http://proxy.mycompany.com:8080/".

    <https_proxy_value>

    (required only if the instance uses a proxy server)

    Represents the value to be used as the HTTPS proxy for all connections.

    For example, "https://proxy.mycompany.com:8080/".

    <no_proxy_value>

    (required only if the instance uses a proxy server)

    Represents the addresses that are allowed to bypass the proxy server. You can specify host names, IP addresses, and domain names in this parameter.

    Use commas to separate multiple entries. For example, "localhost,mycompany.com,192.168.0.10:80".

    Note:

    If CloudPoint is being deployed in the cloud, ensure that you set the following values in this parameter:

    • For an AWS instance, add the following:

      169.254.169.254

    • For a GCP virtual machine, add the following:

      169.254.169.254,metadata,metadata.google.internal

    • For an Azure virtual machine, add the following:

      169.254.169.254

    CloudPoint uses these addresses to gather instance metadata from the instance metadata service.

    For example, if the CloudPoint version is 2.0.2.5300, the command syntax is as follows:

    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:2.0.2.5300 install

    If using a proxy server, then using the examples provided in the table earlier, the command syntax is as follows:

    # sudo docker run -it --rm -v /cloudpoint:/cloudpoint -e VX_HTTP_PROXY="http://proxy.mycompany.com:8080/" -e VX_HTTPS_PROXY="https://proxy.mycompany.com:8080/" -e VX_NO_PROXY="localhost,mycompany.com,192.168.0.10:80" -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:2.0.2.5300 install

    Note:

    This is a single command. Ensure that you enter the command without any line breaks.

    In this step, CloudPoint does the following:

    • Creates containers for each of the CloudPoint services.

    • Runs the flexsnap-api container.

    • Creates self-signed keys and certificates for nginx.

    • Runs the flexsnap-cloudpointconsole container.

    When these operations are completed, CloudPoint displays the following in the command prompt:

    Please go to the UI and configure CloudPoint now.
    Waiting for CloudPoint configuration to complete ............

    If you have difficulty with this step, note the following:

    • If you do not specify the volume as -v full_path_to_volume_name:/full_path_to_volume_name, the container writes to the Docker host file system.

    • If Docker fails to start, it may be because there is not enough space available for MongoDB.

      See Docker may fail to start due to a lack of space.

  6. This concludes the CloudPoint deployment process. 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.

Note:

If you ever need to restart CloudPoint, use the docker run command so that your environmental data is preserved.

See Restarting CloudPoint.