Installing NetBackup Snapshot Manager in the Docker/Podman environment
Note:
When you deploy NetBackup Snapshot Manager, 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.
NetBackup Snapshot Manager installation prerequisites on Podman:
Run the following commands to install the required packages (
lvm2,udevandplugins) on the hosts:#yum install -y lvm2-<version>
#yum install -y lvm2-libs-<version>
#yum install -y python3-pyudev-<version>
#yum install -y systemd-udev-<version>
#yum install -y podman-plugins
Installing NetBackup Snapshot Manager
Perform the following appropriate steps depending on the Docker or Podman environment.
To install NetBackup Snapshot Manager
- Download the NetBackup Snapshot Manager image to the system on which you want to deploy NetBackup Snapshot Manager. Navigate to the Veritas Technical Support website.
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 NetBackup Snapshot Manager image name resembles the following format for Docker and Podman environment:
NetBackup_SnapshotManager_<version>.tar.gzNote:
The actual file name may vary depending on the release version.
- Un-tar the image file and list the contents:
# ls NetBackup_SnapshotManager_10.1.x.x.xxxx.tar.gz netbackup-flexsnap-10.1.x.x.xxxx.tar.gz flexsnap_preinstall.sh
- Run the following command to prepare the NetBackup Snapshot Manager host for installation:
# sudo ./flexsnap_preinstall.sh
(For Podman on RHEL 8.x) The output resembles as follows:
NetBackup Snapshot Manager for installation: Validate SELINUX ... done Check for Podman installation ... done Validate Podman version support ... done Checking for required packages ... done Validate Podman services health ... done Removing deprecated services ... done Loading Snapshot Manager service images ... done
- Perform the following appropriate step depending on the Docker or Podman environment.
(For Docker environment)
Type the following command to run the NetBackup Snapshot Manager container:
# sudo docker run -it --rm -u 0 -v /cloudpoint:/cloudpoint-v /var/run/docker.sock:/var/run/ docker.sock veritas/flexsnap-deploy:<version>install
(For Podman environment)
Install NetBackup NetBackup Snapshot Manager with the following command:
# podman run -it --rm -u 0 -v /cloudpoint:/cloudpoint -v /run/podman/podman.sock:/run/podman/ podman.sock veritas/flexsnap-deploy:<version>install
Note:
The command mentioned in the above step is a single command. Ensure that you enter the command without any line breaks.
If the NetBackup Snapshot Manager host is behind a proxy server, use the following command instead:
(For Docker environment)
# sudo docker run -it --rm -u 0 -v /<full_path_to_volume_name>:/<full_path_to_volume_name> -e VX_HTTP_PROXY=<http_proxy_value> -e VX_HTTPS_PROXY=<http_proxy_value> -e VX_NO_PROXY=<no_proxy_value> -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-deploy:<version> install
(For Podman environment)
# podman run -it --rm -u 0 -v /<full_path_to_volume_name>:/<full_path_to_volume_name> -e VX_HTTP_PROXY=<http_proxy_value> -e VX_HTTPS_PROXY=<http_proxy_value> -e VX_NO_PROXY=<no_proxy_value> -v /run/podman/podman.sock:/run/podman/podman.sock veritas/flexsnap-deploy:<version> install
Replace the following parameters as per your environment:
Parameter
Description
<full_path_to_volume_name>
Represents the path to the NetBackup Snapshot Manager data volume, which typically is
/cloudpoint.<version>
Represents the NetBackup Snapshot Manager product version that you noted in the earlier step.
Following parameters are required only if the instance uses a proxy server
<http_proxy_value>
Represents the value to be used as the HTTP proxy for all connections.
For example,
"http://proxy.mycompany.com:8080/".<https_proxy_value>
Represents the value to be used as the HTTPS proxy for all connections.
For example,
"http://proxy.mycompany.com:8080/".<no_proxy_value>
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 NetBackup Snapshot Manager is being deployed in the cloud, ensure that you set the following respective values in this parameter:
For an AWS instance: 169.254.169.254
For a GCP virtual machine: 169.254.169.254,metadata,metadata.google.internal
For an Azure virtual machine: 169.254.169.254
NetBackup Snapshot Manager uses these addresses to gather instance metadata from the instance metadata service.
Example
(For Docker environment) If the NetBackup Snapshot Manager version is
10.1.xxxx, the command syntax is as follows:# sudo docker run -it --rm -u 0 -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-deploy:10.1.1.xxxx 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 -u 0 -v /cloudpoint:/cloudpoint -e VX_HTTP_PROXY="http://proxy.mycompany.com:8080/" -e VX_HTTPS_PROXY="http://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-deploy:10.1.1.xxxx install
The installer displays messages similar to the following:
Installing the services Configuration started at time: Thu Jun 9 07:49:00 UTC 2022 docker server version: 20.10.12 This is a fresh install of NetBackup Snapshot Manager 10.1.x.x.xxxx Snapshot Manager currently is not configured. Starting initial services before configuration. Creating network: flexsnap-network ...done Starting container: flexsnap-fluentd ...done Starting container: flexsnap-ipv6config ...done Creating container: flexsnap-mongodb ...done Creating container: flexsnap-rabbitmq ...done Creating container: flexsnap-certauth ...done Creating container: flexsnap-api-gateway ...done Creating container: flexsnap-coordinator ...done Creating container: flexsnap-listener ...done Creating container: flexsnap-agent ...done Creating container: flexsnap-onhostagent ...done Creating container: flexsnap-scheduler ...done Creating container: flexsnap-policy ...done Creating container: flexsnap-notification ...done Creating container: flexsnap-idm ...done Starting container: flexsnap-config ...done Creating self signed keys and certs for nginx ...done Please provide Snapshot Manager admin credentials for configuration: Admin username: admin Admin password: Confirm Admin password: Host names for TLS certificate (space or comma separated):10.244.79.36 Port (default:443): Starting container: flexsnap-nginx ...done Configuring admin credentials ...done Waiting for Snapshot Manager configuration to complete (22/22)...done Configuration complete at time Thu Jun 9 07:54:00 UTC 2022! Please register Snapshot Manager with NetBackup primary server
(For Podman environment)
The output resembles the following:
Installing the services Configuration started at time: Thu Jun 9 08:42:41 UTC 2022 podman server version: 4.0.2 This is a fresh install of NetBackup Snapshot Manager 10.1.1.0.xxxxx Snapshot Manager currently is not configured. Starting initial services before configuration. Creating network: flexsnap-network ...done Starting container: flexsnap-fluentd ...done Creating container: flexsnap-mongodb ...done Creating container: flexsnap-rabbitmq ...done Creating container: flexsnap-certauth ...done Creating container: flexsnap-api-gateway ...done Creating container: flexsnap-coordinator ...done Creating container: flexsnap-listener ...done Creating container: flexsnap-agent ...done Creating container: flexsnap-onhostagent ...done Creating container: flexsnap-scheduler ...done Creating container: flexsnap-policy ...done Creating container: flexsnap-notification ...done Creating container: flexsnap-idm ...done Starting container: flexsnap-config ...done Creating self signed keys and certs for nginx ...done Please provide Snapshot Manager admin credentials for configuration: Admin username: admin Admin password: Confirm Admin password: Host names for TLS certificate (space or comma separated):10.239.154.240 Port (default:443): Starting container: flexsnap-nginx ...done Configuring admin credentials ...done Waiting for Snapshot Manager configuration to complete (22/22)...done Configuration complete at time Thu Jun 9 08:52:04 UTC 2022! Please register Snapshot Manager with NetBackup primary server
In this step, NetBackup Snapshot Manager does the following:
Creates and runs the containers for each of the NetBackup Snapshot Manager services.
Creates self-signed keys and certificates for nginx.
Note:
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/Podman host file system.
- Provide the following details when prompted on the command prompt:
Parameter
Description
Admin username
Specify a user name for the NetBackup Snapshot Manager administrator user account.
Admin password
Specify a password for the administrator user.
Confirm Admin password
Confirm the administrator user password.
Host name for TLS certificate
Specify the IP address or the Fully Qualified Domain Name (FQDN) of the NetBackup Snapshot Manager 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 NetBackup Snapshot Manager acce ss using those names.
Use commas to specify multiple entries. The names you specify here must point to the same NetBackup Snapshot Manager host.
The specified names or IP address are added to the list of host names to use for configuring NetBackup Snapshot Manager. The installer uses these names to generate a server certificate for the NetBackup Snapshot Manager host.
Port
Specify the port through which the NetBackup Snapshot Manager can communicate. Default is port 443.
The installer then displays messages similar to the following:
Configuring admin credentials ...done Waiting for Snapshot Manager configuration to complete (22/22) ...done Configuration complete at time Thu Jun 9 06:15:43 UTC 2022!
- This concludes the NetBackup Snapshot Manager deployment process. The next step is to register the NetBackup Snapshot Manager with the Veritas NetBackup primary server.
If NetBackup Snapshot Manager is deployed in the cloud, refer to the NetBackup Web UI Cloud Administrator's Guide for instructions. If NetBackup Snapshot Manager is deployed on-premise, refer to the NetBackup Snapshot Manager for Data Center Administrator's Guide for instructions.
Note:
If you ever need to restart NetBackup Snapshot Manager, use the docker run command so that your environmental data is preserved.