Search <book_title>...

NetBackup IT Analytics Data Collector Installation Guide for Fabric Manager

Last Published: 2023-03-01

Product(s): NetBackup IT Analytics (11.0)

Install Data Collector in containerized environment

This procedure provides the steps to install Data Collector using a container image, which is a lightweight, standalone executable, on Linux hosts. This method enables efficient Data Collector installation using a single container image and reduces the human errors caused during manual or ISO-based installations. Since this installation using a container image requires minimal user input, this installation is also termed as silent installation.

Prerequisites and dependencies

System requirements and installation dependencies for the system on which Data Collector will be installed are listed below:

Docker or Podman must be pre-installed on the system.
Assume root role on the host system.
Create a directory structure in the host system where data from the container will be persisted. Ensure that the file system supporting the /data directory has enough free space as recommended in the NetBackup IT Analytics Certified Configurations Guide for Data Collector. The /data directory in the host system will be mounted inside the container as /opt/aptare.
```
mkdir -p /data/install/conf
```

Create a configuration file named conf-file.

The format of configuration conf-file must be as follows:

COLLECTOR_NAME=Name of the Data Collector as defined in the 
portal. 
COLLECTOR_PASSWORD=Passcode assigned to the Data Collector 
during its creation. 
DR_URL=Data receiver URL 
example:-<http://aptareagent.domainName> 
COLLECTOR_KEY_PATH=/data/aptare/conf/<keyname.key>  
HTTP_PROXY_CONF=N [Y-yes/N-no whether we are using proxy of not] 
HTTP_PROXY_ADDRESS=Provide HTTP proxy address, if proxy 
configuration is Yes.
HTTP_PROXY_PORT=Provide HTTP proxy port, if proxy 
configuration is Yes.
HTTPS_PROXY_ADDRESS=Provide HTTPS proxy address, if 
proxy configuration is Yes.
HTTPS_PROXY_PORT=Provide HTTPS proxy port, if proxy 
configuration is Yes. 
PROXY_USERNAME=Provide Proxy userName  
PROXY_PASSWORD=Provide Proxy password. 
PROXY_EXCLUDE=Provide exclude

Example: A sample conf-file content looks like:

COLLECTOR_NAME=testdc
COLLECTOR_PASSWORD=testdc@123
DR_URL=http://itanalyticsagent.domain
COLLECTOR_KEY_PATH=/data/aptare/conf/testdc.key
HTTP_PROXY_CONF=N
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=

Save the Data Collector key file and configuration conf-file on the Data Collector host at /data/install/conf. Both the files must be at the same location on the host. If the location of the files is changed, you must update the Docker run command accordingly with the new location.
Obtain the URL of the Docker image registry in your environment.

Install the Data Collector using the container image

Once you have the prerequisites in place, you must push the Docker image to your registry and initiate the installation.

To install through a container:

Add execute permission to setup_vtas_registry.sh script.
```
#chmod 744 setup_vtas_registry.sh
```
Push the Docker image present in the itanalytics_images.tar to the registry in your environment:
```
# setup_vtas_registry.sh -c <container registry URL> 
-t <itanalytics_images.tar file path>
```
Where:
- <container registry URL> is the URL of the Docker image registry in your environment.
- <itanalytics_images.tar file path> is the path to itanalytics_images.tar file.
You can use docker images or podman images command depending on the platform you are on to verify the Docker image availability within your registry.
In systems that use Podman, you may have to update the container registry configuration file /etc/containers/registries.conf to trust the <container registry URL>. For this, update the unqualified-search-registries setting in /etc/containers/registries.conf and restart the Podman service.
In systems that use Docker, create the file /etc/docker/daemon.json and add the below content to it and restart the Docker service to make the change effective.
```
{
    "insecure-registries" : [ "<container registry URL>:<port>" ]
}
```

Run the installation command for the container image.

Note:

Use Podman instead of command docker if you are on the system that supports Podman.

# docker pull <Container registry URL>/
itanalytics_datacollector_linux_<version>
# docker run -d -v /sys/fs/cgroup/:/sys/fs/cgroup:ro 
-v <path-to-location-of-config-and-key>:/data/aptare/conf 
-v <path-to -data-location>:/opt/aptare 
--add-host aptareportal.<DOMAIN>:<portal-IP> 
--add-host aptareagent.<DOMAIN>:<Portal-IP> 
--cap-add SYS_ADMIN 
--name=<container-name> 
<Container registry URL>/itanalytics_datacollector_linux_<version>

Replace everything inside <> with values as indicated in the sample below.

Example:

# docker pull localhost:5000/itanalytics_datacollector_linux_11000
# docker run -d -v /sys/fs/cgroup/:/sys/fs/cgroup:ro 
-v /data/install/conf:/data/aptare/conf 
-v /data:/opt/aptare 
--add-host aptareportal.domain_name:10.1.5.6 
--add-host aptareagent.domain_name:10.1.5.6 
--cap-add SYS_ADMIN 
--name=dc-container1 
localhost:5000/itanalytics_datacollector_linux_11000

After a successful installation, verify whether the Data Collector status appears Online on the NetBackup IT Analytics Portal. Note that the Data Collector is running inside a Docker Container and remains online as long as he container status is running.

Connect to container instance

Run this command to connect to the container instance and also to facilitate debugging when required.

# docker exec -it <image id> bash