Preparing CNC NF Data Collector Modules

4 Preparing CNC NF Data Collector Modules

This section describes the prerequisites and download procedure for CNC NF Data Collector.

4.1 Prerequisites

This section includes information about the required prerequisites before downloading CNC NF Data Collector:

Kubernetes 1.13 or later, Helm 2, and Helm 3 must be installed on the host machine.
This tool must be run on a system or machine (Bastion Host) from where the NF is deployed using Helm or Kubectl.
Logs must be stored in Elastic Search, Metrics, and Alarms in Prometheus Server. Jaeger must be configured to use Elastic Search as jaeger's storage database. All versions of the third-party tools are supported.

4.2 Downloading and Preparing CNC NF Data Collector

Perform this procedure to download Cloud Native Core (CNC) Network Function (NF) Data Collector Images and Helm files from Oracle Software Delivery Cloud (OSDC) and prepare CNC NF Data Collector to start.

Download the following files from OSDC:
- CNC NF Data Collector package file: <name>-pkg-<marketing-release-number>.tgz
  Example:
```
ocnfDataCollector-pkg-1.2.5.0.0.tgz
```
- ReadMe file: <name>-pkg-<marketing-release-number>-README.txt
  Example:
```
ocnfDataCollector-pkg-1.2.5.0.0-README.txt
```

Run the following command to untar the CNC NF Data Collector package:

tar -xvf <<name>-pkg-<marketing-release-number>>.tgz

The system creates the <<nfname>-pkg-<marketing-release-number>> directory, which contains the following items:

ocnfDataCollector-pkg-1.2.5.0.0.tgz
           |_ _ _ _ _ _ ocnfDeploymentDataCollector-1.2.5.tgz
           |_ _ _ _ _ _ ocnf-data-exporter-1.2.5.tgz (Helm Charts)
           |_ _ _ _ _ _ ocnf-data-loader-1.2.5.tgz (Helm Charts)
           |_ _ _ _ _ _ ocnfDataCollector-image-1.2.5.tar (Docker Images)
           |_ _ _ _ _ _ exporter-custom-values.yaml
           |_ _ _ _ _ _ loader-custom-values.yaml

Verify the checksum of packages from the <name>-pkg-<marketing-release-number>-README.txt file.

cksum ocnfDataCollector-pkg-1.2.5.0.0-README.txt

2932245484 2256 ocnfDataCollector-pkg-1.2.5.0.0-README.txt

Run the following command to load the images to the local registry:
```
docker load --input ocnfDataCollector-image-1.2.5.tar
```
Run the docker images command to check whether all the images are loaded.

Run the following commands to push the docker images to docker registry:

docker tag <image-name>:<image-tag> <docker-repo>/<image-name>:<image-tag>

docker push <docker-repo>/<image-name>:<image-tag>

docker tag cnc-nfdata-collector:1.2.5 kingbastion-2:5000/cnc-nfdata-collector:1.2.5

Run the following commands to untar the helm files:
- tar -xvzf <file name>: To untar the ocnf-data-exporter-1.2.5.tgz file if you want to collect the data on the required system.
  Where, <file name> indicates the file name, for example, tar -xvzf ocnf-data-exporter-1.2.5.tgz.
  
  The system creates a directory with the name ocnf-data-exporter. This directory contains the following files: Chart.yaml, nf-tools, templates, and values.yaml.
- tar -xvzf <file name>: To untar the ocnf-data-loader-1.2.5.tgz file if you want to import the data into the required system.
  Where, <file name> indicates the file name, for example, tar -xvzf ocnf-data-loader-1.2.5.tgz.
  
  The system creates a directory with the name ocnf-data-loader. This directory contains the following files: Chart.yaml, templates, and values.yaml.