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 OCNADD Deployment Models

OCNADD supports the following deployment models:
  • Model 1: All Data Director Services (Default)
  • Model 2: Kafka, Common Services, and Aggregation Services

Note:

The Data Director supports egress adapters for outbound connections. The egress adapters add value to the message feed by filtering and synthesizing the packets before sending the messages out on the egress connection type 'HTTP/2' or 'Synthetic Feed'. If the customer selects a deployment model that does not include the Egress adapter, additional features such as synthetic packet generation will not be available, although the filtering and correlation features will be available using Kafka feeds only.

The following diagram depicts the various Data Director deployment models:


Deployment models

The following table depicts the resource savings in the various deployment models:

Table 3-1 Resource Saving

Deployment Model Model 1 (All Services) Model 2 (Kafka +Aggregation)
Common Services Available Available
Aggregation Service Available Available
Adapter Service Available Not available
Kafka Available Available
Resource Saving (approx. %) 0 60
Supported Egress Interfaces HTTP/2

TCP

 Kafka

Note:

The resource saving for the default model will be more if many worker groups are going to be managed with a single management group.

Model 1: All Data Director Services (Default: Centralized)

This OCNADD deployment model includes all the services and features. This is the default model and all the services are selected by default in the ocnadd-custom-values-25.1.200.yaml file.

This profile can stream NFs (SCP, NRF, SEPP) data up to 15K MPS and can be scaled to handle up to 135K MPS for HTTP2 feed when "weighted_lb" is off.

Replication Factor should be 1 and the incoming message size on OCNADD should be less than or equal to 3500 bytes.

  • Use the GUI to configure message feeds on OCNADD.
  • The Oracle Producer NFs (SCP, SEPP and NRF) copy the messages to their respective source topics.

For this model, the user need not enable or disable any service in the ocnadd-custom-values-25.1.200.yaml. The default parameters are as below. 

global:
    ocnaddalarm:
        enabled: true
    ocnaddconfiguration:
        enabled: true
    ocnaddhealthmonitoring:
        enabled: true
    ocnaddscpaggregation:
         enabled: true
    ocnaddnrfaggregation:
         enabled: true 
    ocnaddseppaggregation:
         enabled: true
    ocnaddbsfaggregation:
         enabled: false
   ocnaddpcfaggregation:
         enabled: false
    ocnaddbackuprestore:
        enabled: true
    ocnaddkafka:
        enabled: true
    ocnaddadmin:
         enabled: true
    ocnadduirouter:
        enabled: true
    ocnaddgui:
        enabled: true
    ocnaddfilter:
        enabled: true
    ocnaddexport:
        enabled: true
   ocnaddnonracleaggregation:
        enabled: true
   ocnaddredundancyagent:
        enabled: true

Model 2: Kafka, Common Services, and Aggregation Services

Use this model when the customer does not wish to receive the message feed using HTTP/2 or TCP connection mode. The third-party monitoring application available to the customer can consume data directly from the Kafka cluster. The Egress adapter is not required in this deployment model; however, the OCNADD deployment requires common services (such as UI, Configuration, Health monitoring, Alarm, and Admin). Features like correlation-id-based load balancing, synthetic feed, and HTTP/2 feeds are unavailable in this deployment model, although the filtering and correlation features will be available using Kafka feeds only. This model saves the egress adapter resource; however, additional resources will be required for Filtering and Correlation services once these features are used in the configurations from UI.

The export feature is also available, however it has to be enabled in the charts by enabling the ocnaddexport service and further export configuration from the UI. For more information, see "Export" section in "OCNADD Features and Feature Specific Limits " chapter and "Export Configuration " section in " Configuring OCNADD" chapter in Oracle Communications Network Analytics Data Director User Guide.

This deployment model supports direct Kafka feed. For more information, see "External Kafka Feeds" section in Oracle Communications Network Analytics Data Director User Guide.

The default parameters are as below.

global:
    ocnaddalarm:
        enabled: true
    ocnaddconfiguration:
        enabled: true
    ocnaddhealthmonitoring:
        enabled: true 
    ocnaddscpaggregation:
         enabled: true
    ocnaddnrfaggregation:
         enabled: true 
    ocnaddseppaggregation:
         enabled: true
    ocnaddbsfaggregation:
         enabled: false
   ocnaddpcfaggregation:
         enabled: false 
    ocnaddbackuprestore:
        enabled: true
    ocnaddkafka:
        enabled: true
    ocnaddadmin:
        enabled: true
    ocnadduirouter:
         enabled: true
    ocnaddgui:
         enabled: true
    ocnaddfilter:
         enabled: true
    ocnaddexport:
        enabled: false
    ocnaddnonracleaggregation:
        enabled: false
    ocnaddredundancyagent:
        enabled: false
  1. The aggregation service aggregates traffic from the source topics to the Kafka main topic. Choosing any specific combination of NFs for aggregation rules is not possible. The total traffic received is aggregated and available to the consumers.
  2. The third-party consumer application must create external Kafka feeds to connect with the Kafka cluster, which will allow them to consume messages directly from the designated topic.

Note:

  1. Aggregation: The traffic will be aggregated using the configuration on Oracle Producer NFs to use the Main topic for copying messages on the OCNADD.
  2. The message feeds must be created from the GUI and aggregation rules determine the source NF combinations for aggregation.
  3. Metrics related to the feed shall be available on the GUI. The GUI can also be used to view the OCNADD alarms.

The customer can customize the OCNADD deployment based on the identified resources. Plan the resources based on the deployment model and services required for the specific model. For more information of OCNADD resources see Oracle Communications Network Analytics Data Director Benchmarking Guide.

In both models, the two-site redundancy feature can be enabled. For more information, see 'Two Site Redundancy Enable' section in the Oracle Communications Network Analytics Data Director User Guide.

3.2 Customize Configuration Parameters

Perform the following procedure to customize the ocnadd-custom-values-25.1.200.yaml files as per requirements for both parent and sub-charts.

  1. 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.
  2. Extract the OCNADD package if not already extracted, and unzip the custom-templates.zip
    1. Change the directory to custom-templates to access the parent ocnadd-custom-values-25.1.200.yaml. This file is used to customize the deployment parameters during installation.

      Change the following parameters in the ocnadd-custom-values-25.1.200.yaml and save the file:

      1. Update the repository path in global.env.repo.REPO_HOST_PORT: <customer repository path>
      2. Update the CLUSTER-INFO parameters:
        1. cluster.domainName: <customer cluster domain name>
        2. cluster.clusterName: <customer cluster name>
      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, 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.)
        • storageadapter_db: storageadapter_schema (Update the DB name as per the section Update Database Name. No change is needed if default DB names are used.)
      4. Update the cluster and cluster domain name for UI
        ocnadduirouter:
   ocnadduirouter:
       name: ocnadduirouter
       env:
           PROMETHEUS_API: http://occne-kube-prom-stack-kube-prometheus.occne-infra.ocnadd:80    ## --> update 'ocnadd' with <customer cluster domain name>
           DD_PROMETHEUS_PATH: /blurr8/prometheus/api/v1/query_range        ## --> update 'blurr8' with <customer cluster name>
      5. Change the Prometheus Monitoring Details, bases on the desired MPS profile, default threshold MPS is 100000:
         cluster.mps: 100000
      6. Update the default cluster.prometheus_url based on the cluster information:

        Default prometheus_url: http://localhost:9000/<cluster-name>/prometheus/api/v1/query_range

        Example URL( For CNE deployment and cluster name as ocnadd):

        prometheus_url: http://occne-kube-prom-stack-kube-prometheus.occne-infra.svc.ocnadd:80/ocnadd/prometheus/api/v1/query_range

      7. (Optional) Updating the OCNADD Backup Cronjob:

        Modify the below backup parameters as needed For more information on backup and restore, see "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
      8. Updating the OCNADD Kafka Deployment Mode:

        In the current release deployment by Kraft mode is the only supported mode for the Kafka Cluster, the Zookeeper mode has been obsoleted and removed.

        Modify the below global parameter for enabling the Kraft based Kafka deployment. In this case, zookeeper will not be deployed and instead of zookeeper, Kraft controller service will be deployed.

        Note:

        # Set this parameter to 'true' **only** when KRaft mode is selected during a fresh installation.
# This parameter **must remain 'false'** during a Data Director upgrade (Zookeeper mode) or migration from Zookeeper to KRaft.
# During an upgrade, if the source release was already in KRaft mode, this parameter should remain 'true'.

global.kafka.kraftEnabled: false  ## --> update this to 'true'
      9. Enable the specific aggregation service as needed. The default values are listed below. To enable a specific aggregation service, set its corresponding value to true.
        global:
    ocnaddscpaggregation:
         enabled: true
    ocnaddnrfaggregation:
         enabled: true 
    ocnaddseppaggregation:
         enabled: true
    ocnaddbsfaggregation:
         enabled: false
   ocnaddpcfaggregation:
         enabled: false
  3. Customize the rules file <chartpath>/templates/ocnadd-alerting-rules.yaml:
    • If OCNADD is to be installed in OCI setup, then remove the <chartpath>/templates/ocnadd-alerting-rules.yaml and <chartpath>/templates/ocnadd-mgmt-alerting-rules.yaml files.
    • If OCNADD is to be installed in CNE Setup, then all the services will be monitored by Prometheus By default. So there will not be any Modifications in the Helm Chart. All the Prometheus Alert Rules Present in Helm Chart will be Updated in Prometheus Server. (Here the Label Used to Update the Prometheus Server is "role: cnc-alerting-rules", which is added By Default in Helm Charts)
    • If OCNADD is to be installed in Tanzu setup, then modify the "metadata.labels" value in <chartpath>/templates/ocnadd-alerting-rules.yaml and <chartpath>/templates/ocnadd-mgmt-alerting-rules.yaml files as below:

      For Example "release: prom-operator" instead of "role: cnc-alerting-rules".

      To obtain the labels details use the below 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 }}
  4. <Optional> Creating Registry Credentials:

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

    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 in the ocnadd-custom-values-25.1.200.yaml file as follows:
      imagePullSecret:
    enable: true      ## --> update this to 'true'
  5. <Optional> 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 kafka-section of ocnadd-custom-values-25.1.200.yaml file. Ensure that this is done for all the applicable worker groups.

      Note:

      If the topics are created with Replication Factor (RF) greater than "1" (RF>1) then, ensure to update the corresponding RF values of the following parameters in the ocnadd-custom-values-25.1.200.yaml file under ocnaddkafka:
      • offsetsTopicReplicationFactor
      • transactionStateLogReplicationFactor

      For example, if the topics SCP, NRF, SEPP, PCF, BSF, and MAIN are created with RF=3, then the parameters should be set to value "3"

      offsetsTopicReplicationFactor: 3 transactionStateLogReplicationFactor: 3
    2. <Optional> When the security protocol is SASL and the customer required to add new users, update the kafka_server_jaas.conf, zookeeper_jaas.conf files in <chartpath>/charts/ocnaddkafka/config.
  6. Storage Class:
    • If deploying on Tanzu, update the storageClass in the ocnadd-custom-values-25.1.200.yaml with the respective storage class name of the TANZU platform. For example, zfs-storage-policy.
    • If deploying on OCI, update the storageClass in the ocnadd-custom-values-25.1.200.yaml 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..
  7. <Optional> To enable Egress Annotation, see the "Enabling Egress Annotation" section in the Oracle Communications Network Analytics Data Director User Guide. The step can be skipped if the Egress Traffic separation via CNLB is planned to be used.
  8. Loadbalancer on OCI: Update the following in ocnadd-custom-values-25.1.200.yaml
    1. global.env.oci: false =====> set it to true
    2. global.env.subnetOcid:<subnet_ocid> # Add the OCID of the subnet that user want to use for creating load balancer

3.3 Global Parameters

Table 3-2 Global Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ocnaddalarm.enabled BOOLEAN true/false true M To enable alarm charts.
env.admin.OCNADD_CORR_UPGRADE_ENABLE BOOLEAN true/false false M Upgrade correlation service during Helm upgrade if the flag is set to true
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
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
ocnaddconfiguration.enabled BOOLEAN true/false true M To enable configuration charts.

ocnaddhealthmonitoring.enabled

 BOOLEAN true/false true M To enable health monitoring charts.
ocnaddfilter.enabled BOOLEAN true/false false M To disable filter charts ('false' for the current release).
ocnaddscpaggregation.enabled BOOLEAN true/false true M To enable SCP aggregation charts
ocnaddnrfaggregation.enabled BOOLEAN true/false true M To enable NRF aggregation charts
ocnaddseppaggregation.enabled BOOLEAN true/false true M To enable SEPP aggregation charts
ocnaddbsfaggregation.enabled BOOLEAN true/false false M To enable BSF aggregation charts
ocnaddpcfaggregation.enabled BOOLEAN true/false false M To enable PCF aggregation charts
ocnaddbackuprestore.enabled BOOLEAN true/false true M To enable backup restore charts.
ocnaddkafka.enabled BOOLEAN true/false true M To enable Kafka charts.
ocnaddadminsvc.enabled BOOLEAN true/false true M To enable adminsvc charts.
ocnaddgui.enabled BOOLEAN true/false true M To enable GUI charts.
ocnadduirouter.enabled BOOLEAN true/false true M To enable UI router charts.
ocnaddredundancyagent.enabled BOOLEAN true/false false M To enable two site redundancy
ocnaddexport BOOLEAN true/false false M To enable export service
ocnaddnonoracleaggregation BOOLEAN true/false false M To enable non-Oracle aggregation feature through aggregation service instance.
ocnaddredundancyagent.egress BOOLEAN true/false false C Required if egress annotation is required to allow traffic outside cluster.
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.
env.ocwebclient.OCWEBCLIENT_TIMEOUT INTEGER NA 30 O Webclient timeout in seconds
env.ocwebclient.OCWEBCLIENT_KEEPALIVE_IDLE INTEGER NA 90 O Webclient keep alive idle time in seconds
env.repo.repo.REPO_HOST_PORT STRING NA docker.io M Local container registry to pull the images
env.repo.repo.REPO_PATH STRING NA ocdd.repo M Additional repo path
env.admin.OCNADD_ADAPTER_UPGRADE_ENABLE BOOLEAN NA false M Upgrade consumer adapter during Helm upgrade if the flag is set to true.
scaleDownOnePodAtATime BOOLEAN true/false false M Scale down Pods one at a time.
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.
initContainers.name STRING NA ocnaddinitcontainer M Name of initContainer for SSL support
initContainers.REPO_PATH STRING NA utils.repo M Repo path where init image is stored
initContainers.volumeMounts.ts_ks_volumeName STRING NA truststore-keystore-volume M Volume name for truststore
initContainers.volumeMounts.ts_ks_volumePath STRING NA /var/securityfiles/keystore M Path where keystore files are stored
initContainers.volumeMounts.certificateName STRING NA client-server-certificate M Volume name for server certificates
initContainers.volumeMounts.certificatePath STRING NA /var/securityfiles/certs M Path where cert files are stored
initContainers.env.cert_file_params.SERVER_CERT_FILE STRING NA servercert.pem M Server cert filename
initContainers.env.cert_file_params.CLIENT_CERT_FILE STRING NA clientcert.pem M Client cert filename
initContainers.env.cert_file_params.SERVER_KEY_FILE STRING NA serverprivatekey.pem M Server Private Key filename
initContainers.env.cert_file_params.CLIENT_KEY_FILE STRING NA clientprivatekey.pem M Client Private Key filename
initContainers.env.ks_file_params.SERVER_KEY_STORE STRING NA serverKeyStore.p12 M Server Keystore file
initContainers.env.ks_file_params.CLIENT_KEY_STORE STRING NA clientKeyStore.p12 M Client Keystore file
initContainers.env.ks_file_params.TRUST_STORE STRING NA trustStore.p12 M Truststore file
initContainers.cacert.key STRING NA CA_CERT_FILE M Cacert key file
initContainers.cacert.value STRING NA cacert.pem M Cacert file
ssl.intraTlsEnabled BOOLEAN true/false false M Enable internal service TLS
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.domainName STRING NA occne-ocdd M Domain name of the setup
cluster.clusterName STRING NA occne-ocdd M Default cluster name of setup
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 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.storageClass STRING NA standard M Storage Class Name
cluster.nameSpace.name STRING NA ocnadd-deploy M OCNADD Namespace
cluster.serviceAccount.create BOOLEAN true/false true M To create a ServiceAccount (true/false)
cluster.serviceAccount.name STRING NA ocnadd M Name of the service Account
cluster.clusterRole.create BOOLEAN true/false true M To create clusterRole (true/false)
cluster.clusterRole.name STRING NA ocnadd   Name of the clusterRole
cluster.clusterRoleBinding.create BOOLEAN true/false true M To create clusterRoleBinding (true/false)
cluster.clusterRoleBinding.name STRING NA ocnadd   Name of the clusterRoleBinding
cluster.terminationGracePeriodSeconds INTEGER NA 5 O Pod grace termination
cluster.imagePullSecret.enable BOOLEAN true/false false M Image Pull secret creation
cluster.imagePullSecret.name STRING NA regcred O Set to regcred if cluster.imagePullSecret.enable is true
cluster.ALARM_PURGE_DAYS INTEGER NA 7 M Alarm Purge in Days
cluster.kafka.ocnadd_kafka_bootstrap_servers STRING NA kafka-broker:9092 M Bootstrap server for PLAINTEXT
cluster.kafka.ocnadd_kafka_bootstrap_servers_ssl STRING NA kafka-broker:9093 M Bootstrap server for SSL
cluster.kafka.ocnadd_kafka_bootstrap_servers_sasl STRING NA kafka-broker:9094 M Bootstrap server for SASL
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.05 M Max latency range of 50ms
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 100000 M Default MPS rate
cluster.serviceMonitorLabel STRING NA occne-kube-prom-stack M service monitor label to scrape metrics
cluster.prometheus_url STRING NA http://localhost:9000/cluster-name/prometheus/api/v1/query_range M Prometheus URL to scrape metrics
network.policy.enable BOOLEAN true/false false M Network Policy enable for intercommunication of OCNADD services
network.ingress.denyall BOOLEAN true/false false C Deny all ingress traffic
network.ingress.kafka BOOLEAN true/false true C Allow ingress traffic for kafka
network.ingress.aggregation BOOLEAN true/false true C Allow ingress traffic for aggregation service
network.ingress.filter BOOLEAN true/false true C Allow ingress traffic for filter service
network.ingress.adapter BOOLEAN true/false true C Allow ingress traffic for adapter service
network.ingress.egw BOOLEAN true/false true C Allow ingress traffic for egress service
network.ingress.config BOOLEAN true/false true C Allow ingress traffic for configuration service
network.ingress.alarm BOOLEAN true/false true C Allow ingress traffic for alarm service
network.ingress.health BOOLEAN true/false true C Allow ingress traffic for health monitoring service
network.ingress.admin BOOLEAN true/false true C Allow ingress traffic for admin service
network.ingress.namespaces STRING NA

- occne-infra

- occncc

 C Network communication between allowed namespaces
network.ingress.external.enable BOOLEAN true/false false C Allow kafka LoadBalancer IP to be created
network.ingress.external.cidrs STRING NA - 10.0.0.0/8 C Cidr for network communication
network.egress.denyall BOOLEAN true/false false C Deny egress traffic
deployment.centralized BOOLEAN true/false true M Whether to use centralized mode of deployment
deployment.management BOOLEAN true/false true M Whether to deploy management group services when centralized deployment model is enabled.

Will deploy worker group services if false.
deployment.management_namespace STRING - Valid namespace name M Specify the managment namespace when deploying the worker group services.

Centralized Mode:

For Management Group Deployment:

  • When deployment.management = true
    • deployment.management_namespace should match cluster.namespace.name.

For Worker Group Deployment:

  • When deployment.management = false
    • deployment.management_namespace should equal the namespace of the management group.

This parameter facilitates communication between services in the worker group and the management group of services.

Non-Centralized Mode:

In this mode:

  • Ensure this parameter is defined and set to the value of cluster.namespace.name.
deployment.nonCenToCen_upgrade BOOLEAN true/false false M True if upgrading from non-centralized to centralized.

Default is False (direct installation)
deployment.primary_site BOOLEAN true/false false C This parameter is required only in case the redundancy agent service is enabled. It depicts if the configured site is primary or not.
deployment.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.
kafka.kraftEnabled BOOLEAN true/false true C

This parameter is required only when Kafka is deployed in KRaft mode. The default value is 'false'.

Set this parameter to 'true' only during a fresh install when KRaft mode is selected.

It must remain 'false' during a Data Director upgrade (Zookeeper mode) or during migration from Zookeeper to KRaft.

If the source release was already using KRaft mode during an upgrade, this parameter must remain 'true'.

kafka.spawnKraftController BOOLEAN true/false false C

This parameter indicates whether the KRaft controller should be spawned during the migration process. It should only be enabled when running the migration procedure as defined in the Oracle Communications Network Analytics Data Director User Guide.

kafka.migrationBroker BOOLEAN true/false false C Parameter to indicate that the migration of Kafka brokers to Kraft controllers. This should only be enabled while running the migration procedure defined in the User guide
kafka.kraftBroker BOOLEAN true/false false C Parameter to indicate that the migration of Kafka brokers to Kraft. This should only be enabled while running the migration procedure defined in the Oracle Communications Network Analytics Data Director User Guide.
kafka.finalizeMigration BOOLEAN true/false false C Parameter to indicate that the migration to Kraft can now be finalized. This should only be enabled while running the migration procedure defined in the Oracle Communications Network Analytics Data Director User Guide.
kafka.removeZookeeper BOOLEAN true/false false C Parameter to indicate that zookeeper can now be deprovisioned after the migration to Kraft is finalized. This should only be enabled while running the migration procedure defined in the Oracle Communications Network Analytics Data Director User Guide.
kafka.occmZookeeperClientUUID STRING - false C UUID value of Zookeeper client certificate in OCCM. If OCCM is enabled during migration from Zookeeper mode to KRaft Mode then this value is used to delete the CLIENT Certificate of Zookeeper in OCCM
kafka.occmZookeeperServerUUID STRING - false C UUID value of Zookeeper server certificate in OCCM. If OCCM is enabled during migration from Zookeeper mode to KRaft Mode then this value is used to delete the SERVER Certificate of Zookeeper in OCCM
admin.OCNADD_UPGRADE_WG_NS STRING NA [ocnadd-deploy-wg1,ocnadd-deploy-wg2] M This parameter is a comma-separated list of worker group namespaces to update using Helm.
kafkaReplicas INTEGER - 4 M The parameter to change the replicas for the Kafka broker.
cnlb.consumeradapter.enable BOOLEAN true/false false C If set to true, egress traffic segregation will be enabled for consumer feeds. This determines whether an Egress NAD should be attached to consumer adapters. Recommended only for OCCNE with CNLB support.
cnlb.ingressadapter.enable BOOLEAN true/false false C If set to true, ingress traffic segregation and external access will be enabled for the ingress adapter. This determines whether an Ingress NAD should be attached. Recommended only for OCCNE with CNLB support.
cnlb.ocnaddredundancyagent.enable BOOLEAN true/false false C If set to true, external access will be enabled for the Redundancy Agent. This determines whether CNLB annotations should be applied to redundancy deployments. Recommended only for OCCNE with CNLB support.
cnlb.ocnaddredundancyagent.network STRING NA default/nf-oam-int1@nf-oam-int1 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.
cnlb.ocnaddredundancyagent.externalIP STRING NA 10.1.1.1 C Specifies the single external IP required for communication between Redundancy Agents in a two-site setup. Replace with the actual external IP.
cnlb.kafkabroker.enable BOOLEAN true / false false C If set to true, external access for Kafka brokers will be enabled in a CNLB-enabled cluster.
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 Used to populate the k8s.v1.cni.cncf.io/networks annotation. Update this based on the "Enable CNLB for Kafka Broker" section of the Oracle Communications Network Analytics Data Director User Guide.
cnlb.kafkabroker.networks_extip STRING NA   C Used to populate the oracle.com.cnc/cnlb annotation. Ensure the IP addresses are also included in the SAN entries for SSL communication.
env.controlPlaneNfList STRING NA BSF,NRF,PCF M It enlists all the control plane NFs
env.proxyNfList STRING NA SCP,SEPP M It enlist all the proxy NFs

3.4 Helm Hook Parameters

Table 3-3 Helm Hook Parameters

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

3.5 Aggregation Service Parameters

Table 3-4 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 false M Enable metrics for Aggregation service
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_FETCH_MAX_BYTES INTEGER - 576720 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 INTEGER - 104858 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 INTEGER - 104857 O Kafka Socket Buffer setting for consumer
LINGER_MS INTEGER - 1 O The time to wait before sending messages out to Kafka
logging.level.com.oracle.cgbu.cne.ocdd STRING [INFO,WARN,DEBUG,ERROR] INFO O To set the log level of the OCDD package level
logging.level.com.oracle.cgbu.cne.ocnadd STRING [INFO,WARN,DEBUG,ERROR] INFO O To set the log level of the OCNADD package level
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 a window time for each partition will be sorted separately based on timestamp and streamed to Kafka topic.

TRANSACTION: In-order messages received for each transaction within TRANSACTION_MSG_SEQUENCING_EXPIRY_TIMER will be sorted separately and streamed 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 streamed to Kafka topic.
OCNADD_AGG_REDUNDANCY_DELAY_MS INTEGER - 1000 C Delay before starting task to check Kafka ingress rate. This parameter is required when the two-site redundancy feature is enabled.
OCNADD_AGG_REDUNDANCY_INTERVAL_MS INTEGER - 250 C Interval between tasks to check Kafka ingress rate. This parameter is required when the two-site redundancy feature is enabled.
OCNADD_AGGREGATION_LOG_NETTY STRING - INFO O Default Netty Log level set for the application.
OCNADD_AGGREGATION_LOG_ROOT STRING - INFO O Default Log level set for the application.
OCNADD_AGGREGATION_SERVICE_TOPIC_RETRIES_THRESHOLD INTEGER - 120000 O Retry Threshold for TOPIC reachability
OCNADD_KAFKA_BOOTSTRAP_SERVER_SSL STRING - kafka-broker:9093 M Kafka Boot strap server address for SSL
OCNADD_KAFKA_SASL_MECHANISM STRING - PLAIN M Kafka SASL Mechanism.
OCNADD_KAFKA_SECURITY_PROTOCOL_SASL STRING - SASL_SSL M Kafka security protocol
OCNADD_KAFKA_SECURITY_PROTOCOL_SSL STRING - SSL M Kafka SSL Mechanism.
OCNADD_TRUST_KEYSTORE BOOLEAN true, false true M Enable to secure connection via OCWeb Client.
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
ocnaddnonoracleaggregation.resources.limit.cpu INTEGER - 3 M Number of max CPU for non-Oracle aggregation
ocnaddnonoracleaggregation.resources.limit.ephemeralstorage STRING - 500Mi M Ephemeral Storage for non-Oracle aggregation
ocnaddnonoracleaggregation.resources.limit.memory STRING - 2Gi M Maximum memory allocation for non-Oracle aggregation
ocnaddnonoracleaggregation.maxReplicas INTEGER - 1 M The maximum number of replicas required for ocnaddnonoracleaggregation aggregation service instance
ocnaddnonoracleaggregation.minReplicas INTEGER - 1 M The minimum number of replicas required for ocnaddnonoracleaggregation 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
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
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.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
REQUEST_RESPONSE_MSG_SEQUENCING_EXPIRY_TIMER INTEGER [5-500]ms 10ms C

When MESSAGE_SEQUENCING_TYPE = REQUEST_RESPONSE
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
WINDOW_MSG_SEQUENCING_EXPIRY_TIMER INTEGER [5-500]ms 10ms C When MESSAGE_SEQUENCING_TYPE = TIME_WINDOW

3.6 Configuration Service Parameters

Table 3-5 Configuration Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ADAPTER_DEFAULT_INGRESS_ACKS STRING - all O The non oracle producer acknowledgement value
ADAPTER_DEFAULT_INGRESS_LIMIT INTEGER - 101874 O The buffer in bytes in the non oracle ingress adapter feed for the http connection
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_RETRY INTEGER - 3 O The number of retries for the non oracle ingress adapter feed
ADAPTER_DEFAULT_INGRESS_TOPIC STRING - NON_ORACLE O The topic name for the non oracle ingress feed adapter
ADMIN_RESPONSE_TIMEOUT_MS INTEGER - 60000 O The timeout in receiving response from the admin service
ADMIN_RETRY_DELAY_MS INTEGER - 5000 O Delay between successive retries while calling admin service
ADMIN_RETRY_MAXATTEMPT INTEGER - 3 O Maximum number of retries attempted while calling admin service
CONFIG_NOTIFICATION_RETRY_DELAY INTEGER - 50000 O Delay between successive notification retries to be attempted
CONFIG_NOTIFICATION_RETRY_MAXATTEMPT INTEGER - 3 O The number of retries for the notification to the subscribed service instance
CONFIG_NOTIFICATION_SCHEDULER_INITIAL_DELAY_MS STRING - 200ms O The initial delay for the Notification sender thread in the configuration service
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
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.
logging.level.com.oracle.cgbu.cne.ocdd STRING - INFO O Logging level for Common OCNADD services
logging.level.com.oracle.cgbu.cne.ocnadd STRING - INFO O Logging level for OCNADD services
logging.level.reactor.netty STRING - INFO O Netty logging level
logging.type STRING STDOUT/LOGJSON STDOUT O Logging type Standard Output or JSON format
MAX_ACTION_TYPE_IN_FILTER INTEGER - 2 O Maximum number of action type in a filter with chaining
MAX_ALLOWED_FILTERS INTEGER - 30 O Maximum number of allowed filters
MAX_CORRELATION_CONFIGURATION_SUPPORTED INTEGER - 3 O Maximum number of correlation feeds allowed
MAX_EXPORT_CONFIGURATION_SUPPORTED INTEGER - 3 O The simultaneous number of export configuration supported on the Data Director
MAX_FILTERS_ASSOC_WITH_APP INTEGER - 4 O Maximum number of filters associated with a single app
MAX_GLOBALL3L4_ROW_SIZE INTEGER - 500 O Maximum size of L3L4 rows
MAX_VALUES_IN_FILTER_ATTRIB INTEGER - 20 O Maximum number of values allowed in filter attributes
OCNADD_CONFIG_FILTER_NOTIF_DELAY_SEC INTEGER - 3 O The delay between the notification to be sent to the filter service instance
OCNADD_CONFIG_TIMEOUT_CONNECT STRING - 30s O The timeout for receiving no response from the server on a http connection
OCNADD_CONFIG_TIMEOUT_READ_IDLE STRING - 30s O The setting (which defaults to 30 sec) dictates when to close a connection after it becomes idle
OCNADD_CONFIG_TIMEOUT_SSL_HANDSHAKE STRING - 30s O The SSL connection handshake timeout in configuration service
OCNADD_CONFIGURATION_LIVENESS_DELAY INTEGER - 600 M Configuration Svc Liveness Param: this field tells the kubelet that it should wait for mentioned seconds before performing the first probe.
OCNADD_CONFIGURATION_LIVENESS_FAILURE INTEGER - 50 M Configuration 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 no of failure retries.
OCNADD_CONFIGURATION_LIVENESS_PERIOD_SECONDS INTEGER - 15 M Configuration Svc Liveness Param: this field specifies that the kubelet should perform a liveness probe every given no of seconds.
OCNADD_CONFIGURATION_LIVENESS_TIMEOUT INTEGER - 20 M Configuration Svc Liveness Param: Number of seconds after which the probe times out.
OCNADD_MAX_EXTERNAL_KAFKA_FEEDS INTEGER - 2 O Maximum number of allowed external Kafka Feed
OCNADD_MAX_WORKERGROUP_THRESHOLD_PERCENTAGE INTEGER - 80 O The percentage threshold for the maximum worker group supported
OCNADD_REDUNDANCY_NOTIFY_DELAY_SEC INTEGER - 120 C Delay before updating mode of worker group from ACTIVE to STANDBY and vice-versa
OCNADD_TRUST_KEYSTORE BOOLEAN - false O Truststore enable for Configuration Service
ocnaddconfiguration.name STRING - ocnaddconfiguration M Name of configuration service
resources.limits.cpu INTEGER - 1 M Number of maximum CPUs for each configuration service instance
resources.limits.ephemeralstorage STRING - 500Mi M Ephemeral Storage for each configuration service
resources.limits.memory STRING - 1Gi M Max Memory limit for each configuration service instance
resources.requests.cpu INTEGER - 1 M Minimum number of CPUs required for each configuration service instance
resources.requests.ephemeralstorage STRING - 100Mi M minimum Ephemeral Storage required for each configuration instance
resources.requests.memory STRING - 1Gi M minimum Memory required for each configuration instance
SITE_REDUNDANCY_RESPONSE_TIMEOUT INTEGER - 30000 O The timeout to get a response from the redundancy agent for the request sent from the configuration service
SITE_REDUNDANCY_RETRY INTEGER - 3 O The number of retries towards the redundancy agent service
SITE_REDUNDANCY_RETRY_DELAY INTEGER - 100 O Delay between successive retries to be attempted

3.7 Health Monitoring and Alarm Service Parameters

Table 3-6 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
HEALTH_LOG_HTTPCLIENT STRING INFO O Set Default Log level for HTTP client
HEALTH_LOG_SPRING_WEB STRING INFO O Set Default Log level for Spring Web
logging.level.com.oracle.cgbu.cne.ocnadd STRING INFO O Logging level for Health Monitoring OCNADD Service
logging.level.com.oracle.cgbu.cne.ocdd STRING INFO O Logging level for Common OCNADD Service
HEALTH_APPLICATION_LOG_LEVEL STRING INFO O Set application logger level
HEALTH_LOG_REQUEST_DETAILS BOOLEAN true O If this parameter is set to true, the health request details will be logged
HEALTH_LOG_ROOT STRING WARN O Root Level Logger
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-7 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
logging.type STRING - STDOUT O Logging Type Standard Outpuut or JSON Format
OCNADD_TRUST_KEYSTORE BOOLEAN true/false true O Trust Keystore Enable
logging.level.com.oracle.cgbu.cne.ocnadd STRING - INFO O Logging level for Alarm OCNADD Service
logging.level.com.oracle.cgbu.cne.ocdd STRING - INFO O Logging level for Common OCNADD 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
OCNADD_ALARM_LIVENESS_DELAY INTEGER - 60 M Alarm Svc Liveness Parameter: this field tells the kubelet that it should wait for mentioned seconds before performing the first probe.
OCNADD_ALARM_LIVENESS_PERIOD_SECONDS INTEGER - 15 M Alarm Svc Liveness Parameter: this field specifies that the kubelet should perform a liveness probe every given no of seconds.
OCNADD_ALARM_LIVENESS_FAILURE INTEGER - 5 M Alarm Svc Liveness Parameter: For the case of a liveness probe, triggers a restart for that specific container if the container failed to start for given no of failure retries.
OCNADD_ALARM_LIVENESS_TIMEOUT INTEGER - 20 M Alarm Svc Liveness Parameter: Number of seconds after which the probe times out.

3.8 Admin Service Parameters

Table 3-8 Admin Service Parameters

Parameter Name Data Type Range Default Value M/O/C Description
ocnadd.admin.name STRING - ocnaddadminservice M Application name for the Admin Service
OCNADD_ADMIN_PORT INTEGER - 9181 M Application port for the Admin Service
resources.limits.cpu INTEGER - 1 M Maximum number of CPUs for each Admin Service instance
resources.limits.memory STRING - 1Gi M Maximum memory limit for each Admin Service instance
resources.limits.ephemeralstorage STRING - 200Mi M Ephemeral storage limit for each Admin Service instance
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 Service instance
resources.requests.ephemeralstorage STRING - 200Mi M Minimum ephemeral storage required for each Admin Service instance
logging.level.com.oracle.cgbu.cne.ocnadd STRING - INFO O Logging level for OCNADD services
logging.level.com.oracle.cgbu.cne.ocdd STRING - INFO O Logging level for common OCNADD services
ADMIN_SVC_LOGGER_KAFKA STRING [ON, OFF] OFF O Whether to enable Kafka logging in the Admin Service
ADMIN_SVC_ROOT_LOGGER STRING - WARN O Root logger level for the Admin Service
OCNADD_ADMIN_SVC_LIVENESS_DELAY INTEGER - 60 M Time (in seconds) for the kubelet to wait before performing the first liveness probe
OCNADD_ADMIN_SVC_LIVENESS_PERIOD_SECONDS INTEGER - 15 M Time interval (in seconds) between liveness probes by the kubelet
OCNADD_ADMIN_SVC_LIVENESS_FAILURE INTEGER - 5 M Number of failed liveness probes before restarting the container
OCNADD_ADMIN_SVC_LIVENESS_TIMEOUT INTEGER - 20 M Timeout (in seconds) for the liveness probe
OCNADD_ADMINSVC_HEALTH_RETRY_DELAY INTEGER - 2 M Retry delay (in seconds) for the Admin Service connection to the health monitoring service
OCNADD_ADMINSVC_HEALTH_HB_TIMER INTEGER - 10000 M Heartbeat interval (in milliseconds) for the Admin Service to the health monitoring service
OCNADD_ADMINSVC_HEALTH_RETRY_COUNT INTEGER - 1 M Number of retry attempts for the Admin Service connection to the health monitoring service

3.8.1 Consumer Aapter Parameters

Table 3-9 Consumer Aapter Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
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
OCNADD_CONSUMER_ADAPTER_PORT INTEGER - 9182 M Application port for the consumer adapter
OCNADD_ADAPTER_HEALTH_RETRY_DELAY INTEGER - 2 M Retry delay for the adapter service connection towards healt monitoring service
OCNADD_ADAPTER_HEALTH_HB_TIMER INTEGER - 10000 M Heart beat timer in consumer adapter towards the health monitoring service
OCNADD_ADAPTER_HEALTH_RETRY_COUNT INTEGER - 1 M Retry count for the adapter service connection towards health monitoring service
ALARM_CLIENT_RETRY_COUNT INTEGER - 3 M Retry count for the adapter service connection towards alarm service
EGRESS_SSL_HANDSHAKE_TIMEOUT INTEGER - 5 O SSL handshake timeout.
ENABLE_ADAPTER_COUNTER_METRICS BOOLEAN true/false true O Enable Adapter Counter Metric.
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.
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 AdapterService 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 AdapterService 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 AdapterService 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 AdapterService 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.8.2 Correlation Service Parameters

All the Correlation parameters are available under ocnaddadminsvc.correlation section in ocnadd-custom-values-25.1.200.yaml file.

Table 3-10 Correlation Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
name STRING - ocnaddcorrelation M name of the service
resources.limits.cpu INTEGER - 3 M Number of maximum CPUs for each Correlation instance
resources.limits.memory STRING - 64Gi M Max Memory limit for each Correlation instance
resources.limits.ephemeralstorage STRING - 400Mi M Ephemeral Storage for each Correlation instance
resources.requests.cpu INTEGER - 3 M Minimum number of CPUs required for each Correlation instance
resources.requests.memory STRING - 64Gi M minimum Memory required for each Correlation instance
resources.requests.ephemeralstorage STRING - 400Mi M minimum Ephemeral Storage required for each Correlation instance
Environmental variables for Correlation service are declared under "ocnaddadminsvc.correlation.env" section
OCNADD_CORRELATION_SVC_LIVENESS_DELAY INTEGER - 60 O This field tells the kubelet that it should wait for mentioned seconds before performing the first probe
OCNADD_CORRELATION_SVC_LIVENESS_PERIOD_SECONDS INTEGER - 15 O This field specifies that the kubelet should perform a liveness probe every given number of seconds.
OCNADD_CORRELATION_SVC_LIVENESS_FAILURE INTEGER - 5 O 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_CORRELATION_SVC_LIVENESS_TIMEOUT INTEGER - 20 O Number of seconds after which the probe times out.
OCNADD_CORRELATION_NAME STRING - ocnaddcorrelation M correlation service name which will be replaced by the admin service while creating correlation configuration with new name
ADMIN_CORRELATION_RESOURCE_FILE STRING - /tmp/ocnadd/deploy/ocnaddcorrelationservice.yaml M Template file for deploying correlation service through admin service.
OCNADD_CORRELATION_ACTIVE_PROFILE STRING [prod,dev] prod M profile with dev or production parameters
OCNADD_CORRELATION_SERVER_PORT INTEGER - 9664 M port number for correlation service
OCNADD_CORRELATION_HTTP2_ENABLED BOOLEAN [true/false] TRUE M enable or disable http2
OCNADD_TRUST_CLIENT_KEY_TYPE STRING - PKCS12 M trustore client key Type
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
INTERNAL_LEAVE_GROUP_ON_CLOSE BOOLEAN [true/false] TRUE O this property controls whether the Kafka Streams application should actively leave the consumer group when it is closed or whether it should rely on the group coordinator to remove it when it becomes unresponsive
OCNADD_CORRELATION_HEALTH_RETRY_COUNT INTEGER - 3 O No of times the correlation service retries for health registration in case of failure
OCNADD_CORRELATION_HEALTH_RETRY_DELAY INTEGER - 10 O delay between the each retry for health registration
OCNADD_CORRELATION_HEALTH_HB_TIMER INTEGER - 120000 O heart beat timer for health check
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
logging.level.com.oracle.cgbu.cne.ocnadd STRING - INFO O ocnadd package log level
logging.level.com.oracle.cgbu.cne.ocdd STRING - INFO O ocdd package log level
OCNADD_TRUST_KEYSTORE BOOLEAN - TRUE O Enable to secure connection via OCWeb Client.
KAFKASTREAMS_PUNCTUATOR_TIMER INTEGER - 2000 O Kafka Stream Scheduler Timer to loop through the Local cache for Timer Expiry Scenario

3.8.3 Storage Adapter Service Parameters

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

Table 3-11 Storage Adapter Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
name STRING - ocnaddstorageadapter M Name of the service
resources.limits.cpu INTEGER - 3 M Number of maximum CPUs for each storage adapter instance.
resources.limits.memory STRING - 64Gi M Maximum 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

Table 3-12 Environmental variables for Storage Adapter service are declared under "ocnaddadminsvc.storageadapter.env" section

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
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
logging.level.com.oracle.cgbu.cne.ocnadd STRING - INFO O OCNADD package log level
logging.level.com.oracle.cgbu.cne.ocdd STRING - INFO O OCNADD package 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.8.4 Ingress Adapter Service Parameters

All the Ingress Adapter Service parameters are available under ocnaddadminsvc.ingressadapter section in ocnadd-custom-values-25.1.200.yaml file.

Table 3-13 Ingress Adapter Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
name STRING - ocnaddingressadapter M Name of the service
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_PORT INTEGER - 9188 M The port of the ingress adapter service.
INGRESS_ADAPTER_SERVICE_NAME STRING - ocnaddingressadapter M Name of the service
OCNADD_TRUST_KEYSTORE BOOLEAN - true O Enable to secure connection using OCWeb Client.
OCNADD_TRUST_CLIENT_KEY_TYPE STRING - PKCS12 M Trust store client key Type
OCWEBCLIENT_TIMEOUT INTEGER - 60   Webclient timeout
OCWBCLIENT_CHANNEL_TIMEOUT INTEGER - 60 O Webclient channel timeout
OCWEBCLIENT_SSL_HANDSHAKE_TIMEOUT INTEGER - 30 O SSL handshake timeout
OCWEBCLIENT_SSL_FLUSH_TIMEOUT INTEGER - 10 O SSL flush timeout
OCWEBCLIENT_SSL_READ_TIMEOUT INTEGER - 10 O SSL read timeout
logging.level.com.oracle.cgbu.cne.ocnadd STRING - INFO O ocnadd package log level
logging.level.com.oracle.cgbu.cne.ocdd STRING - INFO O ocdd package log level
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_LOG_FILENAME STRING - ingress-adapter.log O The log file name
OCNADD_CONSUMER_ADAPTER_HEALTH_RETRY_COUNT INTEGER - 3 O The number of retries with the health service.
OCNADD_CONSUMER_ADAPTER_HEALTH_RETRY_DELAY INTEGER - 10 O The time interval in sec between successive retries with the health service.
INGRESS_ADAPTER_HEALTH_HB_TIMER INTEGER - 120000 O The heartbeat timer with the health service
INGRESS_ADAPTER_HTTP2_ENABLED BOOLEAN [true,false] true O The flag to indicate if http2 should be used or not
INGRESS_ADAPTER_SSL_ENABLED BOOLEAN [true,false] true O The flag to indicate if TLS should be used or not
INGRESS_ADAPTER_CLIENT_AUTH_CONFIG STRING - want O Parameter to check client authentication
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 milliseconds
INGRESS_HTTPSERVER_REQUEST_TIMEOUT_MS INTEGER - 30000 O The ingress adapter request timeout in milliseconds
INGRESS_HTTPSERVER_CONNECT_TIMEOUT_MS INTEGER - 60000 O The ingress adapter connect timeout in milliseconds
INGRESS_HTTPSERVER_IDLE_TIMEOUT_MS INTEGER - 120000 O The ingress adapter idle timeout in milliseconds
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 milliseconds
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 milliseconds
INGRESS_HTTPSERVER_CLOSE_NOTIFY_READ_TIIMEOUT_MS INTEGER - 30000 O Notification read timeout in milliseconds
INGRESS_HTTPSERVER_SSL_HANDSHAKE_TIMEOUT_MS INTEGER - 30000 O SSL handshake timeout in milliseconds
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
KAFKA_JAAS_CONFIG_PASS STRING - secret O Kafka default jaas password
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.9 Kafka Configuration Parameters

Table 3-14 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.name String - kafka-broker - Name of the Kafka broker
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.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 of LoadBalancer Static IP available for use.

3.10 UI Router Parameters

Listed below are the UI Router Parameters:

Table 3-15 UI Router Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ocnadduirouter.name String   ocnadduirouter M The express application name for ocnadduirouter.
Router_host String   http://localhost M The Router host contains uirouter service endpoint and value of this variable can be service name, node IP, and Load Balancer IP.
Router_port String   8080 M The ocnadduirouter service has exposed this specified port and this port can be used to access specific router service.
DD_UIAPI String   http://ocnaddgui:80 M The target endpoint of ocnaddgui service and use to configure the GUI.
DD_CONFIG_API String   http://ocnaddconfiguration:12590 M Target endpoint of the configuration service used to route the GUI request and forward the response.
DD_ALARM_API String   http://ocnaddalarm:9099 M Target endpoint of the Alarm service used to route the GUI request and forward the response.
DD_HEALTH_API String   http://ocnaddhealthmonitoring:12591 M Target endpoint of the Health Monitoring service used to route the GUI request and forward the response.
PROMETHEUS_API String   http://occne-kube-prom-stack-kube-prometheus.occne-infra.svc.ocnadd:80 M Target endpoint of the Prometheus service used to route the GUI request and forward the response.

Note: Update this parameter based on the setup.

DD_PROMETHEUS_PATH String   /blurr8/prometheus/api/v1/query_range M The Prometheus endpoint API URL path.

Note: Update this parameter based on the setup.

3.11 Filter Service Parameters

Filter Service Parameters are present under ocnaddfilter section in ocnadd-custom-values-25.1.200.yaml file.

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
name STRING - ocnaddfilter M Name of the Service.
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"
OCNADD_TRUST_KEYSTORE BOOLEAN [true/false] true O Enable to secure connection via OCWeb Client.
ENABLE_FILTER_METRICS BOOLEAN [true/false] true O To enable/disable filter metrics, default is true
KAFKA_PRODUCER_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
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 partitioned 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 health 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_FILTER_LIVENESS_FAILURE INTEGER   60 M Filter service Liveness Parameter : this field tells the kubelet that it should wait for mentioned seconds before performing the first probe.
OCNADD_FILTER_LIVENESS_DELAY INTEGER   15 M Filter service Liveness Parameter : this field specifies that the kubelet should perform a liveness probe every given no of seconds.
OCNADD_FILTER_LIVENESS_PERIOD_SECONDS INTEGER   5 M Filter service Liveness Parameter : For the case of a liveness probe, triggers a restart for that specific container if the container failed to start for given no of failure retries.
OCNADD_FILTER_LIVENESS_TIMEOUT INTEGER   20 M Filter service Liveness Parameter : Number of seconds after which the probe times out.
OCNADD_KAFKA_SSL_PROTOCOL STRING - TLSv1.3 O SSL Protocol version
OCNADD_KAFKA_SECURITY_PROTOCOL_SASL STRING - SASL_SSL O The Kafka security protocol for the filter service for SASL connection with Kafka
OCNADD_KAFKA_SECURITY_PROTOCOL_SSL STRING - SSL O The Kafka security protocol for the filter service for SSL connection with Kafka
OCNADD_KAFKA_SASL_JAAS_MODULE STRING - org.apache.kafka.common.security.plain.PlainLoginModule O Kafka Login module
OCNADD_KAFKA_JASS_SECRET_NAME STRING - username O Kafka default JAAS username present
OCNADD_KAFKA_JAAS_SECRET_KEY STRING - secret O Kafka default JASS password present
OCNADD_KAFKA_SASL_MECHANISM STRING - PLAIN O Describes SASL SCRAM mechanism

3.12 Redundancy Agent Service Parameters

Table 3-16 Redundancy Agent Service Parameter

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
name STRING - ocnaddredundancyagent M Name of service.
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.13 Export Service Parameters

Table 3-17 Export Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
name STRING - ocnaddexport M Name of service
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
logging.level.com.oracle.cgbu.cne.ocnadd STRING - INFO O ocnadd package log level
logging.level.com.oracle.cgbu.cne.ocdd STRING - INFO O ocdd package log level
EXPORT_WEB_LOG_LEVEL STRING - INFO O Export service application log level
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.14 Helm Parameter Configuration for OCCM

Table 3-18 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.occm_namespace STRING - - O OCCM Namespace
global.certificates.occm.occm_service_name STRING - occm O OCCM Kubernetes Service Name
global.certificates.occm.occm_port INTEGER - 8989 O OCCM Service Port
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.san.kafka.update_required BOOLEAN true/false false C If update of SAN field for Kafka certificates is required. Should be enabled post-installation when external access of Kafka is required.
global.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 Kafka certificate. Provide the Load balancer IPs during installation if static IPs for load balancer are chosen
global.certificates.occm.san.kafka.uuid.client STRING - - C UUID of existing Kafka broker certificate with names prefixed by KAFKABROKER-SECRET-CLIENT
global.certificates.occm.san.kafka.uuid.server STRING - - C UUID of existing Kafka broker certificate with names prefixed by KAFKABROKER-SECRET-SERVER
global.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.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 load balancer is chosen
global.certificates.occm.san.redundancy_agent.uuid.client STRING - - C UUID of existing Redundancy Agent certificate with names prefixed by KAFKABROKER-SECRET-CLIENT
global.certificates.occm.san.redundancy_agent.uuid.server STRING - - C UUID of existing Redundancy Agent certificate with names prefixed by KAFKABROKER-SECRET-SERVER
global.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.certificates.occm.san.ingress_adapter.ips LIST[STRING] - ["10.10.10.10"] C IPs to add in SAN for Ingress Adapter certificate
global.certificates.occm.san.ingress_adapter.uuid.client STRING - - C UUID of existing Ingress Adapter certificate with names prefixed by KAFKABROKER-SECRET-CLIENT
global.certificates.occm.san.ingress_adapter.uuid.server STRING - - C UUID of existing Ingress Adapter certificate with names prefixed by KAFKABROKER-SECRET-SERVER
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.

3.15 cnDBTier Customization Parameters

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

Single-site cnDBTier deployment mode: Georeplication is unavailable. Users must continue taking databse backups periodically, preferably on a daily basis, so that the same can be used when fault recovery scenarios arise. See the section "Fault Recovery" for backup options in the OCNADD.

Note:

For information about the values of the following parameters, see the ocnadd_dbtier_custom_values.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.yaml should match with this guide; if not, update them according to this guide.

Table 3-19 cnDBTier Customization Parameters

Parameter Description Version
global.repository The value should be updated to point to the actual path of your Docker registry, for example occne-repo-host:5000/occne 24.3.0
global.sitename This parameter must be set to the name of the current cluster 24.3.0
global.domain Set it to the name of the 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 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 should 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 should be updated as follows:

- In the 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 should 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 should 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 24.3.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 should 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 should 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 should 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 should 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.