2 Prerequisites

Before you begin with the procedure for installing OCNWDAF, ensure that the following requirements are met:

Caution:

User, computer and applications, and character encoding settings may cause an issue when copy-pasting commands or any content from PDF. PDF reader version also affects the copy-pasting functionality. It is recommended to verify the pasted content especially when hyphens or any special characters are part of copied content.

2.1 Software Requirements

This section describes the software requirements for installing OCNWDAF:

Oracle Communications Cloud Native Environment Specification

Oracle Communications Network Data Analytics Function (OCNWDAF) 23.2.0 can be installed on Oracle Cloud Infrastructure (OCI), Oracle Communications Cloud Native Core, Cloud Native Environment (CNE) 1.9.x,1.10.x, and 22.1.x. releases.

Verify the CNE version with the following command:

echo $OCCNE_VERSION

Note:

From CNE 1.8.x and later, the container platform is Podman instead of docker. For more information about Podman installation, see Oracle Communications Cloud Native Core, Cloud Native Environment (CNE) Installation, Upgrade, and Fault Recovery Guide.

Mandatory Software

The following software items must be installed before starting the OCNWDAF installation:

Table 2-1 Mandatory Software

Software Version
Kubernetes 1.20.7, 1.21.7, 1.22.5
HELM 3.1.2, 3.5.0, 3.6.3, 3.8.0
Podman 2.2.1, 3.2.3, 3.3.1
cnDBTier 22.4.1
CNC Console 23.1.0

To verify the current Helm and Kubernetes version installed on CNE, use the following commands:

  • To check Kubernetes version, run the following command:
    kubectl version
  • To check the Helm version, run the following command:
    helm3 version

Additional Software

Depending on your requirement, you may have to install additional software while deploying OCNWDAF. The list of additional software items, along with the supported versions and usage, is given in the following table:

Table 2-2 Additional Software

Software App Version Required For
elasticsearch 7.9.3 Logging
elastic-client 0.3.6 Metric Server
elastic-curator 5.5.4 Logging
elastic-exporter 1.1.0 Logging
elastic-master 7.9.3 Logging
logs 3.1.0 Logging
kibana 7.9.3 Logging
grafana 7.5.11 Metrics
prometheus 2.32.1 Metrics
prometheus-kube-state-metrics 1.9.7 Metrics
prometheus-node-exporter 1.0.1 Metrics
metalLb 0.12.1 External IP
metrics-server 0.3.6 Metrics
tracer 1.21.0 Tracing

To verify the installed software items, run the following command:

helm3 ls -A

If you need any services related to the above software items, and if the respective software is unavailable in CNE, then install that software before proceeding further.

2.2 Environment Setup Requirements

This section provides information about environment setup requirements for installing OCNWDAF.

Network Access

The Kubernetes cluster hosts must have network access to the following repositories:

  • Local docker image repository: It contains the OCNWDAF docker images. To check if the Kubernetes cluster hosts can access the local docker image repository, pull any image with an image-tag, using the following command:
    docker pull <docker-repo>/<image-name>:<image-tag>

    where:

    docker-repo is the IP address or host name of the docker image repository.

    image-name is the docker image name.

    image-tag is the tag assigned to the docker image used for the OCNWDAF pod.

  • Local helm repository : It contains the OCNWDAF Helm charts. To check if the Kubernetes cluster hosts can access the local Helm repository, run the following command:
    helm repo update

Client Machine Requirements

This section describes the requirements for client machine, that is, the machine used by the user to run deployment commands.

The client machine must meet the following requirements:

  • Network access to the helm repository and docker image repository.
  • Helm repository configured on the client.
  • Network access to the Kubernetes cluster.
  • Required environment settings to run the kubectl and docker commands. The environment must have privileges to create a namespace in the Kubernetes cluster.
  • Helm client installed so that the helm install command deploys the software in the Kubernetes cluster.

cnDBTier Requirements

OCNWDAF supports cnDBTier in a virtual CNE (vCNE) environment. cnDBTier must be up and active in case of containerized CNE. For more information about installation procedure, see the Oracle Communications Cloud Native Core cnDBTier Installation, Upgrade, and Fault Recovery Guide.

Note:

If the environment has cnDBTier 23.2.0 installation, follow the instruction below:

  • If cnDBTier 23.2.0 release is installed, set the ndb_allow_copying_alter_table parameter to 'ON' in the cnDBTier custom values dbtier_23.2.0_custom_values_23.2.0.yaml file and perform cnDBTier upgrade before install, upgrade, or any fault recovery procedure is performed for OCNWDAF. Set the parameter to its default value, 'OFF' once the activity is completed and perform the cnDBTier upgrade to apply the parameter changes.
  • To perform cnDBTier upgrade, see Oracle Communications Cloud Native Core, cnDBTier Installation, Upgrade, and Fault Recovery Guide.

2.3 Resource Requirements

This section lists the resource requirements to install and run OCNWDAF.

OCNWDAF Services

The following table lists the resource requirement for OCNWDAF services:

Table 2-3 Core Microservices Resource Requirements

Microservice Name POD Replica CPU/POD Memory/POD (in GB) Ephemeral Storage
  Min Max Min Max Min Max Min (Mi) Max (GB)
ocn-nwdaf-analytics-info-service 1 2 1 2 1 2 78.1 1
nwdaf-ingress-gateway 1 2 1 2 1 2 78.1 1
nwdaf-cap4c-spring-cloud-config-server 1 1 2 2 1 1 78.1 1
nwdaf-egress-gateway 1 2 1 2 1 2 78.1 1
ocn-nwdaf-data-collection-service 2 4 2 4 2 4 78.1 1
ocn-nwdaf-subscription-service 1 2 1 2 1 2 78.1 1
ocn-nwdaf-mtlf-service 1 2 1 2 1 2 78.1 1
ocn-nwdaf-configuration-service 1 2 1 2 1 2 78.1 1
ocn-nwdaf-cap4c-model-controller 1 2 4 8 1 2 78.1 1
ocn-nwdaf-cap4c-model-executor 2 4 2 4 1 2 78.1 1
ocn-nwdaf-cap4c-stream-analytics 2 4 4 8 1 2 78.1 1
ocn-nwdaf-cap4c-portal 1 2 2 4 1 2 78.1 1
ocn-nwdaf-cap4c-portal-service 1 2 2 4 1 2 78.1 1
ocn-nwdaf-cap4c-scheduler-service 1 2 1 2 1 2 78.1 1
ocn-nwdaf-cap4c-kafka-ingestor 2 4 1 2 1 2 78.1 1
ocn-nwdaf-cap4c-reporting-service 1 2 1 2 1 2 78.1 1
ocn-nwdaf-geo-redundacy-agent 1 1 1 1 1 2 78.1 1
Total 21 40 28 52 17 35    

Resource Requirements for Helm Test

This section provides the details on resource requirement to install and run OCNWDAF Helm Test.

Helm Test Job

This job runs on demand when Helm test command is executed. It runs the Helm test and stops after completion. These are short lived jobs, which gets terminated after the work is completed. Hence, they are not part of active deployment resource, but considered only during Helm test procedures.

Table 2-4 Helm Test Requirement

Container Type CPU Request and Limit Per Container Memory Request and Limit Per Container
Helm Test Request- 1 CPU, Limit- 2 CPU Request- 1 GB, Limit- 2 GB

Below is an example of the configurations that should be included under the global section of the oc-nwdaf-custom-values.yaml file. 

global:
  testJobResources:
    limits:
      cpu: 2
      memory: 2Gi
      ephemeral-storage: 2Gi
    requests:
      cpu: 1
      memory: 1Gi
      ephemeral-storage: 200Mi