Veritas NetBackup™ CloudPoint Install and Upgrade Guide

Last Published:
Product(s): NetBackup (9.0)
Platform: Linux
  1. Section I. CloudPoint installation and configuration
    1. Preparing for CloudPoint installation
      1.  
        About the deployment approach
      2.  
        Deciding where to run CloudPoint
      3.  
        About deploying CloudPoint in the cloud
      4.  
        Meeting system requirements
      5. CloudPoint host sizing recommendations
        1.  
          CloudPoint sizing recommendations for cloud platforms
      6.  
        Creating an instance or preparing the physical host to install CloudPoint
      7.  
        Installing Docker
      8.  
        Creating and mounting a volume to store CloudPoint data
      9.  
        Verifying that specific ports are open on the instance or physical host
    2. Deploying CloudPoint using the Docker image
      1.  
        Installing CloudPoint
      2.  
        Verifying that CloudPoint installed successfully
    3. CloudPoint cloud plug-ins
      1.  
        How to configure the CloudPoint cloud plug-ins?
      2. 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
      3. 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
      4. Microsoft Azure plug-in configuration notes
        1.  
          Configuring permissions on Microsoft Azure
        2.  
          About Azure snapshots
    4. CloudPoint storage array plug-ins
      1.  
        How to configure the CloudPoint storage array plug-ins?
      2. NetApp plug-in configuration notes
        1.  
          NetApp plug-in configuration parameters
        2.  
          Configuring a dedicated LIF for NetBackup access
        3.  
          Supported CloudPoint operations on NetApp storage
      3. Nutanix Files plug-in configuration notes
        1.  
          Nutanix Files plug-in configuration prerequisites
        2.  
          Nutanix Files plug-in considerations and limitations
        3.  
          Supported CloudPoint operations on Nutanix Files File Server
        4. Troubleshooting NetBackup issues for Nutanix Files
          1.  
            Backup jobs for Nutanix Files fail due to snapshot import and export operations failures
          2.  
            Plug-in configuration may fail if the Nutanix Files version is unsupported
      4. Dell EMC Unity array plug-in configuration parameters
        1.  
          Supported Dell EMC Unity arrays
        2.  
          Supported CloudPoint operations on Dell EMC Unity arrays
      5. Pure Storage FlashArray plug-in configuration notes
        1.  
          Supported Pure Storage FlashArray models
        2.  
          Supported CloudPoint operations on Pure Storage FlashArray models
      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. Hitachi plug-in configuration notes
        1.  
          Hitachi plug-in configuration parameters
        2.  
          Supported Hitachi storage arrays
        3.  
          Supported CloudPoint operations on Hitachi arrays
      8. InfiniBox plug-in configuration notes
        1.  
          InifiniBox plug-in configuration parameters
        2.  
          Supported CloudPoint operations on InfiniBox arrays
      9. Dell EMC PowerScale (Isilon) plug-in configuration notes
        1.  
          Dell EMC PowerScale (Isilon) plug-in configuration prerequisites
        2.  
          Supported CloudPoint operations on Dell EMC PowerScale (Isilon) plug-in
      10. Qumulo plug-in configuration notes
        1.  
          Qumulo plug-in configuration prerequisites
        2.  
          Qumulo plug-in considerations and limitations
        3.  
          Supported CloudPoint operations on Qumulo plug-in
    5. CloudPoint application agents and plug-ins
      1.  
        Microsoft SQL plug-in configuration notes
      2. Oracle plug-in configuration notes
        1.  
          Optimizing your Oracle database data and metadata files
      3.  
        MongoDB plug-in configuration notes
      4.  
        About the installation and configuration process
      5.  
        Preparing to install the Linux-based agent
      6.  
        Preparing to install the Windows-based agent
      7.  
        Downloading and installing the CloudPoint agent
      8.  
        Registering the Linux-based agent
      9.  
        Registering the Windows-based agent
      10.  
        Configuring the CloudPoint application plug-in
      11.  
        Configuring VSS to store shadow copies on the originating drive
      12.  
        Creating a NetBackup protection plan for cloud assets
      13.  
        Subscribing cloud assets to a NetBackup protection plan
      14. About snapshot restore
        1.  
          Process for restoring SQL AG databases
      15.  
        Restore requirements and limitations for Microsoft SQL Server
      16.  
        Restore requirements and limitations for Oracle
      17.  
        Restore requirements and limitations for MongoDB
      18.  
        Steps required before restoring SQL AG databases
      19.  
        Recovering a SQL database to the same location
      20.  
        Recovering a SQL database to an alternate location
      21. Additional steps required after a SQL Server snapshot restore
        1.  
          Steps required after a SQL Server disk-level snapshot restore to new location
      22.  
        Additional steps required after restoring SQL AG databases
      23.  
        SQL snapshot or restore and granular restore operations fail if the Windows instance loses connectivity with the CloudPoint host
      24.  
        Disk-level snapshot restore fails if the original disk is detached from the instance
      25.  
        Additional steps required after a MongoDB snapshot restore
      26.  
        Additional steps required after an Oracle snapshot restore
      27.  
        Additional steps required after restoring an AWS RDS database instance
    6. Protecting assets with CloudPoint's agentless feature
      1.  
        About the agentless feature
      2.  
        Prerequisites for the agentless configuration
      3.  
        Granting password-less sudo access to host user account
      4.  
        Configuring the agentless feature
    7. Volume Encryption in NetBackup
      1.  
        About volume encryption support in NetBackup
      2.  
        Volume encryption for Azure
      3.  
        Volume encryption for GCP
      4.  
        Volume encryption for AWS
  2. Section II. CloudPoint maintenance
    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.  
        CloudPoint logs
    2. Troubleshooting CloudPoint
      1.  
        Restarting CloudPoint
      2.  
        Troubleshooting CloudPoint logging
      3.  
        CloudPoint agent fails to connect to the CloudPoint server if the agent host is restarted abruptly
      4.  
        CloudPoint agent registration on Windows hosts may time out or fail
      5.  
        Disaster recovery when DR package is lost or passphrase is lost
      6.  
        Agentless log file name changed
    3. Upgrading CloudPoint
      1.  
        About CloudPoint upgrades
      2.  
        Supported upgrade path
      3.  
        Upgrade scenarios
      4.  
        Preparing to upgrade CloudPoint
      5.  
        Upgrading CloudPoint
    4. Uninstalling CloudPoint
      1.  
        Preparing to uninstall CloudPoint
      2.  
        Backing up CloudPoint
      3.  
        Unconfiguring CloudPoint plug-ins
      4.  
        Unconfiguring CloudPoint agents
      5.  
        Removing the CloudPoint agents
      6.  
        Removing CloudPoint from a standalone Docker host environment
      7.  
        Restoring CloudPoint

Installing CloudPoint

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 install CloudPoint

  1. Download the CloudPoint image to the system on which you want to deploy CloudPoint.

    The CloudPoint image name resembles the following format:

    Veritas_CloudPoint_8.x.x.x.img.gz

    Note:

    The actual file name may vary depending on the release version.

  2. Change directories to where you have downloaded the CloudPoint image.
  3. Type the following command to load the image into Docker:

    # sudo docker load -i CloudPoint_image_name

    For example:

    # sudo docker load -i Veritas_CloudPoint_8.3.0.8549.img.gz

    Messages similar to the following appear on the command line:

    538bd068cab5: Loading layer [================>]  38.26MB/38.26MB
    ed4b778f8d1d: Loading layer [================>]  1.166GB/1.166GB
    c8b269899686: Loading layer [================>]  49.15kB/49.15kB
    Loaded image: veritas/flexsnap-cloudpoint:8.3.0.8549

    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.

  4. 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 8.3.0.8549, 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:8.3.0.8549 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:8.3.0.8549 install

    Note:

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

    The installer displays messages similar to the following:

    Installing the services
    Configuration started at time: Fri Mar 13 06:11:42 UTC 2020
    WARNING: No swap limit support
    Docker server version: 18.09.1
    This is a fresh install of CloudPoint 8.3.0.8549
    Checking if a 1.0 release container exists ...
    CloudPoint currently is not configured. 
    Starting initial services before configuration.
    Creating network: flexsnap-network ...done
    Starting docker container: flexsnap-fluentd ...done
    Creating docker container: flexsnap-mongodb ...done
    Creating docker container: flexsnap-rabbitmq ...done
    Creating docker container: flexsnap-certauth ...done
    Creating docker container: flexsnap-api-gateway ...done
    Creating docker container: flexsnap-coordinator ...done
    Creating docker container: flexsnap-agent ...done
    Creating docker container: flexsnap-onhostagent ...done
    Creating docker container: flexsnap-scheduler ...done
    Creating docker container: flexsnap-policy ...done
    Creating docker container: flexsnap-notification ...done
    Creating docker container: flexsnap-idm ...done
    Starting docker container: flexsnap-config ...done
    Creating self signed keys and certs for nginx ...done
    Starting docker container: flexsnap-nginx ...done

    In this step, CloudPoint does the following:

    • Creates and runs the containers for each of the CloudPoint services.

    • Creates self-signed keys and certificates for nginx.

    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.

  5. Provide the following details when prompted on the command prompt:

    Parameter

    Description

    Admin username

    Specify a user name for the CloudPoint administrator user account.

    Admin password

    Specify a password for the admin user.

    Confirm Admin password

    Confirm the admin user password.

    Host name for TLS certificate

    Specify the IP address or the Fully Qualified Domain Name (FQDN) of the CloudPoint host.

    If you connect to the host using different names (for example, myserver, myserver.mydomain, or myserver.mydomain.mycompany.com), then ensure that you add all the names here if you want to enable CloudPoint access using those names.

    Use commas to specify multiple entries. The names you specify here must point to the same CloudPoint host.

    The specified names or IP address are added to the list of host names to use for configuring CloudPoint. The installer uses these names to generate a server certificate for the CloudPoint host.

    The installer then displays messages similar to the following:

    Configuring admin credentials ...done
    Waiting for CloudPoint configuration to complete (21/21) ...done
    Configuration complete at time Fri Mar 13 06:15:43 UTC 2020!
  6. This concludes the CloudPoint deployment process. The next step is to register the CloudPoint server with the Veritas NetBackup master server.

    If CloudPoint is deployed in the cloud, refer to the NetBackup Web UI Cloud Administrator's Guide for instructions. If CloudPoint is deployed on-premise, refer to the NetBackup Snapshot Client Administrator's Guide for instructions.

Note:

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

See Restarting CloudPoint.