3 Customizing OCNADD

This chapter describes how to customize the Oracle Communications Network Analytics Data Director (OCNADD) deployment, supported deployment models, and provides a list of configuration parameters in the Helm file that are used for customization. The OCNADD deployment is customized by overriding the default values of various configurable parameters.

3.1 Customize Configuration Parameters

Perform the following procedure to customize the OCNADD custom values files as per requirements for all the OCNADD groups.

  • Ensure that you have the Data Director charts tgz file, which is available in the extracted release package. For information about how to download the release package from MOS, see Downloading OCNADD Package.
  • Extract the OCNADD package if not already extracted, and unzip the custom_templates.zip. Change the directory to custom_templates to access the following custom values file
    • ocnadd-common-custom-values-25.2.200.yaml
    • ocnadd-management-custom-values-25.2.200.yaml
    • ocnadd-relayagent-custom-values-25.2.200.yaml
    • ocnadd-mediation-custom-values-25.2.200.yaml

3.1.1 Modify the Commons custom values file

Edit the ocnadd-common-custom-values-25.2.200.yaml and update the following parameters:

  1. Update the repository path in global.env.repo.REPO_HOST_PORT: 
    <customer
            repository path>
  2. Update the site name in cluster.siteName (for example Bangalore, Chicago, etc.).
  3. Update the database IP and database name:
    • db_ip: 10.20.30.40 (Update with DB instance IP or with FQDN, for example mysql-connectivity-service.<cnDBTier namespace>.)
    • db_port: 3306 (If using a different port for DB, change it. By default, the DB port is 3306.)
    • configuration_db: configuration_schema (Update the DB name as per the section Update Database Name. No change is needed if default DB names are used.)
    • alarm_db: alarm_schema (Update the DB name as per the section Update Database Name. No change is needed if default DB names are used.)
    • health_db: healthdb_schema (Update the DB name as per the section Update Database Name. No change is needed if default DB names are used.)
  4. Change the Prometheus Monitoring details based on the desired MPS profile. The default threshold MPS is 1500000:
    cluster.mps: 1500000
  5. <Optional>Update JAAS Password for Mediation Kafka

    The following JAAS password property is used for authentication between Aggregation Services and the Mediation Kafka Cluster. Update the following property to change the JAAS password:

    cluster.aggJaasSecret: <jaas password>

  6. Creating Registry Credentials:

    If the user image repository is protected and has an authentication mechanism, follow the steps below:

    1. Use the kubectl command to create a secret named regcred with the credentials of the image repository.
    2. Update the imagePullSecret.enable field to true as follows:
      imagePullSecret:
  enable: true    ## --> update this to 'true'
  7. Storage class:
    1. If deploying on Tanzu, update the storageClass with the respective storage class name of the TANZU platform, for example zfs-storage-policy.
    2. If deploying on OCI, update the storageClass with the respective storage class name of the OCI platform. It should be oci-bv.

      Note:

      This step is specific to the TANZU and OCI platform. Skip this step if you are installing OCNADD on CNE. For CNE, the default storageClass is standard.
  8. Loadbalancer on OCI:
    Update the following parameters in the file:
    global.env.oci: false   =====> set it to true
global.env.subnetOcid:<subnet_ocid>   # Add the OCID of the subnet that user want to use for creating load balancer

3.1.2 Modifying Management custom values file

Edit the ocnadd-management-custom-values-25.2.200.yaml and update the following parameters:

  1. Update the CLUSTER-INFO parameters:
    cluster.domainName: <cluster domain name where management group is planned for deployment>
cluster.clusterName: <cluster name where management group is planned for deployment>
  2. <Optional> Updating the OCNADD Backup Cronjob:

    Modify the below backup parameters as needed. For more information on backup and restore, see the "Fault Recovery" section. 

    BACKUP_STORAGE : Represents Backup storage PVC size
BACKUP_CRONEXPRESSION : Represents the time of execution
PURGE_DAYS : Represents the backup retention period in days

ocnaddbackuprestore: 
   ocnaddbackuprestore: 
        name: ocnaddbackuprestore 
        env: 
             BACKUP_STORAGE: 20Gi 
             BACKUP_CRONEXPRESSION: "0 8 * * *" 
             PURGE_DAYS: 7
  3. <Optional> When the management group is deployed in a separate cluster from the relay agent or mediation group, external communication between gateways must be enabled. For detailed instructions on enabling external communication, refer to "Enable External Communication Between OCNADD Gateways" in the Oracle Communications Network Analytics Data Director User Guide.

3.1.3 Modifying Relay Agent custom values file

Update the management namespace in commons custom values (ocnadd-common-custom-values-25.2.200.yaml) file if it is not updated. 

global.management_info.management_namespace: <management group namespace>

If the relay agent group is deployed in a separate cluster from the management group, then external communication between the gateways must be enabled. For detailed instructions on enabling external communication, refer to Enable External Communication Between OCNADD Gateways in the Oracle Communications Network Analytics Data Director User Guide.

Edit the relay agent YAML file (for example, ocnadd-relayagent-custom-values-25.2.200-ra-group.yaml) created after making a copy of the ocnadd-relayagent-custom-values-25.2.200.yaml and update the following parameters:

  1. Update the CLUSTER-INFO parameters:
    cluster.domainName: <cluster domain name where relay agent group is planned for deployment>
cluster.clusterName: <cluster name where relay agent group is planned for deployment>
  2. Update the logical name of the worker group to which this relay agent group is associated:
    cluster.workergroupName: <Logical name of the worker group> (for example worker1 or myddworker)
  3. Enable the specific Aggregation service. The default values are mentioned below. The user can enable the specific Aggregation service by setting true against the specific Aggregation service:
    global:
    ocnaddrelayagent:
        ocnaddscpaggregation:
            enabled: true
        ocnaddseppaggregation:
            enabled: false
        ocnaddnrfaggregation:
            enabled: false
        ocnaddbsfaggregation:
            enabled: false
        ocnaddpcfaggregation:
            enabled: false
  4. Kafka Preinstall Configuration Changes:
    1. <Optional> To change the profiles of the brokers, edit the respective values (CPU, memory, storage, external-access, security, jaas-password, replicas, internal replication factor, and so on) in the Kafka section of the Relay Agent custom values file.
    2. <Optional> When the security protocol is SASL and the customer is required to add new users, update the kafka_server_jaas.conf files in <chartpath>/ocnadd/charts/ocnaddrelayagent/charts/ocnaddkafka/config.
    3. <Optional> Customize offsetsTopicReplicationFactor and transactionStateLogReplicationFactor under ocnaddkafka.ocnadd.kafkaBroker.kafkaProperties in the Relay Agent custom values file.
    4. Update Internal Topic Replication Factor:
      # Update to below values when higher throughput with lower latency is needed.
# This can have lower message reliability in case a Kafka broker goes down.
offsetsTopicReplicationFactor: 1
transactionStateLogReplicationFactor: 1 

# Update to below values when higher message reliability is required (RF>1).
# This can potentially have lower throughput and higher latency if the Kafka cluster Disk IOPS and cluster network bandwidth are less performing.
offsetsTopicReplicationFactor: 2
transactionStateLogReplicationFactor: 2

3.1.4 Modifying Mediation custom values file

Update the management namespace in commons custom values (ocnadd-common-custom-values-25.2.200.yaml) file if it is not updated. 

global.management_info.management_namespace: <management group namespace>

If the mediation group is deployed in a separate cluster from the management group, then external communication between the gateways must be enabled. For detailed instructions on enabling external communication, refer to Enable External Communication Between OCNADD Gateways in the Oracle Communications Network Analytics Data Director User Guide.

Edit the Mediation YAML file (for example, ocnadd-mediation-custom-values-25.2.200-med-group1.yaml) created after making a copy of the ocnadd-mediation-custom-values-25.2.200.yaml and update the following parameters:

  1. Update the CLUSTER-INFO parameters:
    cluster.domainName: <cluster domain name where mediation group is planned for deployment>
cluster.clusterName: <cluster name where mediation group is planned for deployment>
  2. Update the logical name of the worker group to which the mediation group is associated. (Avoid using a colon in the name.)
    cluster.workergroupName: <Logical name of the worker group> (for example worker1 or myddworker)
  3. Update the associated relay agent namespace cluster information to which the mediation group is associated:
    global.ocnaddmediation.deployment.associatedRelayAgentNsClusterInfo: <Relay agent namespace cluster information>

    Example:

    If the Mediation Group you want to associate with a Relay Agent Group is deployed in the "ocnadd-deploy" namespace on "cluster-1", update the configuration parameter as follows:

    global.ocnaddmediation.deployment.associatedRelayAgentNsClusterInfo: "ocnadd-deploy:cluster-1"
  4. Kafka Preinstall Configuration Changes:
    1. <Optional> To change the profiles of the brokers, edit the respective values (CPU, memory, storage, external-access, security, jaas-password, replicas, internal replication factor, and so on) in the Kafka section of the Mediation custom values file.
    2. <Optional> When the security protocol is SASL and the customer is required to add new users, update the kafka_server_jaas.conf files in <chartpath>/ocnadd/charts/ocnaddmediation/charts/ocnaddkafka/config.
    3. <Optional> Customize offsetsTopicReplicationFactor and transactionStateLogReplicationFactor under ocnaddkafka.ocnadd.kafkaBroker.kafkaProperties in the Mediation custom values file.

      Update Internal Topic Replication Factor:

      # Update to below values when higher throughput with lower latency is needed.
# This can have lower message reliability in case a Kafka broker goes down.
offsetsTopicReplicationFactor: 1
transactionStateLogReplicationFactor: 1 

# Update to below values when higher message reliability is required (RF>1).
# This can potentially have lower throughput and higher latency if the Kafka cluster Disk IOPS and cluster network bandwidth are less performing.
offsetsTopicReplicationFactor: 2
transactionStateLogReplicationFactor: 2
    4. <Optional> Enable RAM-based storage for the Kafka cluster. This feature has been introduced to support RAM-based storage in the Kafka cluster. It supports higher throughput for cases where lower message retention is needed with lower latency. To enable RAM-based storage in the Kafka cluster, refer to Enable RAM Storage in Kafka Cluster section in the Oracle Communications Network Analytics Data Director User Guide.

3.1.5 OCNADD UI Configurations Changes for Dashboard Metrics

Edit the ocnadd-management-custom-values-25.2.200.yaml and update the DD_GROUP_PROMETHEUS_API for UI with Relay Agent and Mediation group names and Prometheus IP & Port to enable metrics from all OCNADD groups in the UI dashboard: 

## The parameter is a comma-separated list of group name (Relay Agent or Mediation) and Prometheus IP and Port
## Add all Relay Agent and Mediation groups and their corresponding Prometheus IP & Port

ocnadduirouter:
    ocnadduirouter:
        name: ocnadduirouter
        env:
            groupNamePromIpConfig:
                - groupName: site1:worker1:ocnadd-deploy1:cluster-1
                  prometheusIp: http://localhost:9099
                - groupName: site2:worker2:ocnadd-deploy2:cluster-2
                  prometheusIp: http://localhost:9098

For example:

  1. When OCNADD UI is deployed at the 'BLR' site, where the Relay Agent and Mediation groups are co-located within cluster-1, share the same worker group (wg1), and are deployed under namespaces "dd-relay-agent" & "dd-mediation" respectively, the parameter should be updated as follows:
    groupNamePromIpConfig:
    - groupName: BLR:wg1:dd-relay-agent:cluster-1
      prometheusIp: http://localhost:9099
    - groupName: BLR:wg1:dd-mediation:cluster-1
      prometheusIp: http://localhost:9099
  2. When OCNADD UI is deployed at the 'BLR' site, where the Relay Agent and Mediation groups exist in different clusters (for example, cluster-1 and cluster-2 respectively), share the same worker group (wg1), and are deployed under namespaces "dd-relay-agent" & "dd-mediation" respectively, the parameter should be updated as follows:
    groupNamePromIpConfig:
    - groupName: BLR:wg1:dd-relay-agent:cluster-1
      prometheusIp: http://localhost:9099
    - groupName: BLR:wg1:dd-mediation:cluster-2
      prometheusIp: http://localhost:9100
  3. When OCNADD UI is deployed at the 'BLR' site, where the Relay Agent and multiple Mediation groups exist in different clusters (for example, Relay Agent: cluster-1, Mediation1: cluster-1, and Mediation2: cluster-2), share the same worker group (wg1), and are deployed under namespaces "dd-relay-agent", "dd-mediation1", and "dd-mediation2" respectively, the parameter should be updated as follows:
    groupNamePromIpConfig:
    - groupName: BLR:wg1:dd-relay-agent:cluster-1
      prometheusIp: http://localhost:9099
    - groupName: BLR:wg1:dd-mediation1:cluster-1
      prometheusIp: http://localhost:9099
    - groupName: BLR:wg1:dd-mediation2:cluster-2
      prometheusIp: http://localhost:9100

3.1.6 Alerting Rules Configuration Updates

  1. If OCNADD is to be installed in an OCI setup, remove the following files:
    • <chartpath>/charts/ocnaddmanagement/templates/ocnadd-mgmt-alerting-rules.yaml
    • <chartpath>/charts/ocnaddrelayagent/templates/ocnadd-relayagent-alerting-rules.yaml
    • <chartpath>/charts/ocnaddmediation/templates/ocnadd-mediation-alerting-rules.yaml
  2. If OCNADD is to be installed in a CNE setup, all services will be monitored by Prometheus by default. Therefore, there will not be any modifications in the Helm Chart. All the Prometheus alert rules present in the Helm Chart will be updated in the Prometheus server. (The label used to update the Prometheus server is role: cnc-alerting-rules, which is added by default in the Helm Charts.)
  3. If OCNADD is to be installed in a Tanzu setup, modify the metadata.labels value in the following files as described:
    • <chartpath>/charts/ocnaddmanagement/templates/ocnadd-mgmt-alerting-rules.yaml
    • <chartpath>/charts/ocnaddrelayagent/templates/ocnadd-relayagent-alerting-rules.yaml
    • <chartpath>/charts/ocnaddmediation/templates/ocnadd-mediation-alerting-rules.yaml

    For example, use release: prom-operator" instead of "role: cnc-alerting-rules.

    To obtain the label details, use the following command:

    kubectl get prometheus <Prometheus_Configuration_NAME> -n <Prometheus_Namespace> -o=jsonpath='{.spec.ruleSelector.matchLabels}'

    Example:

    kubectl get prometheus prom-operator-kube-prometh-prometheus -n occne-infra -o=jsonpath='{.spec.ruleSelector.matchLabels}'{"release: prom-operator"}

    Sample Alert File:

    apiVersion: monitoring.coreos.com/v1 
kind: PrometheusRule 
metadata: 
    labels: 
      release: prom-operator 
    name: ocnadd-alerting-rules 
    namespace: {{ .Values.global.cluster.nameSpace.name }}
...
...

3.2 Global Parameters

Table 3-1 Global Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
Common Custom Values Global Parameters
management_info.management_gateway_ip STRING NA - C This parameter should be enabled when external communication is required across OCNADD groups. The parameter denotes the gateway IP of management group. This is required only while installing relay agent group or mediation group.
management_info.management_namespace STRING NA ocnadd-management M The management group namespace name required while installing relay agent or mediation groups
ocnaddredundancyagent.enabled BOOLEAN true/false false M To enable two site redundancy charts
ocnaddredundancyagent.egress BOOLEAN true/false false C Required if egress annotation is required to allow traffic outside cluster
ocnaddredundancyagent.primary_site BOOLEAN true/false false M True if upgrading from non-centralized to centralized.Default is False (direct installation)
ocnaddredundancyagent.primary_agent_ip STRING NA - C This parameter is required only in case the redundancy agent service is enabled. It is configured in the secondary site and denotes the primary site redundancy agent IP address or service fqdn.
extendedStorage.druid.enabled BOOLEAN true/false false M Enable if Druid database as extended storage is available, else cnDBTier as extended storage is used by default
extendedStorage.druid.druidTLsEnabled BOOLEAN true/false true O The parameter depicts if TLS should be used for communication with Druid services. Default is true
extendedStorage.druid.namespace String NA ocnadd-druid M The namespace in which Druid cluster is deployed, if deployed in the same cluster as Data Director
extendedStorage.druid.service_ip String NA 1.1.1.1 M The loadbalancer of the Druid router service, this must only be changed if Druid is enabled else leave as is
extendedStorage.druid.service_port String NA 8080 M The port of the Druid router service
extendedStorage.druid.secret_name String NA ocnadd-druid-api-secret M The name of the secret containing the Druid API credentials.
certificates.singlecert BOOLEAN true/false false M Enable this parameter only when single certificate is created (using OCCM or generate certificate script) for each OCNADD group
initContainers.repo.REPO_PATH STRING NA utils.repo M Repo path where init image is stored
initContainers.cacert.value STRING NA cacert.pem M Cacert file
cnlb.consumeradapter.enable BOOLEAN true/false false C If true, then egress traffic segregation will be enabled for the consumer feeds. It will be used for checking if Egress NAD should be attached to consumer adapters or not. The parameter is only recommended to be enabled for the OCCNE with CNLB support
cnlb.ingressadapter.enable BOOLEAN true/false false C

If true, then ingress traffic segregation will be enabled for the ingress adapter along with external access.

It will be used for checking if Ingress NAD should be attached to ingress adapters or not. The parameter is only recommended to be enabled for the OCCNE with CNLB support
env.repo.REPO_HOST_PORT STRING NA docker.io M Local container registry to pull the images
env.repo.REPO_PATH STRING NA ocdd.repo M Additional repo path
env.oci BOOLEAN true/false false M It should be set to true for OCI platform
env.subnetOcid STRING NA NA C It is required for OCI platform. The OCID of the subnet that you want to use for creating load balancers
env.topologyKey STRING NA kubernetes.io/hostname M The topology key for setting up the topology constraints on the pod deployment
stabilizationWindowSeconds INTEGER NA 60 M Stabilization period in seconds post which scale down starts
scaleDownPeriodSeconds INTEGER NA 30 M Period of each scale down operation in seconds
scaleDownValue INTEGER NA 1 M Number of pods which shall go down in every scaleDownPeriodSeconds
controlPlaneNfList STRING NA BSF,NRF,PCF M It enlists all the control plane NFs
proxyNfList STRING NA SCP,SEPP M It enlist all the proxy NFs
ssl.mTLS BOOLEAN true/false false M Enable MTLS support for internal OCNADD services
ssl.kafkaCipherSuites STRING NA "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" M Supported Cipher Suites for Kafka Broker service in Data Director
ssl.tlsCipherSuites STRING NA "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" M Support Cipher Suites for Internal Services of Data Director
ssl.CERT_EXPIRY_CRONEXPRESSION STRING NA 0 0 * * * M Schedule for Cron Expression that will check certificate expiry at midnight everyday
ssl.CERT_EXPIRY_CRONJOB BOOLEAN true/false true M Enable cronjob schedule to check certificate expiry
acl.genericAclAllowed BOOLEAN true/false false M No need to change this flag here, genericAclAllowed=true will be used in upgrade --set command to restrict the generic ACL creation.
acl.kafkaClientAuth STRING none/required none M This Property is to enable or disable MTLS in Kafka.
acl.aclNotAllowed BOOLEAN true/false true M This Property is used to turn on or off the Kafka ACL's.
cluster.terminationGracePeriodSeconds INTEGER NA 5 O Pod grace termination
cluster.siteName STRING NA BLR M The site name where OCNADD is deployed (e.g. Chicago, BLR)
cluster.secret.name STRING NA db-secret M Database Secret name where DB credentials are stored
cluster.mysqlNameSpace.name STRING NA occne-cndbtierone M cnDBTier namespace
cluster.mysqlPod STRING NA ndbmysqld-0 M cnDBTier Pod Name
cluster.database.db_ip STRING NA mysql-connectivity-service.occne-cndbtierone`1 M Hostname or IP of cnDBTier
cluster.database.db_port INTEGER NA 3306 M DB Port
cluster.database.configuration_db STRING NA configuration_schema M Configuration Service Schema Name
cluster.database.alarm_db STRING NA alarm_schema M Alarm Service Schema Name
cluster.database.health_db STRING NA healthdb_schema M Health Service Schema Name
cluster.database.storageadapter_db STRING NA storageadapter_schema M Storage Adapter Schema Name
cluster.storageClass STRING NA standard M Storage Class Name
cluster.prometheusScrapePort INTEGER NA 9000 O Port to scape metrics required if metrics enabled
cluster.prometheusPortName STRING NA cnc-metrics O Role required to define in alert rules yaml
cluster.max_latency FLOAT NA 0.10 M Max latency range of 100ms
cluster.memory_threshold INTEGER [0-100] 90 M Max Threshold limit for memory
cluster.cpu_threshold INTEGER [0-100] 85 M CPU max threshold limit
cluster.mps INTEGER NA 1500000 M Default MPS rate
cluster.serviceMonitorLabel STRING NA occne-kube-prom-stack M service monitor label to scrape metrics
Management Custom Values Global Parameters
ocnaddmanagement.ocnaddalarm.enabled BOOLEAN true/false true M To enable alarm charts
ocnaddmanagement.ocnaddconfiguration.enabled BOOLEAN true/false true M To enable configuration charts
ocnaddmanagement.ocnaddhealthmonitoring.enabled BOOLEAN true/false true M To enable health monitoring charts
ocnaddmanagement.ocnaddbackuprestore.enabled BOOLEAN true/false true M To enable backup restore charts
ocnaddmanagement.ocnadduirouter.enabled BOOLEAN true/false true M To enable UI router charts
ocnaddmanagement.ocnaddgui.enabled BOOLEAN true/false true M To enable GUI charts
ocnaddmanagement.ocnaddexport.enabled BOOLEAN true/false false M To enable export service charts
ocnaddmanagement.ocnaddmanagementgateway.enabled BOOLEAN true/false true M To enable Management gateway charts
ocnaddmanagement.cnlb.ocnaddredundancyagent.enable BOOLEAN true/false false C

If true, External Access will be enabled for RedundancyAgent. It will be used for checking if cnlb annotations should be assigned to the redundancy deployments or not. The parameter is only recommended to be enabled for the OCCNE with CNLB support

Default is false
ocnaddmanagement.cnlb.ocnaddredundancyagent.network STRING NA default/nf-oam-int7@nf-oam-int7 C

This must be the oam network with ingress definition. The entry means single network will be used by another site's Redundancy Agent for ingress communication.

Update the network from the generated cnlb annotation, Given value is an example need to be updated as per /var/occne/cluster/$OCCNE_CLUSTER/artifacts/cnlbGenAnnotations.py script.
ocnaddmanagement.cnlb.ocnaddredundancyagent.externalIP STRING NA - C

For two site RedundancyAgent communication only single External IP required to communicate.

Update the IP address in the External IP
ocnaddmanagement.cnlb.ocnaddmanagementgateway.enable BOOLEAN true/false false C If true, External Access will be enabled for Management Gateway. It will be used for checking if cnlb annotations should be assigned to the Management gateway deployments or not. The parameter is only recommended to be enabled for the OCCNE with CNLB support
ocnaddmanagement.cnlb.ocnaddmanagementgateway.network STRING NA default/nf-oam-ie1@nf-oam-ie1 C

This must be the oam network with ingress-egress definition. The entry means single network will be used by gateways present in other sites for communication.

Update the network from the generated cnlb annotation, given value is an example need to be updated as per /var/occne/cluster/$OCCNE_CLUSTER/artifacts/cnlbGenAnnotations.py script.
ocnaddmanagement.cnlb.ocnaddmanagementgateway.externalIP STRING NA - C

Single External IP is required to establish communication between gateways of different OCNADD groups located in other sites.

Update the IP address in the External IP
ocnaddmanagement.cnlb.ocnadduirouter.enable BOOLEAN true/false false C If true, External Access will be enabled for UI router. It will be used for checking if cnlb annotations should be assigned to the UI Router deployments or not. The parameter is only recommended to be enabled for the OCCNE with CNLB support
ocnaddmanagement.cnlb.ocnadduirouter.network STRING NA default/nf-oam-egr1@nf-oam-egr1 C

Single External IP is required to route traffic outside cluster

Update the IP address in the External IP
ocnaddmanagement.migration.enable BOOLEAN true/false false C Enable this parameter while performing migration of configurations from source release to target release.
ocnaddmanagement.migration.sourceNamespace STRING NA old_namespace C This parameter denotes the source release namespace from where the configuration should be migrated to the target release.
ocnaddmanagement.cluster.domainName STRING NA occne-ocnadd M Domain name of the setup where Management Group will be deployed
ocnaddmanagement.cluster.clusterName STRING NA occne-ocnadd M Cluster name of the setup where Management Group will be deployed
ocnaddmanagement.cluster.nameSpace.name STRING NA ocnadd-management M OCNADD Management Group namespace
ocnaddmanagement.cluster.env.ALARM_PURGE_DAYS INTEGER NA 7 M Alarm Purge in Days
ocnaddmanagement.cluster.env.OCNADD_MAX_EXTERNAL_KAFKA_FEEDS INTEGER NA 3 M Maximum number of allowed external Kafka Feed
Relay Agent Custom Values Global Parameters
ocnaddrelayagent.ocnaddscpaggregation.enabled BOOLEAN true/false true M To enable SCP aggregation charts
ocnaddrelayagent.ocnaddnrfaggregation.enabled BOOLEAN true/false false M To enable NRF aggregation charts
ocnaddrelayagent.ocnaddseppaggregation.enabled BOOLEAN true/false false M To enable SEPP aggregation charts
ocnaddrelayagent.ocnaddbsfaggregation.enabled BOOLEAN true/false false M To enable BSF aggregation charts
ocnaddrelayagent.ocnaddpcfaggregation.enabled BOOLEAN true/false false M To enable PCF aggregation charts
ocnaddrelayagent.ocnaddvcollectordiameteraggregation BOOLEAN true/false false M To enable vCollector Diameter Aggregation charts
ocnaddrelayagent.ocnaddkafka.enabled BOOLEAN true/false true M To enable Relay Agent Kafka charts
ocnaddrelayagent.ocnaddrelayagentgateway.enabled BOOLEAN true/false true M To enable Relay Agent gateway charts
ocnaddrelayagent.deployment.gwToMgmtGwExternalCommEnabled BOOLEAN true/false false C Enable this property if Relay agent group is deployed in a separate cluster and external connectivity is required between management gateway and relay agent gateway. The communication between the gateways will be in secure mode.
ocnaddrelayagent.deployment.relayAgentGatewayIp STRING NA - C

This property is for configuring Load Balancer IP for Relay Agent gateway when external connectivity is enabled.

Add the IP Addresses in the SAN entry as well for SSL communication

This parameter is not applicable when cluster is CNLB enabled. For CNLB enabled setup, refer cnlb section to configure external IPs.
ocnaddrelayagent.cnlb.kafkabroker.enable BOOLEAN true/false false C If true, external access for the Relay Agent Kafka brokers will be enabled on the CNLB enabled cluster
ocnaddrelayagent.cnlb.kafkabroker.networks STRING NA "default/nf-sig2-int1@nf-sig2-int1,default/nf-sig2-int2@nf-sig2-int2,default/nf-sig2-int3@nf-sig2-int3,default/nf-sig2-int4@nf-sig2-int4" C

This property is used for populating the annotation k8s.v1.cni.cncf.io/networks

Update the networks and networks_extip with the details generated by the section "Enable CNLB for Kafka Broker" from "OCNADD User Guide"
ocnaddrelayagent.cnlb.kafkabroker.networks_extip STRING NA "nf-sig2-int1/10.10.10.10,nf-sig2-int2/10.10.10.11,nf-sig2-int3/10.10.10.12,nf-sig2-int4/10.10.10.13" C

This property is used for populating the annotation oracle.com.cnc/cnlb

Add the IP Addresses in the SAN entry as well for SSL communication
           
ocnaddrelayagent.kafka.kafkaReplicas INTEGER NA 4 M The parameter to change the replicas for the Relay Agent Kafka broker.
ocnaddrelayagent.cluster.domainName STRING NA occne-ocdd M Domain name of the setup where Relay Agent Group will be deployed
ocnaddrelayagent.cluster.clusterName STRING NA occne-ocdd M Cluster name of the setup where Relay Agent Group will be deployed
ocnaddrelayagent.cluster.workergroupName STRING NA wg1 M The logical name of the worker group to which this relay agent group belongs.
ocnaddrelayagent.cluster.nameSpace.name STRING NA ocnadd-relay M OCNADD Relay Agent Group namespace
ocnaddrelayagent.cluster.kafka.ocnadd_kafka_bootstrap_servers STRING NA kafka-broker:9092 M Relay Agent Kafka Bootstrap server for PLAINTEXT
ocnaddrelayagent.cluster.kafka.ocnadd_kafka_bootstrap_servers_ssl STRING NA kafka-broker:9093 M Relay Agent Kafka Bootstrap server for SSL
ocnaddrelayagent.cluster.kafka.ocnadd_kafka_bootstrap_servers_sasl STRING NA kafka-broker:9094 M Relay Agent Kafka Bootstrap server for SASL
Mediation Custom Values Global Parameters
ocnaddmediation.ocnaddkafka.enabled BOOLEAN true/false true M To enable Mediation Kafka charts
ocnaddmediation.ocnaddadmin.enabled BOOLEAN true/false true M To enable Admin charts
ocnaddmediation.ocnaddfilter.enabled BOOLEAN true/false false M To enable Filter charts
ocnaddmediation.ocnaddmediationgateway.enabled BOOLEAN true/false true M To enable Mediation gateway charts
ocnaddmediation.deployment.gwToMgmtGwExternalCommEnabled BOOLEAN true/false false C Enable this property if Mediation group is deployed in a separate cluster and external connectivity is required between management gateway and mediation gateway. The communication between the gateways will be in secure mode.
ocnaddmediation.deployment.mediationGatewayIp STRING NA - C

This property is for configuring Load Balancer IP for Mediation gateway when external connectivity is enabled.

Add the IP Addresses in the SAN entry as well for SSL communication

This parameter is not applicable when cluster is CNLB enabled. For CNLB enabled setup, refer cnlb section to configure external IPs.
ocnaddmediation.deployment.associatedRelayAgentNsClusterInfo STRING NA xxx M Specify the namespace and cluster name of the Relay Agent that you want to associate with the mediation group.
ocnaddmediation.cnlb.kafkabroker.enable BOOLEAN true/false false C If true, external access for the Mediation Kafka brokers will be enabled on the CNLB enabled cluster.
ocnaddmediation.cnlb.kafkabroker.networks STRING NA "default/nf-sig2-int1@nf-sig2-int1,default/nf-sig2-int2@nf-sig2-int2,default/nf-sig2-int3@nf-sig2-int3,default/nf-sig2-int4@nf-sig2-int4" C

This property is used for populating the annotation k8s.v1.cni.cncf.io/networks

Update the networks and networks_extip with the details generated by the section "Enable CNLB for Kafka Broker" from "OCNADD User Guide"
ocnaddmediation.cnlb.kafkabroker.networks_extip STRING NA "nf-sig2-int1/10.10.10.10,nf-sig2-int2/10.10.10.11,nf-sig2-int3/10.10.10.12,nf-sig2-int4/10.10.10.13" C

This property is used for populating the annotation oracle.com.cnc/cnlb

Add the IP Addresses in the SAN entry as well for SSL communication
           
ocnaddmediation.env.admin.OCNADD_ADAPTER_UPGRADE_ENABLE BOOLEAN true/false false M Upgrade consumer adapter during Helm upgrade if the flag is set to true
ocnaddmediation.env.admin.OCNADD_CORR_UPGRADE_ENABLE BOOLEAN true/false false M Upgrade correlation service during Helm upgrade if the flag is set to true
ocnaddmediation.env.admin.OCNADD_DIAM_CORR_UPGRADE_ENABLE BOOLEAN true/false false M Upgrade diameter correlation service during Helm upgrade if the flag is set to true
ocnaddmediation.env.admin.OCNADD_INGRESS_ADAPTER_UPGRADE_ENABLE BOOLEAN true/false false M Upgrade ingress adapter during Helm upgrade if the flag is set to true
ocnaddmediation.env.admin.OCNADD_STORAGE_ADAPTER_UPGRADE_ENABLE BOOLEAN true/false false M Upgrade storage adapter during Helm upgrade if the flag is set to true
ocnaddmediation.kafka.kafkaReplicas INTEGER NA 4 M The parameter to change the replicas for the Mediation Kafka broker.
ocnaddmediation.cluster.domainName STRING NA occne-ocdd M Domain name of the setup where Mediation Group will be deployed
ocnaddmediation.cluster.clusterName STRING NA occne-ocdd M Cluster name of the setup where Mediation Group will be deployed
ocnaddmediation.cluster.workergroupName STRING NA wg1 M Enter the logical name of the worker group that this Mediation group belongs to. This value must match the worker group configured for the associated Relay Agent.
ocnaddmediation.cluster.nameSpace.name STRING NA ocnadd-relay M OCNADD Mediation Group namespace
ocnaddmediation.cluster.kafka.ocnadd_kafka_bootstrap_servers STRING NA kafka-broker:9092 M Mediation Kafka Bootstrap server for PLAINTEXT
ocnaddmediation.cluster.kafka.ocnadd_kafka_bootstrap_servers_ssl STRING NA kafka-broker:9093 M Mediation Kafka Bootstrap server for SSL
ocnaddmediation.cluster.kafka.ocnadd_kafka_bootstrap_servers_sasl STRING NA kafka-broker:9094 M Mediation Kafka Bootstrap server for SASL

3.3 Helm Hook Parameters

Table 3-2 Helm Hook Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ocnaddcopybackuppvcorigtotemphelmhook.name STRING - ocnaddcopybackuppvcorigtotemphelmhook M Hook to copy backup from original to temporary PVC.
ocnaddcopybackuppvctemptoorighelmhook.name STRING - ocnaddcopybackuppvctemptoorighelmhook M Hook to copy backup from temporary to original PVC
ocnaddcreatetemppvchelmhook.name STRING - ocnaddcreatetemppvchelmhook M Hook to create temporary backup PVC during upgrade.
ocnaddhelmhook.config.auto_backup_restore_cm STRING - ocnadd-configmap-auto-backup-restore M Name of the automatic backup restore ConfigMap
ocnaddmanagement.ocnaddhelmhook.config.name STRING - helmhook-configmap M Name of ConfigMap
ocnaddmanagement.ocnaddhelmhook.config.rollback_name STRING - helmhook-rollback-configmap M Name of Rollback ConfigMap
ocnaddmanagement.ocnaddhelmhook.config.upgrade_name STRING - helmhook-upgrade-configmap M Name of Upgrade ConfigMap
ocnaddmanagement.ocnaddhelmhook.name STRING - ocnaddhelmhook M Helm Hook Name
ocnaddpostdeleteworkergrouphelmhook.name STRING - ocnaddpostdeleteworkergrouphelmhook M Name of the postdelete hook used during the uninstallation of the worker group
ocnaddpostdeleteworkergrouphelmhook.retry_delay INTEGER - 15 M Delay between retries
ocnaddpostdeleteworkergrouphelmhook.retry_max_attempt INTEGER - 5 M Maximum number of retries for invoking delete API for worker group
ocnaddpostinstallhelmhook.name STRING - ocnaddpostinstallhelmhook M Post Install Hook Name
ocnaddpostinstallworkergrouphelmhook.name STRING - ocnaddpostinstallworkergrouphelmhook M Name of the postinstall hook used during the installation of the worker group
ocnaddpostinstallworkergrouphelmhook.retry_delay INTEGER - 15 M Delay between retries
ocnaddpostinstallworkergrouphelmhook.retry_max_attempt INTEGER - 5 M Maximum number of retries for invoking the create worker group API
ocnaddpostrollbackhelmhook.name STRING - ocnaddpostrollbackhelmhook M Post Rollback hook name
ocnaddpostupgradehelmhook.name STRING - ocnaddpostupgradehelmhook M Post Upgrade Hook Name
ocnaddpreinstallworkergrouphelmhook.name STRING - ocnaddpreinstallworkergrouphelmhook M Name of the preinstall hook used during the installation of the worker group
ocnaddpreinstallworkergrouphelmhook.retry_delay INTEGER - 15 M Delay between retries
ocnaddpreinstallworkergrouphelmhook.retry_max_attempt INTEGER - 5 M Maximum number of retries for getting the list of worker group names
ocnaddprerollbackhelmhook.name STRING - ocnaddprerollbackhelmhook M Pre Rollback Hook Name
ocnaddpreupgradehelmhook.name STRING - ocnaddpreupgradehelmhook M Pre Upgrade Hook Name

3.4 Aggregation Service Parameters

Table 3-3 Aggregation Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
BATCH_SIZE INTEGER - 65536 O The maximum amount of data to be collected before sending the batch.
CONSUMER_POLL_MS INTEGER - 50 O Polling time in ms for consumer
DD_METADATA_MAP_CACHE_EXPIRY_TIME_MS INTEGER 30ms-30s 30 O DD metadata cache expiry timer, default is 30ms
DD_METADATA_MAP_CACHE_SCHEDULER_TIME_MS INTEGER 5ms-2s 5 O This timer value depends on the attribute METADATA_MAP_CACHE_EXPIRY_TIME_MS. The timer value should be adjusted up or down corresponding to increase or decrease in METADATA_MAP_CACHE_EXPIRY_TIME_MS, default is 5ms
ENABLE_AGGREGATION_COUNTER_METRICS BOOLEAN true/false true M Enable metrics for Aggregation service
ENQUEUE_SCP_ORIGIN_MESSAGES BOOLEAN true/false false C When this parameter is enabled, the SCP originated message in Model-D call model will be held by the aggregation service until received NF originated RxResponse/TxResponse messages or Timer expiry. This flag is used in case of TRANSACTION based message sequencing.
FETCH_MAX_WAIT_MS INTEGER - 100 O The maximum amount of time the server will block before answering the fetch request if there isn’t sufficient data to immediately satisfy the requirement given by fetch.min.bytes
HEARTBEAT_INTERVAL_MS INTEGER - 5000 O The expected time between heartbeats to the consumer coordinator when using Kafka’s group management facilities
KAFKA_COMMIT_INT_CONFIG INTEGER - 1000 O The frequency at which consumer offsets are committed to the Kafka broker
KAFKA_FETCH_MAX_BYTES STRING - 57672000 O The maximum amount of data per-partition the server will return
KAFKA_FETCH_MIN_BYTES STRING - 1 O The minimum amount of data per-partition the server will return
KAFKA_MAX_AGE_CONFIG INTEGER - 7500 M The period of time in milliseconds after which we force a refresh of metadata.
KAFKA_MAX_PARTITIONS_FETCH_BYTES STRING - 10485800 O The maximum amount of data per-partition the server will return.
KAFKA_PRODUCER_SSL_CLIENT_AUTH BOOLEAN true/false false M Kafka SSL client authentication.
KAFKA_SOCKET_BYTES_BUFFER STRING - 10485700 O Kafka Socket Buffer setting for consumer
LINGER_MS INTEGER - 1 O The time to wait before sending messages out to Kafka
MAX_POLL_INTERVAL_MS INTEGER - 30000 O The maximum delay between invocations of poll() when using consumer group management
MAX_POLL_RECORDS INTEGER - 300 O The maximum number of records returned in a single call to poll()
MESSAGE_REORDERING_INCOMPLETE_TRANSACTION_METRICS_ENABLE BOOLEAN true/false false O The parameter enables the Metric to check/count missing/inordered messages of transactions for MESSAGE_SEQUENCING_TYPE=TRANSACTION/REQUEST_RESPONSE
MESSAGE_SEQUENCING_TYPE INTEGER [NONE,TIME_WINDOW,TRANSACTION,REQUEST_RESPONSE] NONE M

NONE: No message sequencing.

TIME_WINDOW: Messages received within window time for each partition will be sorted separately based on time stamp and stream to kafka topic.

TRANSACTION: In order messages received for each transaction within TRANSACTION_EXPIRY_TIME will be sorted separately and stream to kafka topic.

REQUEST_RESPONSE: In order Request(RxRequest and TxRequest) and/or Response pair(RxResponse and TxResponse) messages received for each transaction within REQUEST_RESPONSE will be sorted separately and stream to kafka topic.
OCNADD_AGGREGATION_REDUNDANCY_BUFFER_ENABLED BOOLEAN true/false false O When enabled, this parameter allows the system to buffer and retry messages that fail to send to the Mediation Kafka broker, ensuring they are successfully forwarded. Note that enabling this parameter requires sufficient memory to be allocated to the aggregation service.
OCNADD_AGGREGATION_SERVICE_TOPIC_RETRIES_THRESHOLD INTEGER - 120000 O Retry Threshold for TOPIC reachability
OCNADD_ASR_CLIENT_ENABLE_NETWORK_LATENCY_METRICS BOOLEAN true/false false O The parameter enables network latency metrics for aggregation service.
OCNADD_KAFKA_SECURITY_PROTOCOL_SSL STRING   SSL M Kafka SSL Mechanism.
ocnaddbsfaggregation.maxReplicas INTEGER - 1 M The maximum number of replicas required for BSF aggregation service instance
ocnaddbsfaggregation.minReplicas INTEGER - 1 M The minimum number of replicas required for BSF aggregation service instance
ocnaddbsfaggregation.name STRING - ocnaddbsfaggregation M Name of the application
ocnaddbsfaggregation.resources.limit.cpu INTEGER - 2 M Number of max CPU for BSF Aggregation
ocnaddbsfaggregation.resources.limit.ephemeralstorage STRING - 500Mi M Ephemeral Storage for BSF Aggregation
ocnaddbsfaggregation.resources.limit.memory STRING - 2Gi M Max Memory limit for BSF Aggregation
ocnaddnrfaggregation.maxReplicas INTEGER - 1 M The maximum number of replicas required for NRF aggregation service instance
ocnaddnrfaggregation.minReplicas INTEGER - 1 M The minimum number of replicas required for NRF aggregation service instance
ocnaddnrfaggregation.name STRING - ocnaddnrfaggregation M Name of the application
ocnaddnrfaggregation.resources.limit.cpu INTEGER - 3 M Number of maximum CPUs for NRF aggregation
ocnaddnrfaggregation.resources.limit.ephemeralstorage STRING - 500Mi M Ephemeral Storage for NRF Aggregation
ocnaddnrfaggregation.resources.limit.memory STRING - 2Gi M Max Memory limit for NRF Aggregation
ocnaddpcfaggregation.maxReplicas INTEGER - 2 M The maximum number of replicas required for PCF aggregation service instance
ocnaddpcfaggregation.minReplicas INTEGER - 1 M The minimum number of replicas required for PCF aggregation service instance
ocnaddpcfaggregation.name STRING - ocnaddpcfaggregation M Name of the application
ocnaddpcfaggregation.resources.limit.cpu INTEGER - 2 M Number of max CPU for PCF Aggregation
ocnaddpcfaggregation.resources.limit.ephemeralstorage STRING - 500Mi M Ephemeral Storage for PCF Aggregation
ocnaddpcfaggregation.resources.limit.memory STRING - 2Gi M Max Memory limit for PCF Aggregation
ocnaddscpaggregation.maxReplicas INTEGER - 4 M The maximum number of replicas required for SCP aggregation service instance
ocnaddscpaggregation.minReplicas INTEGER - 1 M The minimum number of replicas required for SCP aggregation service instance
ocnaddscpaggregation.name STRING - ocnaddscpaggregation M Name of the application
ocnaddscpaggregation.resources.limit.cpu INTEGER - 3 M Number of max CPU for SCP Aggregation
ocnaddscpaggregation.resources.limit.ephemeralstorage STRING - 500Mi M Ephemeral Storage for SCP Aggregation
ocnaddscpaggregation.resources.limit.memory STRING - 2Gi M Max Memory limit for SCP Aggregation
ocnaddseppaggregation.maxReplicas INTEGER - 2 M The maximum number of replicas required for SEPP aggregation service instance
ocnaddseppaggregation.minReplicas INTEGER - 1 M The minimum number of replicas required for SEPP aggregation service instance
ocnaddseppaggregation.name STRING - ocnaddseppaggregation M Name of the application
ocnaddseppaggregation.resources.limit.cpu INTEGER - 3 M Number of max CPU for SEPP Aggregation
ocnaddseppaggregation.resources.limit.ephemeralstorage STRING - 500Mi M Ephemeral Storage for SEPP Aggregation
ocnaddseppaggregation.resources.limit.memory STRING - 2Gi M Max Memory limit for SEPP Aggregation
ocnaddvcollectordiameteraggregation.maxReplicas INTEGER - 1 M The maximum number of replicas required for ocnaddvcollectordiameteraggregation aggregation service instance
ocnaddvcollectordiameteraggregation.minReplicas INTEGER - 1 M The minimum number of replicas required for ocnaddvcollectordiameteraggregation aggregation service instance
ocnaddvcollectordiameteraggregation.name STRING - ocnaddvcollectordiameteraggregation M Name of the application
ocnaddvcollectordiameteraggregation.resources.limit.cpu INTEGER   2 M Number of max CPU for vCollector Diameter Aggregation
ocnaddvcollectordiameteraggregation.resources.limit.ephemeralstorage STRING   500Mi M Ephemeral Storage for vCollector Diameter Aggregation
ocnaddvcollectordiameteraggregation.resources.limit.memory STRING   2Gi M Max Memory limit for vCollector Diameter Aggregation
PRODUCERS_BUFFER_MEMORY INTEGER - 67108864 O The total bytes of memory the producer can use to buffer records waiting to be sent to the server.
PRODUCERS_COMPRESSION_TYPE STRING none/snappy snappy O The compression type for all data generated by the producer. Changing compression type to none may impact latency and throughput when running OCNADD under high traffic load.
PRODUCERS_DELIVERY_TIMEOUT_MS INTEGER - 120000 O The maximum amount of time, in milliseconds, that a Kafka producer will wait for a message to be successfully delivered to the broker and acknowledged.
PRODUCERS_MAX_BLOCK_MS INTEGER - 10000 O The maximum amount of time, in milliseconds, that the Kafka producer will block when attempting to send a record.
PRODUCERS_MAX_REQUEST_SIZE INTEGER - 1048500 O The maximum size of a request in bytes. This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.
PRODUCERS_RETRIES INTEGER - 0 O The number of times producer will retry a request that may fail due to transient error. Configuring this property to more than 0 may impact in throughput
REQUEST_RESPONSE_MSG_SEQUENCING_EXPIRY_TIMER INTEGER [5-500]ms 10ms C

When MESSAGE_SEQUENCING_TYPE = REQUEST_RESPONSE

Range [5ms-500ms]; default: 10ms
REQUEST_TIMEOUT_MS INTEGER - 1000 O The configuration controls the maximum amount of time the client will wait for the response of a request
SESSION_TIME_OUT INTEGER - 15000 O The timeout used to detect client failures when using Kafka’s group management facility.
SRC_FEED_METADATA_CLEAN_DELAY_SEC INTEGER - 86400 C Initial delay in cleaning the metadata cache
SRC_FEED_METADATA_CLEAN_PERIOD_SEC INTEGER - 86400 C Interval after the metadata cache is cleaned
SRC_FEED_METADATA_HISTORY_LENGTH INTEGER - 20 C The number of the metadata maintained in the cache
TOTAL_FORWARDED_MESSAGE_METRICS_ENABLE BOOLEAN true/false false O The parameter enables the Metric to get total count of forwarded messages by aggregation service
TRANSACTION_MSG_SEQUENCING_EXPIRY_TIMER INTEGER [20ms-30s] 200ms C

When MESSAGE_SEQUENCING_TYPE = TRANSACTION

Range [20ms-30s]; default: 200ms
WINDOW_MSG_SEQUENCING_EXPIRY_TIMER INTEGER [5-500]ms 10ms C

When MESSAGE_SEQUENCING_TYPE = TIME_WINDOW

Range [5ms-500ms]; default: 10ms

3.5 Configuration Service Parameters

Table 3-4 Configuration Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ocnaddconfiguration.name STRING - ocnaddconfiguration M Name of configuration service
MAX_ALLOWED_FILTERS INTEGER - 30 O Maximum number of allowed filters
MAX_VALUES_IN_FILTER_ATTRIB INTEGER - 20 O Maximum number of values allowed in filter attributes
MAX_FILTERS_ASSOC_WITH_APP INTEGER - 4 O Maximum number of filters associated with a single app
MAX_ACTION_TYPE_IN_FILTER INTEGER - 2 O Maximum number of action type in a filter with chaining
MAX_EXTERNAL_AGGREGATED_FEEDS INTEGER - 2 O Maximum number of allowed external aggregated feeds
MAX_L3L4_ATTRIBUTES INTEGER - 2 O Maximum number of allowed L3L4 attributes
MAX_GLOBALL3L4_ROW_SIZE INTEGER - 500 O Maximum size of L3L4 rows
MAX_CORRELATION_CONFIGURATION_SUPPORTED INTEGER - 3 O Maximum number of correlation feeds allowed
OCNADD_MAX_WORKERGROUP_THRESHOLD_PERCENTAGE INTEGER - 80 O The percentage threshold for the maximum worker group supported
MAX_EXPORT_CONFIGURATION_SUPPORTED INTEGER - 3 O The simultaneous number of export configuration supported on the Data Director
EXPORT_CONFIG_PURGE_TIMER_HR INTEGER [ 1-48] 24 O The purge timer for the export configuration
EXPORT_PURGE_SCHEDULER_DELAY_MS INTEGER - 30000 O The delay in milisec after which the purging of the export configuration will be checked.
CONFIG_NOTIFICATION_SCHEDULER_PERIOD_MS STRING - 200ms O The notification sender thread fixed delay upon which it will check for the pending notiifications
CONFIGURATION_FILTER_METHODS STRING [GET,POST,PUT,DELETE,PATCH,CONNECT,OPTIONS,TRACE] GET,POST,PUT,DELETE,PATCH,CONNECT,OPTIONS,TRACE O The configuration of methods on which the filter is possible
ADAPTER_DEFAULT_INGRESS_TOPIC STRING - MAIN O The topic name for the non oracle ingress feed adapter
ADAPTER_DEFAULT_INGRESS_PARTITIONS INTEGER - 30 O The number of partitions for the non oracle ingress feed adapter
ADAPTER_DEFAULT_INGRESS_REPLICATION_FACTOR INTEGER - 1 O The non oracle topic replication factor
ADAPTER_DEFAULT_INGRESS_RETENTION_MS INTEGER - 600000 O The non oracle topic retention time in milisec
ADAPTER_DEFAULT_INGRESS_ACKS STRING - all O The non oracle producer acknowledgement value
ADAPTER_DEFAULT_INGRESS_RETRY INTEGER - 3 O The number of retries for the non oracle ingress adapter feed
ADAPTER_DEFAULT_INGRESS_LIMIT INTEGER - 101874 O The buffer in bytes in the non oracle ingress adapter feed for the http connection
resources.limits.cpu INTEGER - 1 M Number of maximum CPUs for each configuration service instance
resources.limits.memory STRING - 1Gi M Max Memory limit for each configuration service instance
resources.limits.ephemeralstorage STRING - 500Mi M Ephemeral Storage for each configuration service
resources.requests.cpu INTEGER - 1 M Minimum number of CPUs required for each configuration service instance
resources.requests.memory STRING - 1Gi M minimum Memory required for each configuration instance
resources.requests.ephemeralstorage STRING - 100Mi M minimum Ephemeral Storage required for each configuration instance
ocnaddmigration.name STRING - ocnaddmigration M Name of the migration Job
ocnaddmigration.resources.limit.cpu STRING - 500m M Maximum CPU required for the Migration Job
ocnaddmigration.resources.limit.memory STRING - 1Gi M Maximum Memory required for the Migration Job
ocnaddmigration.resources.requests.cpu STRING - 500m M Minimum CPU required for the Migration Job
ocnaddmigration.resources.requests.cpu STRING - 1Gi M Minimum Memory required for the Migration Job

3.6 Health Monitoring and Alarm Service Parameters

Table 3-5 Health Monitoring Service Parameters

Parameter Name Data Type Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ocnaddhealthmonitoring.name STRING ocnaddhealthmonitoring M Health monitoring service name
HEALTH_MONITORING_TIMER INTEGER 5000 O Timer to check Health of integrated services
HEALTH_METRICS_SCHEDULED BOOLEAN true O Scheduler for metrics
HEALTH_METRICS_TIMER INTEGER 120000 O Timer for health metrics
HEALTH_PURGE_TIME_HR INTEGER 5 O Health profile purging timer in hour
HEALTH_MONITORING_CPUTHRESHOLD INTEGER 75 M CPU threshold to raise alarm
HEALTH_MONITORING_MEMORYTHRESHOLD INTEGER 95 M Memory threshold to raise alarm
Logging Properties
resources.limits.cpu INTEGER 1 M Number of maximum CPUs for each health monitoring service instance
resources.limits.memory STRING 1Gi M Max Memory limit for each health monitoring service instance
resources.limits.ephemeralstorage STRING 500Mi M Ephemeral Storage for each health monitoring service
resources.requests.cpu INTEGER 1 M Minimum number of CPUs required for each health monitoring service instance
resources.requests.memory STRING 1Gi M minimum Memory required for each health monitoring instance
resources.requests.ephemeralstorage STRING 200Mi M minimum Ephemeral Storage required for each health monitoring instance

Table 3-6 Alarm Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ocnaddalarm.name STRING - ocnaddalarm M Application name for Alarm Service
resources.limits.cpu INTEGER - 1 M Number of maximum CPUs for each alarm service instance
resources.limits.memory STRING - 1Gi M Max Memory limit for each alam service instance
resources.limits.ephemeralstorage STRING - 200Mi M Ephemeral Storage for each alarm service
resources.requests.cpu INTEGER - 1 M Minimum number of CPUs required for each alarm service instance
resources.requests.memory STRING - 1Gi M minimum Memory required for each alarm instance
resources.requests.ephemeralstorage STRING - 200Mi M minimum Ephemeral Storage required for each alarm instance
MAX_ALARM_RETRIEVE_COUNT INTEGER - 1000 O Parameter to fetch maximum of 1000 latest alarm for each severity type

3.7 Admin Service Parameters

Table 3-7 Admin Service Parameters

Parameter Name Data Type Range Default Value M/O/C Description
resources.limits.cpu INTEGER - 1 M Number of maximum CPUs for each admin service
resources.limits.memory STRING - 1Gi M Max Memory limit for each admin service instance
resources.limits.ephemeralstorage STRING - 200Mi M Ephemeral Storage for each admin service
resources.requests.cpu INTEGER - 1 M Minimum number of CPUs required for each admin service instance
resources.requests.memory STRING - 1Gi M minimum Memory required for each admin instance
resources.requests.ephemeralstorage STRING - 200Mi M minimum Ephemeral Storage required for each admin instance
OCNADD_EGRESS_NETWORK_ENABLE BOOLEAN true/false false O Enable this parameter to true if traffic needs to be routed outside the cluster.
OCNADD_EGRESS_NETWORK_NAME_VALUE STRING - oam O Name of the egress network configured in the CNE cluster.
OCNADD_CNC_ENABLE STRING   True O Enable oracle.com.cnc network.
Consumer Aapter Parameters
consumeradapter.resources.limits.cpu INTEGER - 3 M Number of maximum CPUs for each admin service
consumeradapter.resources.limits.memory STRING - 6Gi M Max Memory limit for each admin service instance
consumeradapter.resources.limits.ephemeralstorage STRING - 1Gi M Ephemeral Storage for each admin service
consumeradapter.resources.requests.cpu INTEGER - 3 M Minimum number of CPUs required for each admin service instance
consumeradapter.resources.requests.memory STRING - 6Gi M minimum Memory required for each Correlation instance
consumeradapter.resources.requests.ephemeralstorage STRING - 1Gi M minimum Ephemeral Storage required for each Correlation instance
EGRESS_SSL_HANDSHAKE_TIMEOUT INTEGER - 5 O SSL handshake timeout.
ENABLE_L3L4_COUNTER_METRICS BOOLEAN true/false false O Enable L3L4 Metric.
OCNADD_ADAPTER_MIN_REPLICAS_HTTP2 INTEGER - 2 M Minimum Replicas for HTTP2 Adapter
OCNADD_ADAPTER_MAX_REPLICAS_HTTP2 INTEGER - 13 M Max Replicas for HTTP2 Adapter
OCNADD_ADAPTER_MIN_REPLICAS_TCP INTEGER - 1 M Minimum Replicas for TCP Adapter
OCNADD_ADAPTER_MAX_REPLICAS_TCP INTEGER - 9 M Max Replicas for TCP Adapter
MAX_TCP_CONNECTION_PER_DEST INTEGER - 6 M Max allowed TCP connection per destination
ADAPTER_KAFKA_FETCH_MIN_BYTES INTEGER - 0 O The minimum amount of data the server should return for a fetch request
ADAPTER_KAFKA_FETCH_MAX_BYTES STRING - 57672000 O The maximum amount of data the server should return for a fetch request
ADAPTER_KAFKA_MAX_PARTITION_FETCH_BYTES STRING - 10485700 O The maximum amount of data per-partition the server will return
ADAPTER_KAFKA_FETCH_MAX_WAIT_MS INTEGER - 40 O The maximum amount of time the server will block before answering the fetch request
ADAPTER_KAFKA_SESSION_TIME_OUT INTEGER - 15000 O The timeout used to detect client failures when using Kafka’s group management facility
ADAPTER_KAFKA_HEARTBEAT_INTERVAL_MS INTEGER - 5000 O The expected time between heartbeats to the consumer coordinator when using Kafka’s group management facilities
ADAPTER_KAFKA_MAX_POLL_INTERVAL_MS INTEGER - 30000 O The maximum delay between invocations of poll() when using consumer group management
ADAPTER_KAFKA_MAX_POLL_RECORDS INTEGER - 1500 O The maximum number of records returned in a single call to poll()
ADAPTER_KAFKA_COMMIT_INT_CONFIG INTEGER - 30 O The frequency in milliseconds that the consumer offsets are committed to Kafka
ADAPTER_KAFKA_NUM_THREADS_CONFIG_HTTP2 INTEGER - 9 O The number of threads to run stream processing for http2 connections.
ADAPTER_KAFKA_NUM_THREADS_CONFIG_TCP INTEGER - 6 O The number of threads to run stream processing for tcp connections.
ADAPTER_KAFKA_CONSUMER_POLL_MS INTEGER - 30 O The amount of time in milliseconds to block waiting for input.
ADAPTER_KAFKA_RECEIVE_BUFFER_BYTES STRING - 10485700 M The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.
ADAPTER_LOG_LEVEL_KAFKA STRING [ON,OFF] OFF O Whether to ON or OFF Kafka logs in Adapter Service.
OCNADD_ADAPTER_MAX_REPLICAS_TCP INTEGER   2 O MAX replicas for synthetic Adapter.
OCNADD_ADAPTER_LIVENESS_DELAY INTEGER   60 M Adapter Svc Liveness Param: this field tells the kubelet that it should wait for mentioned seconds before performing the first probe.
OCNADD_ADAPTER_LIVENESS_PERIOD_SECONDS INTEGER   15 M Adapter Svc Liveness Param: this field specifies that the kubelet should perform a liveness probe every given number of seconds.
OCNADD_ADAPTER_LIVENESS_FAILURE INTEGER   5 M Adapter Svc Liveness Param: For the case of a liveness probe, triggers a restart for that specific container if the container failed to start for given number of failure retries.
OCNADD_ADAPTER_LIVENESS_TIMEOUT INTEGER   20 M Adapter Svc Liveness Param: Number of seconds after which the probe times out.
CONFIG_SVC_DATASTREAM_OFFSET_DELAY_MS INTEGER   3000 O Delay in milliseconds between Retries to fetch the data stream offset from config service in case of failure.
ADAPTER_KAFKA_LISTCONSUMER_TIMEOUT_MS INTEGER   30000 O Timeout in milliseconds to list the Consumer Groups.
KAFKA_TOPIC_NO_OF_PARTITIONS INTEGER   42 O Default number of partitions that will be created for a topic when a new Kafka feed is created.
KAFKA_TOPIC_REPLICATION_FACTOR INTEGER   1 O Replication Factor for the Kafka Topic of Kafka Feed.
KAFKA_TOPIC_RETENTION_MS INTEGER   300000 O Retention Time for Kafka Topic.
KAFKA_TOPIC_SEGMENT_MS INTEGER   300000 O Retention Time for the Kafka topic segment
EXTERNAL_CONSUMER_SASL_PORT INTEGER   9094 O Kafka bootstrap server port number for SASL_SSL protocol.
KAFKA_FUTURE_TIMEOUT_MS INTEGER   25000 O Timeout to fetch the admin client response details.
VERIFY_KAFKA_CONNECTION_TIMEOUT_MS INTEGER   10000 O Timeout to verify Kafka connection in milliseconds.
KAFKAFEED_METRICS_SCHEDULED BOOLEAN   true O To enable or disable metrics for Kafka Feeds.
KAFKAFEED_METRICS_TIMER STRING   15s O Metrics timer for Kafka Feeds.
TCP_STREAM_RESET_ENABLED BOOLEAN   false O To enable Kafka feed stream restart. This maybe required only when 3rd Party consumer is not working properly and frequently breaks connections with Synthetic Feed
TCP_STREAM_RESET_ELAPSED_TIME INTEGER - 60 O The time in minutes to check if stream reset is required.
TCP_STREAM_RESET_FIXED_DELAY_MS INTEGER   300000 O Default 300 sec, Schedular Interval Time
TCP_STREAM_RESET_INI_DELAY_MS INTEGER   150000 O Default 150 sec, Schedular Initial Delay to Start
TCP_STREAM_RESTART_INTERVAL_MS INTEGER   300000 O Default 300 sec, interval to check for the TCP stream restart
TCP_CONN_INSPECTOR_ENABLED BOOLEAN true/false true O The parameter to enable the watcher for the TCP connection in consumer adapter
OCNADD_INTERNAL_CLIENT_SSL_PROTOCOL STRING   TLS O The SSL protocol used between the adapter and internal DD services communication
OCNADD_INTERNAL_CLIENT_SSL_PROTOCOLS STRING   TLSv1.2,TLSv1.3 O The version of TLS supported between adapter and internal DD services communication
OCNADD_INTERNAL_CLIENT_SSL_HANDSHAKE_TIMEOUT STRING   30s O SSL handshake timeout between adapter and internal DD services communication
OCNADD_SSL_CIPHERS STRING   TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 O Oracle Ciphers supported for the TLS communication
OCNADD_ADAPTER_CONFIG_RETRY_DELAY STRING   5s M The retry interval between adapter and configuration service communication for subscription
OCNADD_ADAPTER_CONFIG_RETRY_DELETE_SUBS_REQ_ATTEMPT STRING   3 M The number of retries supported for sending the delete subscription request to configuration service by consumer adapter service
OCNADD_ADAPTER_CONFIG_RETRY_DELETE_SUBS_REQ_DELAY STRING   3s M The retry interval supported for sending the delete subscription request to configuration service by consumer adapter service
EGRESS_TRUSTSTORE_ENABLED BOOLEAN true/false true M The parameter to enable/disable the truststore between consumer adapter and 3rd party application
EGRESS_SSL_CLIENT_AUTH STRING need/want want M SSL Authentication mode to be supported between consumer adapter and 3rd party communication
EGRESS_SSL_HANDSHAKE_TIMEOUT STRING - 5s M SSL handshake timeout between adapter and 3rd party application communication
HTTP_ENABLE_SUBSCRIBE_API_ASYNC_PROCESSING BOOLEAN true/false true M The parameter to enable the asynchronous processing of subscription request towards the configuration service
EGRESS_RESPONSE_IDLE_TIMEOUT_SEC INTEGER - 120 O The setting (which defaults to 2 minutes) dictates when to close a connection after it becomes idle
EGRESS_RESPONSE_TIMEOUT_SEC INTEGER - 8 O The amount of time it takes to actually receive the response back from the server, default is 8 sec
EGRESS_CHANNEL_TIMEOUT_SEC INTEGER - 6 O Specifies the amount of time, in seconds, that the HTTP transport channel waits for a read request to complete on a socket after the first read occurs. Default is 6 sec
EGRESS_HTTP_FOLLOW_REDIRECTS STRING - false O The parameter to indicate that consumer adapter does not want any redirections from the 3rd party applications
SO_SEND_BUF_BYTES_HTTP STRING   16777216 O The send socket buffer size for the HTTP connection towards 3rd party application
EGRESS_KEEPALIVE_IDLE INTEGER - 60 O The keepalive will be sent after the connection is idle for the configured seconds
EGRESS_KEEPALIVE_INT INTEGER - 60 O interval between two keepalive messages
EGRESS_KEEPALIVE_COUNT INTEGER - 10 O The maximum number of keepalive packets that will be sent before assuming the connection is dead
EGRESS_HTTP_CLIENT_MAX_CONCURRENT_HTTP_CONN INTEGER - 100 O The maximum number of concurrent HTTP connection that can be made by http client
EGRESS_HTTP_MAX_CONCURR_REQ_PER_HTTP_CONN INTEGER - 5 O The maximum number of concurrent HTTP Requests that can be sent by http client on the single http connection
EGRESS_MAX_CONNECTION_POOL_IDLE INTEGER - 30 O In the http client connection pool, the connections that are not currently in use but are maintained by the pool for reuse
EGRESS_HTTP_CLIENT_SHUTDOWN_QUIET_PERIOD_SEC INTEGER - 25 O Sets the amount of quiet period for shutdown of client thread pools
EGRESS_HTTP_CLIENT_SHUTDOWN_TIMEOUT_SEC INTEGER - 30 O Sets the amount of time to wait for shutdown of client thread pools
ADAPTER_TCP_CLIENT_POOL_MAX INTEGER - 1000 O the maximum number of concurrent TCP connections a client can establish with a server
ADAPTER_TCP_CLIENT_CHANNEL_TIMEOUT INTEGER - 60 O A TCP client channel timeout occurs when a TCP client doesn't receive a response from a server within a specific timeframe, leading to the connection being terminated
ADAPTER_TCP_CLIENT_KEEPALIVE_IDLE INTEGER - 120 O The keepalive will be sent after the connection is idle for the configured seconds
ADAPTER_TCP_CLIENT_KEEPALIVE_INT INTEGER - 20 O interval between two keepalive messages
ADAPTER_TCP_CLIENT_KEEPALIVE_COUNT INTEGER - 5 O The maximum number of keepalive packets that will be sent before assuming the connection is dead
ADAPTER_TCP_CLIENT_SSL_HANDSHAKE INTEGER - 60 O The timeout for the SSL handshake to complete for the TCP connection
TCP_CONN_INSPECTOR_FIXED_DELAY STRING - 30s O The delay interval after which the TCP connection watcher will keep on watching the connection
TCP_CONN_INSPECTOR_INI_DELAY STRING - 20s O The initial delay after which the TCP connection watcher will start watching the connection
ADAPTER_TCP_CONNECT_TIMEOUT INTEGER - 60 O The TCP connection timeout after which there is no response received from the server
ADAPTER_TCP_CONNECT_RETRY_MS INTEGER - 1000 O The TCP connection retry interval
ADAPTER_TCP_CONNECT_MAX_RETRY_DELAY_MS STRING - 120000 O The maximum wait for the TCP connection retry
TCP_SEQ_ACK_CONNECTION_MGMT_TIMER_MILLI STRING - 7200000 O The connection management timer for the sequence acknowledgement feature in consumer adapter. It is configured in milisec
SYNTHETIC_SEQ_ACK_CACHE_CLEAN_DELAY_SEC INTEGER - 5 O The timeout after which the cache cleaning will happen for the sequence ack cache
SYNTHETIC_SEQ_ACK_CACHE_CLEAN_PERIOD_SEC INTEGER   5 O The time period an entry will remain in sequence ack cache
SYNTHETIC_STREAM_ID_TRANSACTION_MGMT_TIMER_MILLI INTEGER   100000 O The connection management timer for the stream-id feature in consumer adapter. It is configured in milisec
SYNTHETIC_STREAM_ID_CACHE_CLEAN_DELAY_SEC INTEGER   2 O The timeout after which the cache cleaning will happen for the stream-id cache
SYNTHETIC_STREAM_ID_CACHE_CLEAN_PERIOD_SEC INTEGER   2 O The time period an entry will remain in stream-id cache
ADAPTER_KAFKA_SOURCE_TOPIC STRING - MAIN M The topic name that consumer adapter will start reading from
ADAPTER_KAFKA_TOPIC_CHECK_INITIAL_DELAY STRING - 120s M The interval after which the consumer adapter will check if the topic to consume has been created.
OCNADD_KAFKA_SSL_PROTOCOL STRING - TLSv1.3 M SSL protocol configured in consumer adapter with Kafka cluster
ADAPTER_KAFKA_MAX_METADATA_AGE STRING - 300000 O The time after which the consumer adapter will refresh the metadata information from the Kafka cluster
ENABLE_KAFKA_RECORD_TIMESTAMP_PROCESSING BOOLEAN true/false true O The parameter to denote that Kafka record timestamp should be used in the latency calculation
ADAPTER_KAFKA_ENABLE_AUTO_COMMIT BOOLEAN true/false false O The parameter to enable the autocommit of Kafka consumer offsets by the consumer adapter
ADAPTER_KAFKA_AUTOCOMMIT_INT_CONFIG INTEGER - 0 O The value of autocommit interval if autocommit is enabled in the consumer adapter
STREAM_THREAD_DELAY_MS INTEGER - 10000 O The initial delay in the stream processing after which the asynchronous retries will be tried.
ADAPTER_ASYNC_ENDPOINT_RETRY_SCH_FXD_DELAY STRING - 30s O The delay after which the retry is done in an asynchronous communication with the 3rd party application
MAX_CONSECUTIVE_ERRORS_ALLOWED INTEGER - 10 O The number of consecutive failure after which the circuit is broken
MAX_CONSECUTIVE_SUCCESS_REQ_ALLOWED STRING - 270000 O The consecutive successful messages count before the circuit is deemed to be closed again

3.7.1 Correlation Service Parameters

All the Correlation parameters are available under ocnaddadmin.correlation section in ocnadd-mediation-custom-values.yam file.

Table 3-8 Correlation Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
correlation.resources.limits.cpu INTEGER - 3 M Number of maximum CPUs for each Correlation instance
correlation.resources.limits.memory STRING - 64Gi M Max Memory limit for each Correlation instance
correlation.resources.limits.ephemeralstorage STRING - 800Mi M Ephemeral Storage for each Correlation instance
correlation.resources.requests.cpu INTEGER - 3 M Minimum number of CPUs required for each Correlation instance
correlation.resources.requests.memory STRING - 24Gi M minimum Memory required for each Correlation instance
correlation.resources.requests.ephemeralstorage STRING - 400Mi M minimum Ephemeral Storage required for each Correlation instance
correlation.minReplicas INTEGER - 1 M Minimum replicas of correlation service instance
correlation.maxReplicas INTEGER - 4 M Maximum replicas of correlation service instance
           
Environmental variables for Correlation service are declared under "ocnaddadminsvc.correlation.env" section
ADMIN_CORRELATION_RESOURCE_FILE STRING - /tmp/ocnadd/deploy/ocnaddcorrelationservice.yaml M Template file for deploying correlation service through admin service.
KAFKA_STREAM_STATE STRING - /tmp/ocnadd/kafka/state O temporary storage for kafka state store
KAFKA_REPLICATION_FACTOR INTEGER - 1 O replication factor for state store
KAFKA_ENABLE_AUTO_COMMIT BOOLEAN [true/false] false O enable or disable kafka auto commit
KAFKA_SOCKET_BYTES_BUFFER INTEGER - 104857 O Kafka Socket Buffer setting for consumer
KAFKA_SOCKET_BYTES_BUFFER_PORTION INTEGER - 100 O This parameter is used to multiply with KAFKA_SOCKET_BYTES_BUFFER
KAFKA_FETCH_MIN_BYTES INTEGER - 1 O The minimum amount of data per-partition the server will return
KAFKA_FETCH_MAX_BYTES INTEGER - 576720 O The maximum amount of data per-partition the server will return
KAFKA_FETCH_MAX_BYTES_PORTION INTEGER - 100 O This parameter is used to multiply with KAFKA_FETCH_MAX_BYTES
KAFKA_MAX_PARTITIONS_FETCH_BYTES INTEGER - 104858 O The maximum amount of data per-partition the server will return.
KAFKA_MAX_PARTITIONS_FETCH_BYTES_PORTION INTEGER - 10 O This parameter is used to multiply with KAFKA_MAX_PARTITIONS_FETCH_BYTES
FETCH_MAX_WAIT_MS INTEGER - 100 O The maximum amount of time the server will block before answering the fetch request if there isn’t sufficient data to immediately satisfy the requirement given by fetch.min.bytes
SESSION_TIME_OUT INTEGER - 15000 O The timeout used to detect client failures when using Kafka’s group management facility.
HEARTBEAT_INTERVAL_MS INTEGER - 5000 O The expected time between heartbeats to the consumer coordinator when using Kafka’s group management facilities
MAX_POLL_INTERVAL_MS INTEGER - 30000 O The maximum delay between invocations of poll() when using consumer group management
MAX_POLL_RECORDS INTEGER - 500 O The maximum number of records returned in a single call to poll()
KAFKA_OFFSET_CONFIG STRING - latest O default kafka data stream offset config
KAFKA_AUTOCOMMIT_INT_CONFIG INTEGER - 50 O It specifies how often the consumer commits its current position, which can be useful for ensuring message processing progress.
KAFKA_COMMIT_INT_CONFIG INTEGER - 50 O this property will configure the interval at which Kafka consumer commits offsets.
KAFKA_NUMBER_THREADS_CONFIG INTEGER - 6 O this property is used to configure the number of threads or consumers that Kafka Streams or Kafka consumers will use for processing messages
KAFKA_MAX_AGE_CONFIG INTEGER - 7500 O This property will be used to set a maximum age for Kafka consumer records
KAFKA_CONSUMER_STRATEGY STRING - org.apache.kafka.clients.consumer.RoundRobinAssignor O This property will be used to the strategy used for partition assignment when consuming messages from Kafka topics
PRODUCERS_ACKNOWLEDGMENTS INTEGER - 0 O producer acknowledgments
CONSUMER_POLL_MS INTEGER - 50 O Polling time in ms for consumer
BATCH_SIZE INTEGER - 65536 O The maximum amount of data to be collected before sending the batch.
LINGER_MS INTEGER - 1 O The time to wait before sending messages out to Kafka
REQUEST_TIMEOUT_MS INTEGER - 1000 O The configuration controls the maximum amount of time the client will wait for the response of a request
OCNADD_KAFKA_SSL_PROTOCOL STRING - TLSv1.3 O SSL Protocol version
OCNADD_KAFKA_SECURITY_PROTOCOL_SASL STRING - SASL_SSL O describes SASL_SSL kafka security Protocol
OCNADD_KAFKA_SECURITY_PROTOCOL_SSL STRING - SSL O describes SSL kafka security Protocol
OCNADD_KAFKA_SASL_MECHANISM STRING - PLAIN O describes SASL SCRAM mechanism
OCNADD_KAFKA_SASL_JAAS_USERNAME STRING - ocnadd O kafka default jaas username present
OCNADD_KAFKA_SASL_JAAS_MODULE STRING - org.apache.kafka.common.security.plain.PlainLoginModule O kafka Login module
OCNADD_KAFKA_JAAS_SECRET_KEY STRING - jaas_password O jaas password for kafka authentication taken from the jaas-secret with this key
OCNADD_KAFKA_JASS_SECRET_NAME STRING - jaas-secret O jaas-secret name
CORRELATION_LOG_LEVEL_KAFKA STRING [ON,OFF] OFF O Kafka Streams Log Level
OCNADD_CORRELATION_LOG_ROOT STRING - WARN O root log level
OCNADD_CORRELATION_LOG_NETTY STRING - INFO O netty log level
KAFKASTREAMS_PUNCTUATOR_TIMER INTEGER - 2000 O Kafka Stream Scheduler Timer to loop through the Local cache for Timer Expiry Scenario

Environmental variables for Diameter Correlation service are declared under "ocnaddadminsvc.diametercorrelation.env" section

(Note: The Kafka parameters for Diameter correlation are same as explained in the ocnaddadminsvc.correlation.env)

diametercorrelation.resources.limits.cpu INTEGER - 3 M Number of maximum CPUs for each Diameter Correlation instance
diametercorrelation.resources.limits.memory STRING - 64Gi M Max Memory limit for each Diameter Correlation instance
diametercorrelation.resources.limits.ephemeralstorage STRING - 800Mi M Ephemeral Storage for each Diameter Correlation instance
diametercorrelation.resources.requests.cpu INTEGER - 3 M Minimum number of CPUs required for each Diameter Correlation instance
diametercorrelation.resources.requests.memory STRING - 24Gi M minimum Memory required for each Diameter Correlation instance
diametercorrelation.resources.requests.ephemeralstorage STRING - 400Mi M minimum Ephemeral Storage required for each Diameter Correlation instance
diametercorrelation.minReplicas INTEGER - 1 M Minimum replicas of Diameter correlation service instance
diametercorrelation.maxReplicas INTEGER - 4 M Maximum replicas of Diameter correlation service instance

3.7.2 Storage Adapter Service Parameters

All the Storage Adapter Service parameters are available under ocnaddadminsvc.storageadapter section in ocnadd-mediation-custom-values.yaml file.

Table 3-9 Storage Adapter Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
resources.limits.cpu INTEGER - 3 M Number of maximum CPUs for each storage adapter instance
resources.limits.memory STRING - 64Gi M Max Memory limit for each storage adapter instance
resources.limits.ephemeralstorage STRING - 400Mi M Ephemeral Storage for each storage adapter instance
resources.requests.cpu INTEGER - 3 M Minimum number of CPUs required for each storage adapter instance
resources.requests.memory STRING - 64Gi M minimum Memory required for each storage adapter instance
resources.requests.ephemeralstorage STRING - 400Mi M minimum Ephemeral Storage required for each storage adapter instance
Environmental variables for Storage Adapter service are declared under "ocnaddadminsvc.storageadapter.env" section
OCNADD_STORAGE_ADAPTER_HTTP2_ENABLED BOOLEAN [true,false] true M The flag to indicate if HTTP2 should be used or not. Default is true
KAFKA_SOCKET_BYTES_BUFFER INTEGER - 104857 O Kafka Socket Buffer setting for consumer
STORAGE_ADAPTER_KAFKA_FETCH_MIN_BYTES INTEGER - 1 O The minimum amount of data per-partition the server will return
STORAGE_ADAPTER_KAFKA_MAX_PARTITION_FETCH_BYTES INTEGER - 104858 O The maximum amount of data per-partition the server will return.
STORAGE_ADAPTER_KAFKA_FETCH_MAX_WAIT_MS INTEGER - 100 O The maximum amount of time the server will block before answering the fetch request if there isn’t sufficient data to immediately satisfy the requirement given by fetch.min.bytes
STORAGE_ADAPTER_KAFKA_SESSION_TIME_OUT INTEGER - 90000 O The timeout used to detect client failures when using Kafka’s group management facility.
STORAGE_ADAPTER_KAFKA_HEARTBEAT_INTERVAL_MS INTEGER - 30000 O The expected time between heartbeats to the consumer coordinator when using Kafka’s group management facilities
STORAGE_ADAPTER_KAFKA_MAX_POLL_INTERVAL_MS INTEGER - 240000 O The maximum delay between invocations of poll() when using consumer group management
STORAGE_ADAPTER_KAFKA_MAX_POLL_RECORDS INTEGER - 900 O The maximum number of records returned in a single call to poll()
STORAGE_ADAPTER_KAFKA_OFFSET_CONFIG STRING - latest O default kafka data stream offset config
STORAGE_ADAPTER_KAFKA_NUM_THREADS_CONFIG INTEGER - 6 O this property is used to configure the number of threads or consumers that Kafka Streams or Kafka consumers will use for processing messages
PRODUCERS_ACKNOWLEDGMENTS INTEGER - 0 O producer acknowledgments
STORAGE_ADAPTER_KAFKA_CONSUMER_POLL_MS INTEGER - 50 O Polling time in ms for consumer
KAFKA_BATCH_SIZE INTEGER - 75000 O The maximum amount of data to be collected before sending the batch.
STORAGE_ADAPTER_LOG_LEVEL_KAFKA STRING - OFF O Kafka log level
OCNADD_STORAGE_ADAPTER_LOG_ROOT STRING - WARN O root log level
OCNADD_STORAGE_ADAPTER_LOG_NETTY STRING - INFO O netty log level
OCNADD_INTERNAL_CLIENT_SSL_PROTOCOL STRING - TLS O The secure protocol used between Storage adapter and internal DD services for the HTTP communication
OCNADD_INTERNAL_CLIENT_SSL_PROTOCOLS STRING - TLSv1.2,TLSv1.3 O The TLS version supported by HTTP client in the storage adapter service
OCNADD_INTERNAL_CLIENT_SSL_HANDSHAKE_TIMEOUT STRING - 30s O The SSL handshake timeout value in the HTTP client used in the storage adapter service
STORAGE_ADAPTER_METRICS_ENABLED BOOLEAN true/false false O Parameter to enable the metrics pegging for the storage adapter, defaule is false
STORAGE_ADAPTER_EVENT_ENABLED BOOLEAN true/false true O Parameter to enable the events on the storage adapter, default is true
EVENT_DELETE_BATCH_SIZE INTEGER - 5000 O The size of the event list that can be deleted by storage adapter, default is 5000

3.7.3 Ingress Adapter Service Parameters

All the Ingress adapter service parameters are available under ocnaddadminsvc.ingressadapter section in ocnadd-mediation-custom-values.yaml file of current release.

Table 3-10 Ingress Adapter Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
resources.limits.cpu INTEGER - 3 M Number of maximum CPUs for each ingress adapter instance
resources.limits.memory STRING - 64Gi M Max Memory limit for each ingress adapter instance
resources.limits.ephemeralstorage STRING - 400Mi M Ephemeral Storage for each ingress adapter instance
resources.requests.cpu INTEGER - 3 M Minimum number of CPUs required for each ingress adapter instance
resources.requests.memory STRING - 64Gi M minimum Memory required for each ingress adapter instance
resources.requests.ephemeralstorage STRING - 400Mi M minimum Ephemeral Storage required for each ingress adapter instance
Environmental variables for Ingress Adapter service are declared under "ocnaddadminsvc.ingressadapter.env" section
INGRESS_ADAPTER_LOG_LEVEL_ROOT STRING - OFF O Kafka log level
INGRESS_ADAPTER_NETTY_LOG_LEVEL STRING - WARN O root log level
INGRESS_ADAPTER_LOG_LEVEL_KAFKA STRING - INFO O netty log level
INGRESS_ADAPTER_KEYSTORE_TYPE STRING - PKCS12 M trust store client key Type
INGRESS_ADAPTER_TRUSTSTORE_TYPE STRING - PKCS12 M trust store key Type
INGRESS_HTTPSERVER_ROUTE_PATH STRING - /ocnadd-nonoraclenf/v1/streaming M The URL at which the client should stream the data towards ingress adapter
INGRESS_HTTPSERVER_READ_TIMEOUT_MS INTEGER - 30000 O The ingress adapter read timeout in milisec
INGRESS_HTTPSERVER_REQUEST_TIMEOUT_MS INTEGER - 30000 O The ingress adapter request timeout in milisec
INGRESS_HTTPSERVER_CONNECT_TIMEOUT_MS INTEGER - 60000 O The ingress adapter connect timeout in milisec
INGRESS_HTTPSERVER_IDLE_TIMEOUT_MS INTEGER - 120000 O The ingress adapter idle timeout in milisec
INGRESS_HTTPSERVER_SOCKET_RECEIVE_BUF INTEGER - 10485 O The socket receive buffer size
INGRESS_HTTPSERVER_SOCKET_RECEIVE_BUF_PORTION INTEGER - 100 O The socket receive buffer size multiple factor. the actual read buffer bytes will be ( INGRESS_HTTPSERVER_SOCKET_RECEIVE_BUF * INGRESS_HTTPSERVER_SOCKET_RECEIVE_BUF_PORTION)
INGRESS_HTTPSERVER_SOCKET_TIMEOUT_MS INTEGER - 60000 O The ingress adapter socket timeout in milisec
INGRESS_HTTPSERVER_SOCKET_KEEPALIVE BOOLEAN [true,false] true O The flag to indicate if keepalive should be used in the connection
INGRESS_HTTPSERVER_CLOSE_NOTIFY_FLUSH_TIIMEOUT_MS INTEGER - 30000 O Notification flush timeout in milisec
INGRESS_HTTPSERVER_CLOSE_NOTIFY_READ_TIIMEOUT_MS INTEGER - 30000 O Notification read timeout in milisec
INGRESS_HTTPSERVER_SSL_HANDSHAKE_TIMEOUT_MS INTEGER - 30000 O SSL handshake timeout in milisec
KAFKA_SECURITY_PROTOCOL STRING - PLAINTEXT O describes kafka security Protocol
INGRESS_ADAPTER_SECURITY_PROTOCOL STRING - SSL O describes ingress adapter security Protocol
KAFKA_SSL_PROTOCOL STRING - TLSv1.2 O SSL Protocol version
KAFKA_SASL_ENABLED BOOLEAN [true,false] false O The flag to indicate if SASL is used for the authentication
KAFKA_JAAS_CONFIG_MODULE STRING - org.apache.kafka.common.security.plain.PlainLoginModule O kafka Login module
KAFKA_JAAS_CONFIG_USER STRING - username O kafka default jaas username present
KAFKA_JAAS_CONFIG_PASS STRING - secret O kafka default jaas password present
KAFKA_SASL_MECHANISM STRING - PLAIN O describes SASL SCRAM mechanism
externalAccess.enabled BOOLEAN [true,false] false O The flag to indicate if external access is enabled for the ingress adapter
externalAccess.staticLoadBalancerIp STRING - 10.10.10.1 O Default static loadbalancer IP address

3.8 Kafka Configuration Parameters

Applicable to both Relay Agent and Mediation Kafka Clusters.

Table 3-11 Kafka Configuration Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/ Optional(O)/ Conditional(C) Description
kafkaBroker.kafkaProperties.logdirs String - /kafka/logdir/kafka-logs M The path to store the kafka logs
kafkaBroker.replicas Int   4   The number of replicas that should be available for the pod.
kafkaBroker.pvcClaimSize String   10Gi M Size of Block Volume to attach to kafka.
target.averageCpuUtilPercentage Int   50   The target average CPU utilization percentage.
target.memoryUtilPercentage Int   80   The target average memory utilization percentage.
kafkaBroker.resource.limits.cpu Int   5   The maximum limit for the number of CPUs used for the container.
kafkaBroker.resource.limits.memory String   24Gi   The maximum limit for the size of the memory used for the container.
kafkaBroker.kafkaProperties.logRetentionMinutes Int   5 M Log Retention Time of Topic Data in Minutes.
kafkaBroker.kafkaProperties.logCleanerDeleteRetentionMs String   2340000 M The amount of time to retain tombstone message markers for log compacted topics.
kafkaBroker.kafkaProperties.kafkaSslProtocol String   TLSv1.2,TLSv1.3 M TLS version supported.
kafkaBroker.kafkaProperties.socketSendBufferBytes Int   10485760 M TCP socket buffer sizes for the producer.
kafkaBroker.kafkaProperties.socketReceiveBufferBytes Int   10485760 M TCP socket buffer sizes for the consumer.
kafkaBroker.kafkaProperties.socketRequestMaxBytes Int   104857600 M The maximum number of bytes in a socket request.
kafkaBroker.kafkaProperties.queuedMaxRequests Int   4096 M Number of concurrent connections.
kafkaBroker.kafkaProperties.numIoThreads Int   820 M Number of threads that pick up requests from the request queue to process them.
kafkaBroker.kafkaProperties.numNetworkThreads Int   820 M Network threads handle requests to the Kafka cluster, such as produce and fetch requests from client applications.
kafkaBroker.kafkaProperties.numReplicaFetchers Int   640 M Number of fetcher threads used to replicate records from each source broker.
kafkaBroker.kafkaProperties.backgroundThreads Int   256 M The number of threads to use for various background processing tasks.
kafkaBroker.kafkaProperties.replicaFetchMinBytes Int   619200 M Minimum bytes expected for each fetch response.
kafkaBroker.kafkaProperties.replicaFetchMaxBytes Int   37152000 M The maximum number of bytes we will return for a fetch request.
kafkaBroker.kafkaProperties.replicaFetchWaitMaxMs Int   500 M The maximum wait time for each fetcher request issued by follower replicas.
kafkaBroker.kafkaProperties.replicaSocketReceiveBufferBytes Int   10485760 M The socket receive buffer for network requests.
kafkaBroker.kafkaProperties.offsetsTopicReplicationFactor Int   3 M The replication factor for the offsets topic (set higher to ensure availability). Internal topic creation will fail until the cluster size meets this replication factor requirement.
kafkaBroker.kafkaProperties.transactionStateLogReplicationFactor Int   3 M The replication factor for the transaction topic (set higher to ensure availability). Internal topic creation will fail until the cluster size meets this replication factor requirement.
kafkaBroker.externalAccess.enabled Boolean   false M Flag to enable External access for Kafka.
kafkaBroker.externalAccess.autoDiscovery Boolean   false M Flag to enable auto-discovery of LoadBalancer IPs.
kafkaBroker.externalAccess.type String   LoadBalancer M Service Type of Kafka Broker.
kafkaBroker.externalAccess.setstaticLoadBalancerIps Boolean   false M Setting Static LoadBalancer IPs.
kafkaBroker.externalAccess.LoadBalancerIPList List   [ ] C List if LoadBalancer Static IP available for use.
kafkaBroker.kafkaProperties.ramDriveStorage Boolean true/false

Relay Agent Kafka: true

Mediation Kafka: false

 C

The property is used to enable the RAM based storage for the Kafka cluster in the worker group. When enabled the messages in the Kafka topic will be stored inside the RAM and a very minumum retention will be available. The default value is false.

By Default, the Relay Agent Kafka cluster will use RAM drive as storage where as Mediation Kafka cluster will be CEPH based persistence storage

3.9 UI Router Parameters

Listed below are the UI Router Parameters:

Table 3-12 UI Router Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
DD_UIAPI STRING - http://ocnaddgui:80 M The target endpoint of ocnaddgui service and use to configure the GUI.
groupNamePromIpConfig OBJECT - - M List of all the OCNADD group names and their corresponding prometheus IPs to route the GUI request and forward the response
compartmentId STRING - ocid.compartment.oc1.xxxxx C Compartment ID required on OCI
disk_namespace_oci STRING - oci_computeagent C Disk namespace required on OCI
namespace_oci STRING - ocnaddgui_oci_metrics C The OCI namespace
DD_PROMETHEUS_PATH STRING   /cluster_name/prometheus/api/v1/query_range M The Prometheus endpoint API URL path. The update for cluster name will be automatically managed by the application. User do not need to modify this parameter.
resources.limits.cpu INTEGER - 1 M Number of maximum CPUs for each UI router service instance
resources.limits.memory STRING - 1Gi M Max Memory limit for each UI router service instance
resources.limits.ephemeralstorage STRING - 500Mi M Ephemeral Storage for each UI router service
resources.requests.cpu INTEGER - 1 M Minimum number of CPUs required for each UI router service instance
resources.requests.memory STRING - 1Gi M Minimum Memory required for each UI router instance
resources.requests.ephemeralstorage STRING - 100Mi M Minimum Ephemeral Storage required for each UI router instance

3.10 Filter Service Parameters

Filter Service Parameters are present under ocnaddfilter section in ocnadd-mediation-custom-values.yaml file of current release.

Table 3-13 Filter Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
minReplicas INTEGER - 1 M minimum number of Replicas of Filter Service
maxReplicas INTEGER - 3 M maximum number of Replicas of Filter Service
resources.limits.cpu INTEGER - 2 M Number of maximum CPUs for each Filter service instance
resources.limits.memory String - 3Gi M Max Memory limit for each Filter service instance
resources.limits.ephemeralstorage String - 800Mi M Ephemeral Storage for each Filter service instance
resources.requests.cpu INTEGER - 2 M Minimum number of CPUs required for each Filter service instance
resources.requests.memory String - 3Gi M minimum Memory required for each Filter service instance
resources.requests.ephemeralstorage String - 500Mi M minimum Ephemeral Storage required for each Filter service instance
Environmental variables are present under section "ocnaddfilter.env"
ENABLE_FILTER_METRICS BOOLEAN [true/false] true O To enable/disable filter metrics, default is true
OCNADD_KAFKA_SSL_PROTOCOL STRING - TLSv1.3 O kafka SSL protocol version
KAFKA_PRODUCER_SSL_CLIENT_AUTH BOOLEAN [true/false] false O whether kafka producer client auth is required or not
KAFKA_MAX_AGE_CONFIG INTEGER - 7500 O The period of time in milliseconds after which we force a refresh of metadata.
KAFKA_FETCH_MIN_BYTES INTEGER - 1 O The minimum amount of data per-partition the server will return
KAFKA_FETCH_MAX_BYTES STRING - 57672000 O The maximum amount of data per-partition the server will return
KAFKA_MAX_PARTITIONS_FETCH_BYTES STRING - 1048580 O The maximum amount of data per-partition the server will return.
FETCH_MAX_WAIT_MS INTEGER - 100 O The maximum amount of time the server will block before answering the fetch request if there isn’t sufficient data to immediately satisfy the requirement given by fetch.min.bytes
SESSION_TIME_OUT INTEGER - 15000 O The timeout used to detect client failures when using Kafka’s group management facility.
HEARTBEAT_INTERVAL_MS INTEGER - 5000 O The expected time between heartbeats to the consumer coordinator when using Kafka’s group management facilities
MAX_POLL_INTERVAL_MS INTEGER - 240000 O The maximum delay between invocations of poll() when using consumer group management
MAX_POLL_RECORDS INTEGER - 1500 O The maximum number of records returned in a single call to poll()
CONSUMER_POLL_MS INTEGER - 50 O Polling time in ms for consumer
PRODUCERS_ACKNOWLEDGMENTS INTEGER - 1 O The number of acknowledgments the producer requires the leader to have received before considering a request complete
BATCH_SIZE INTEGER - 130000 O The maximum amount of data to be collected before sending the batch.
LINGER_MS INTEGER - 2 O The time to wait before sending messages out to Kafka
REQUEST_TIMEOUT_MS INTEGER - 1000 O The configuration controls the maximum amount of time the client will wait for the response of a request
TRANSACTION_FILTER BOOLEAN [true/false] true O To enable or disable transaction filtering
KAFKA_SOCKET_BYTES_BUFFER STRING - 1048570 O Kafka Socket Buffer setting for consumer
FILTER_KAFKA_PARTITIONER_STRATEGY STRING [key/custom/roundrobin] key O Kafka record partitioner strategy
OCNADD_FILTER_KAFKA_TOPIC_INITIAL_DELAY STRING - 10s O The parameter denotes the initial delay in checking for the Kafka topic existence, default is 10sec
OCNADD_FILTER_KAFKA_TOPIC_RETRY_THRESHOLD STRING - 20s O The parameter denotes the retry interval for checking the Kafka topic existence, default is 20sec
OCNADD_CONFIG_RETRY_COUNT INTEGER - 3 O The number of retries for the communication towards the configuration service in case of failure, default is 3
OCNADD_CONFIG_RETRY_DELAY_MS INTEGER - 5000 O The retry interval for the communication towards the configuration service in case of failure, default is 5ms
KAFKA_DESCRIBE_TOPIC_TIMEOUT_MS INTEGER - 10000 O The timeout for the request to get the Kafka describe topic output from Kafka cluster, default is 10ms
OCNADD_FILTER_HEALTH_SVC_TYPE STRING - FILTER_SERVICE M The type with which filter service registers with the health monitoring service
OCNADD_FILTER_HEALTH_HB_TIMER INTEGER - 10000 M The heartbeat timer on the filter service to exchange the heartbeat with the health monitoring service, default is 10sec
OCNADD_FILTER_HEALTH_RETRY_COUNT INTEGER - 1 M The number of retries with the healt monitoring service for the registration of filter service health profile, default is 1
OCNADD_FILTER_HEALTH_RETRY_DELAY INTEGER - 2 M The retry delay between two consecutive retries for the health profile registration of filter service, default is 2sec
OCNADD_FILTER_MAX_REPLICA INTEGER - 1 M The number of maximum replicas, the health service instance reports to the health service during health profile registration.
OCNADD_KAFKA_SSL_PROTOCOL STRING - TLSv1.3 O SSL Protocol version
OCNADD_KAFKA_SECURITY_PROTOCOL_SSL STRING - SSL O The Kafka security protocol for the filter service for SSL connection with Kafka

3.11 Redundancy Agent Service Parameters

Table 3-14 Redundancy Agent Service Parameter

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
autoScaling.enabled BOOLEAN true/false false M Allow HorizontalAutoScalar of ocnaddredundancy pods.
minReplicas INTEGER - 1 C Number of minimum replicas for HPA.
maxReplicas INTEGER - 1 C Number of maximum replicas for HPA.
resources.limit.cpu INTEGER - 2 M Maximum number of CPU for each pod.
resources.limits.memory STRING   1Gi M Maximum memory limit for each service instance.
resources.limits.ephemeralstorage STRING   500Mi M Ephemeral storage for each service instance.
resources.requests.cpu INTEGER   2 M Minimum number of CPUs required for each service instance.
resources.requests.memory STRING   1Gi M Minimum memory required for each service instance.
resources.requests.ephemeralstorage STRING   500Mi M Minimum ephemeral storage required for each service instance.
resources.target.averageCpuUtilsPercentage INTEGER - 85 C Threshold set for Pod AutoScalar.
Environmental variables are present under section ocnaddredundancyagent.env
OCNADD_REDUNDANCY_HB_INTERVAL INTEGER - 10 O Interval of heartbeat requests sent to primary agent by secondary agent.
OCNADD_REDUNDANCY_HB_MISSING INTEGER   3 O Max unsuccessful heartbeat in case of secondary agent or max missing heartbeat in case of primary agent.
OCNADD_REDUNDANCY_KAFKA_DELAY_MS INTEGER   2000 O Delay before starting periodic Kafka ingress traffic rate.
OCNADD_REDUNDANCY_KAFKA_INTERVAL_MS INTEGER   500 O Interval of periodic Kafka ingress traffic check, will switch mode of secondary agent if change is required during the check.
OCNADD_REDUNDANCY_HEALTH_RETRY_COUNT INTEGER   10 O Number of retries for Health registration.
OCNADD_REDUNDANCY_HEALTH_RETRY_DELAY INTEGER   15 O Delay between each retries for Health Registration.
OCNADD_REDUNDANCY_HEALTH_HB_TIMER INTEGER   120000 O Heart Beat Timer interval to health monitoring service.
OCNADD_REDUNDANCY_HEALTH_SVC_TYPE STRING   REDUNDANCY O Health Registration name for REDUNDANCY agent.

3.12 Export Service Parameters

Table 3-15 Export Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
autoScaling.enabled BOOLEAN true/false true M Allow HorizontalAutoScalar of ocnaddexport service pods.
minReplicas INTEGER - 1 C Number of minimum replicas for HPA.
maxReplicas INTEGER - 2 C Number of maximum replicas for HPA.
resources.limit.cpu INTEGER - 6 M Max number of cpu for each pod.
resources.limits.memory STRING - 24Gi M Max memory limit for each service instance.
resources.limits.ephemeralstorage STRING - 2Gi M Ephemeral storage for each service instance.
resources.requests.cpu INTEGER - 4 M Minimum number of CPUs required for each service instance.
resources.requests.memory STRING - 4Gi M Minimum memory required for each service instance.
resources.requests.ephemeralstorage STRING - 100Mi M Minimum ephemeral storage required for each service instance.
Environmental variables are present under section ocnaddexport.env
EXPORT_BLOCKINGQUEUE_SIZE INTEGER - 10 O The queue size to store the result set from the database for the export.
EXPORT_SEQUENCING BOOLEAN true,false true O The parameter to decide if the result set needs to be in sequence based on the record timestamp or not.

3.13 Helm Parameter Configuration for OCCM

Table 3-16 Helm Parameter Configuration for OCCM

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
global.certificates.occm.enabled BOOLEAN true/false false M Whether to use OCCM for creating services.
global.certificates.occm.issuer STRING - CA1 M Name of the Issuer configured in OCCM to use to create certificate
global.certificates.occm.renewBefore INTEGER - 14 M Number of days before expiry,before which OCCM will automatically update the certificates
global.certificates.occm.days INTEGER - 90 M Number of days for which certificates will be valid
global.certificates.occm.cncc.cncc_iam_ingress_gateway.external_ip STRING - - M Load balancer IP address of CNCC IAM Ingress Gateway Service
global.certificates.occm.cncc.cncc_iam_ingress_gateway.port INTEGER - 80 M Port of CNCC IAM Ingress Gateway Service
global.certificates.occm.cncc.cncc_mcore_ingress_gateway.external_ip STRING - - M Load balancer IP address of CNCC MCORE Ingress Gateway Service
global.certificates.occm.cncc.cncc_mcore_ingress_gateway.port INTEGER - 80 M Port of CNCC MCORE Ingress Gateway Service
global.certificates.occm.cncc.cnccId STRING - Cluster1 M ID of CNCC owner of OCCM instance
global.certificates.occm.cncc.occm_cncc_instance_id STRING - Cluster1-occm-instance1 M OCCM instance id
global.certificates.occm.subject.country STRING - - M Specify the country field (C) in DN for each certificate
global.certificates.occm.subject.state STRING - - M Specify the state field (S) in DN for each certificate
global.certificates.occm.subject.location STRING - - M Specify the location field (L) in DN for each certificate
global.certificates.occm.subject.organization STRING - - M Specify the organization field (O) in DN for each certificate
global.certificates.occm.subject.country.organizationUnit STRING - - M Specify the organization unit field (OU) in DN for each certificate
global.certificates.occm.occm_cacert STRING - occm-ca-secret O Name of the Secret storing CA certificate/certificate chain.
global.certificates.occm.truststore_keystore_secret STRING - occm-truststore-keystore-secret O Name of the Secret storing truststore and keystore key
global.certificates.occm.occm_secret STRING - occm-secret O Name of the Secret storing CNCC user credentials
global.certificates.occm.volumes.json STRING - /occm-request O Mount path of the JSONs used when sending request to OCCM
global.certificates.occm.volumes.script STRING - /occm-script O Mount path of the script used to send request to OCCM
global.certificates.occm.keyAlgorithm STRING RSA/EC RSA C Select OCCM key algorithm, RSA for RSA based key generation and EC for ECDSA based key generation
global.certificates.occm.keySize STRING KEYSIZE_2048/KEYSIZE_4096 KEYSIZE_2048 C Defines the keySize of RSA based key generation
global.certificates.occm.ecCurve STRING SECP384r1/SECP256r1 SECP384r1 C Define the curve parameter when keyAlgorithm select is EC
global.ocnaddmanagement.certificates.occm.san.redundancy_agent.update_required BOOLEAN true/false false C If update of SAN field for Redundancy Agent certificates is required. Should be enabled post-installation when two site redundancy is enabled.
global.ocnaddmanagement.certificates.occm.san.redundancy_agent.ips LIST[STRING] - ["10.10.10.10"] C IPs to add in SAN for Redundancy Agent certificate. Provide the Load balancer IP during installation if static IP for loadbalancer is chosen
global.ocnaddmanagement.certificates.occm.san.redundancy_agent.uuid.server STRING - - C UUID of existing Redundancy Agent certificate with names prefixed by REDUNDANCYAGENT-SECRET-SERVER
global.ocnaddmanagement.certificates.occm.san.management_gateway.update_required BOOLEAN true/false false C If update of SAN field for Management Gateway certificates is required.
global.ocnaddmanagement.certificates.occm.san.management_gateway.ips LIST[STRING] - ["10.10.10.10"] C IPs to add in SAN for Management Gateway certificate. Provide the Load balancer IP during installation if static IP for loadbalancer is chosen
global.ocnaddmanagement.certificates.occm.san.management_gateway.uuid.server STRING - - C UUID of existing Management Gateway certificate with names prefixed by MANAGEMENTGATEWAY-SECRET-SERVER
global.ocnaddrelayagent.certificates.occm.san.kafka.update_required BOOLEAN true/false false C If update of SAN field for Relay agent Kafka certificates is required. Should be enabled post-installation when external access of Kafka is required.
global.ocnaddrelayagent.certificates.occm.san.kafka.ips LIST[STRING] - ["10.10.10.10", "10.10.10.11", "10.10.10.12"] C IPs to add in SAN for Relay agent Kafka certificate. Provide the Load balancer IPs during installation if static IPs for loadbalancer are chosen
global.ocnaddrelayagent.certificates.occm.san.kafka.uuid.server STRING - - C UUID of existing Relay agent Kafka broker certificate with names prefixed by KAFKABROKER-SECRET-SERVER
global.ocnaddrelayagent.certificates.occm.san.relay_gateway.update_required BOOLEAN true/false false C If update of SAN field for Relay Agent Gateway certificates is required.
global.ocnaddrelayagent.certificates.occm.san.relay_gateway.ips LIST[STRING] - ["10.10.10.10"] C IPs to add in SAN for Relay Agent Gateway certificate. Provide the Load balancer IP during installation if static IP for loadbalancer is chosen
global.ocnaddrelayagent.certificates.occm.san.relay_gateway.uuid.server STRING - - C UUID of existing Relay Agent Gateway certificate with names prefixed by RELAYAGENTGATEWAY-SECRET-SERVER
global.ocnaddrelayagent.certificates.occm.san.vcollector.enabled BOOLEAN true/false false C Enable this property when vCollector is enabled
global.ocnaddrelayagent.certificates.occm.san.vcollector.update_required BOOLEAN true/false false C If update of SAN field for vCollector certificates is required.
global.ocnaddrelayagent.certificates.occm.san.vcollector.ips LIST[STRING] - ["10.10.10.10"] C IPs to add in SAN for vCollector certificate. Provide the Load balancer IP during installation if static IP for loadbalancer is chosen
global.ocnaddrelayagent.certificates.occm.san.vcollector.uuid.server STRING - - C UUID of existing vCollector certificate with names prefixed by VCOLLECTOR-SECRET-SERVER
global.ocnaddmediation.certificates.occm.san.kafka.update_required BOOLEAN true/false false C If update of SAN field for Mediation Kafka certificates is required. Should be enabled post-installation when external access of Kafka is required.
global.ocnaddmediation.certificates.occm.san.kafka.ips LIST[STRING] - ["10.10.10.10", "10.10.10.11", "10.10.10.12"] C IPs to add in SAN for Mediation Kafka certificate. Provide the Load balancer IPs during installation if static IPs for loadbalancer are chosen
global.ocnaddmediation.certificates.occm.san.kafka.uuid.server STRING - - C UUID of existing Mediation Kafka broker certificate with names prefixed by KAFKABROKER-SECRET-SERVER
global.ocnaddmediation.certificates.occm.san.ingress_adapter.update_required BOOLEAN true/false false C If update of SAN field for Ingress Adapter certificates is required. Should be enabled post-installation when external access to Ingress Adapter/s is needed.
global.ocnaddmediation.certificates.occm.san.ingress_adapter.ips LIST[STRING] - ["10.10.10.10"] C IPs to add in SAN for Ingress Adapter certificate
global.ocnaddmediation.certificates.occm.san.ingress_adapter.uuid.server STRING - - C UUID of existing Ingress Adapter certificate with names prefixed by INGRESSADAPTER-SECRET-SERVER
global.ocnaddmediation.certificates.occm.san.mediation_gateway.update_required BOOLEAN true/false false C If update of SAN field for Mediation Gateway certificates is required.
global.ocnaddmediation.certificates.occm.san.mediation_gateway.ips LIST[STRING] - ["10.10.10.10"] C IPs to add in SAN for Mediation Gateway certificate. Provide the Load balancer IP during installation if static IP for loadbalancer is chosen
global.ocnaddmediation.certificates.occm.san.mediation_gateway.uuid.server STRING - - C UUID of existing Mediation Gateway certificate with names prefixed by MEDIATIONGATEWAY-SECRET-SERVER

3.14 Helm Parameter Configuration for Network Policy

Table 3-17 Helm Parameter Configuration for OCCM

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ocnaddmanagement.network.policy.enable BOOLEAN true/false false M Network Policy enable for intercommunication of OCNADD Management Group services
ocnaddmanagement.network.ingress.denyall BOOLEAN true/false true C Deny all other ingress traffic
ocnaddmanagement.network.ingress.alarm BOOLEAN true/false true C Allow ingress traffic for alarm service
ocnaddmanagement.network.ingress.config BOOLEAN true/false true C Allow ingress traffic for configuration service
ocnaddmanagement.network.ingress.health BOOLEAN true/false true C Allow ingress traffic for health monitoring service
ocnaddmanagement.network.ingress.agent BOOLEAN true/false true C Allow ingress traffic for Redundancy Agent service
ocnaddmanagement.network.ingress.export BOOLEAN true/false true C Allow ingress traffic for Export service
ocnaddmanagement.network.ingress.gateway BOOLEAN true/false true C Allow ingress traffic for Management Gateway service
ocnaddmanagement.network.ingress.namespaces.ocnaddgroups OBJECT NA

- ocnadd-relay

- ocnadd-mediation

 C Network communication between allowed namespaces
ocnaddmanagement.network.ingress.namespaces.infra OBJECT NA - occne-infra C Network communication between allowed Infra namespaces
ocnaddmanagement.network.ingress.external.enable BOOLEAN true/false false C Allow external network connections from configured IPs/CIDRs/Network
ocnaddmanagement.network.ingress.external.cidrs OBJECT NA - C CIDRs for network communication
         
ocnaddrelayagent.network.policy.enable BOOLEAN true/false false M Network Policy enable for intercommunication of OCNADD Relay Agent Group services
ocnaddrelayagent.network.ingress.denyall BOOLEAN true/false true C Deny all other ingress traffic
ocnaddrelayagent.network.ingress.aggregation BOOLEAN true/false true C Allow ingress traffic for aggregation service
ocnaddrelayagent.network.ingress.diameteraggregation BOOLEAN true/false true C Allow ingress traffic for diameteraggregation service
ocnaddrelayagent.network.ingress.kafka BOOLEAN true/false true C Allow ingress traffic for Kafka service
ocnaddrelayagent.network.ingress.gateway BOOLEAN true/false true C Allow ingress traffic for Gateway service
ocnaddrelayagent.network.ingress.namespaces.infra OBJECT NA - occne-infra C Network communication between allowed Infra namespaces
ocnaddrelayagent.network.ingress.external.enable BOOLEAN true/false false C Allow external network connections from configured IPs/CIDRs/Network
ocnaddrelayagent.network.ingress.external.cidrs OBJECT NA - C CIDRs for network communication
         
ocnaddmediation.network.policy.enable BOOLEAN true/false false M Network Policy enable for intercommunication of OCNADD Mediation Group services
ocnaddmediation.network.ingress.denyall BOOLEAN true/false true C Deny all other ingress traffic
ocnaddmediation.network.ingress.adapter BOOLEAN true/false true C Allow ingress traffic for adapter service
ocnaddmediation.network.ingress.admin BOOLEAN true/false true C Allow ingress traffic for admin service
ocnaddmediation.network.ingress.correlation BOOLEAN true/false true C Allow ingress traffic for correlation service
ocnaddmediation.network.ingress.diametercorrelation BOOLEAN true/false true C Allow ingress traffic for diametercorrelation service
ocnaddmediation.network.ingress.filter BOOLEAN true/false true C Allow ingress traffic for filter service
ocnaddmediation.network.ingress.kafka BOOLEAN true/false true C Allow ingress traffic for Kafka service
ocnaddmediation.network.ingress.gateway BOOLEAN true/false true C Allow ingress traffic for gateway service
ocnaddmediation.network.ingress.ingressadapter BOOLEAN true/false true C Allow ingress traffic for ingress adapter service
ocnaddmediation.network.ingress.storageAdapter BOOLEAN true/false true C Allow ingress traffic for storage adapter service
ocnaddmediation.network.ingress.namespaces.infra OBJECT NA - occne-infra C Network communication between allowed Infra namespaces
ocnaddmediation.network.ingress.external.enable BOOLEAN true/false false C Allow external network connections from configured IPs/CIDRs/Network
ocnaddmediation.network.ingress.external.cidrs OBJECT NA - C CIDRs for network communication

3.15 cnDBTier Customization Parameters

The Data Director uses cnDBTier as an independent database for the geo-redundant sites. Therefore, by default, the ocnadd_dbtier_custom_values.yaml provided with the OCNADD installation is for a single-site deployment of cnDBTier.

Single-site cnDBTier deployment mode: The georeplication is unavailable. Users must continue taking DB backups periodically, preferably on a daily basis, so that the same can be used when fault recovery scenarios arise. Refer to the section Fault Recovery for the backup options in the Data Director.

For information about the values of the following parameters, see the ocnadd_dbtier_custom_values_25.2.200.yaml file.

  • Any change in the cnDBTier custom_values file introduced by the cnDBTier patch must be updated in the custom_values file provided by OCNADD before deployment.
  • For detailed information on the cnDBTier resources, see the section DB Profile in the Oracle Communications Network Analytics Data Director Benchmarking Guide. The resources in the ocnadd_dbtier_custom_values_25.2.200.yaml should match the planning guide; if not, update them according to the planning guide.

The following table lists the customized cnDBTier parameters for OCNADD

Table 3-18 cnDBTier Customization Parameters

Parameter Description Version
global.repository The value should be updated to point to the actual path of your docker registry respectively, for example occne-repo-host:5000/occne 24.3.0
global.sitename This parameter must be set to the name of current cluster 24.3.0
global.domain Set it to the name of Kubernetes cluster on which cnDbTier is installed, for example occne1-cgbu-cne-dbtier. 24.3.0
global.namespace The Kubernetes namespace in which the cnDbTier is deployed 24.3.0
global.storageClassName

Storage class to be used.

By default occne-dbtier-sc will be the storage class it can be changed to any storage class name which is currently configured in the cluster.

 24.3.0
global.mgmReplicaCount Default value to be used as in the file 24.3.0
global.ndbReplicaCount

The default value in the ocnadd_dbtier_custom_values.yaml file to be updated as follows:

  • Should be updated to 4 when cnDBTier is planned to be used as extended storage for xDRs
  • Default value (2) to be used in the file when cnDbTier is not used as extended storage
 24.3.0
global.ndbappReplicaCount Default value (2) to be used as in the file 24.3.0
global.ndbappReplicaMaxCount

Default value (4) to be used as in the file

global.ndbappReplicaMaxCount should always be greater than global.ndbappReplicaCount

 24.3.0
global.apiReplicaCount

The default value in the ocnadd_dbtier_custom_values.yaml file to be updated as follows:

  • In case of no replication, the minimum number of SQL nodes required is 0.

 24.3.0
global.ndb.datamemory

The default value in the ocnadd_dbtier_custom_values.yaml file to be updated as follows:

  • Should be updated to 96G when cnDBTier is planned to be used as extended storage for xDRs
  • Default value (1G) to be used in the file when cnDbTier is not used as extended storage
 24.3.0
global.mgm.ndbdisksize Default value (30Gi) to be used as in the file 24.3.0
global.ndb.ndbdisksize

The default value in the ocnadd_dbtier_custom_values.yaml file to be updated as follows:

  • Should be updated to ndb.resources.limits.memory + 30Gi when cnDBTier is planned to be used as extended storage for xDRs
  • Default value (30Gi) to be used in the file when cnDbTier is not used as extended storage
 24.3.0
global.ndb.ndbbackupdisksize Default value (30Gi) to be used as in the file 24.3.0
global.api.ndbdisksize Default value (30Gi) to be used as in the file 24.3.0
global.ndbapp.ndbdisksize Default value (20Gi) to be used as in the file 24.3.0
mgm.resources.limits.cpu Default value (1) to be used as in the file 243.0
mgm.resources.limits.memory Default value (1Gi) to be used as in the file 24.3.0
mgm.resources.requests.cpu Default value (1) to be used as in the file 24.3.0
mgm.resources.requests.memory Default value (1Gi) to be used as in the file 24.3.0
ndb.resources.limits.cpu

The default value in the ocnadd_dbtier_custom_values.yaml file to be updated as follows:

  • Should be updated to 8 when cnDBTier is planned to be used as extended storage for xDRs
  • Default value (1) to be used in the file when cnDbTier is not used as extended storage
 24.3.0
ndb.resources.limits.memory

The default value in the ocnadd_dbtier_custom_values.yaml file to be updated as follows:

  • Should be updated to 128Gi when cnDBTier is planned to be used as extended storage for xDRs
  • Default value (4Gi) to be used in the file when cnDbTier is not used as extended storage
 24.3.0
ndb.resources.requests.cpu

The default value in the ocnadd_dbtier_custom_values.yaml file to be updated as follows:

  • Should be updated to 8 when cnDBTier is planned to be used as extended storage for xDRs
  • Default value (1) to be used in the file when cnDbTier is not used as extended storage
 24.3.0
ndb.resources.requests.memory

The default value in the ocnadd_dbtier_custom_values.yaml file to be updated as follows:

  • Should be updated to 128Gi when cnDBTier is planned to be used as extended storage for xDRs
  • Default value (4Gi) to be used in the file when cnDbTier is not used as extended storage
 24.3.0
api.resources.limits.cpu Default value (1) to be used as in the file 24.3.0
api.resources.limits.memory Default value (1Gi) to be used as in the file 24.3.0
api.resources.requests.cpu Default value (1) to be used as in the file 24.3.0
api.resources.requests.memory Default value (1Gi) to be used as in the file 24.3.0
api.ndbapp.resources.limits.cpu Default value (1) to be used as in the file 24.3.0
api.ndbapp.resources.limits.memory Default value (1Gi) to be used as in the file 24.3.0
api.ndbapp.resources.requests.cpu Default value (1) to be used as in the file 24.3.0
api.ndbapp.resources.requests.memory Default value (1Gi) to be used as in the file 24.3.0
db-replicationsvc.dbreplsvcdeployments.enabled Default value (false) to be used as in the file 24.3.0
db-replicationsvc.resources.limits.cpu Default value (1) to be used as in the file 24.3.0
db-replicationsvc.resources.limits.memory Default value (2048Mi) to be used as in the file 24.3.0
db-replicationsvc.resources.requests.cpu Default value (0.6) to be used as in the file 24.3.0
db-replicationsvc.resources.requests.memory Default value (1024Mi) to be used as in the file 24.3.0
db-monitor-svc.resources.limits.cpu Default value (200m) to be used as in the file 24.3.0
db-monitor-svc.resources.limits.memory Default value (500Mi) to be used as in the file 24.3.0
db-monitor-svc.resources.requests.cpu Default value (200m) to be used as in the file 24.3.0
db-monitorsvc.resources.requests.memory Default value (500Mi) to be used as in the file 24.3.0

Note:

For more information about these parameters, see Oracle Communications Cloud Native Core cnDBTier Installation, Upgrade, and Fault Recovery Guide.