Installing CloudPoint in the Docker environment
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
- Download the CloudPoint image to the system on which you want to deploy CloudPoint. Go to the Veritas support site:
https://www.veritas.com/content/support/en_US/downloads
Note:
You must log on to the support site to download
From the Products drop-down, select NetBackup and select the required version from the Version drop-down. Click Explore. Click Base and upgrade installers.
The CloudPoint image name resembles the following format:
V
RTScloudpoint-docker-x.x.x.x.x.img.gzNote:
The actual file name may vary depending on the release version.
- Change directories to where you have downloaded the CloudPoint image.
- 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.
- 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.
- 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.
Port
Specify the port through which the CloudPoint server can communicate. Default is port 443.
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!
- This concludes the CloudPoint deployment process. The next step is to register the CloudPoint server with the Veritas NetBackup primary 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.