1. Network Analytics Data Director Installation and Upgrade Guide
  2. Customizing OCNADD

3 Customizing OCNADD

This chapter describes how to customize the Oracle Communications Network Analytics Data Director (OCNADD) deployment 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.

Perform the following procedure to customize the values.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 Data Director charts tgz file if not already extracted.

    1. Change the directory to ocnadd to access the parent values.yaml. This file is used to customize the deployment parameters during installation.

      Change the following parameters in the file 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
    a) cluster.clusterName: <customer cluster name>
    b) cluster.nameSpace.name: <created namespace of DD>
 
3. Change the Prometheus Monitoring Details, bases on the desired MPS profile, default threshould MPS is 40K
   cluster.mps: 40000
  3. Customize the rules file <chartpath>/templates/ocnadd-alerting-rules.yaml:
    • If OCNADD is to be installed in OCCNE 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 file as below, 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. Update the following default parameters of helm charts before installation:

    Service Name Parameter Name Parameter Value FilePath
    Admin Service OCNADD_ADAPTER_THIRD_PARTY_INTERVAL 2000 ocnadd/charts/ocnaddadminsvc/values.yaml
    Admin Service OCNADD_ADAPTER_MAX_PARTITION 20 ocnadd/charts/ocnaddadminsvc/values.yaml
    Admin Service OCNADD_ADAPTER_MAX_POLL_RECORDS

    25 (is the default value)

    [50-600] (when Message size > 3000 Bytes and Replication factor >1 for MAIN topic)

    		 ocnadd/charts/ocnaddadminsvc/values.yaml
    Admin Service OCNADD_DEPLOYMENT_TERMINATION_GRACE 5 ocnadd/charts/ocnaddadminsvc/values.yaml

Global Parameters

Table 3-1 Global Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ocnaddalarm.enabled BOOLEAN true/false true M To enabled alarm charts
ocnaddconfiguration.enabled BOOLEAN true/false true M To enabled configuration charts

ocnaddhealthmonitoring

.enabled

 BOOLEAN true/false true M To enabled healthmonitoring charts
ocnaddfilter.enabled BOOLEAN true/false true M To enabled filter charts
ocnaddaggregation.enabled BOOLEAN true/false true M To enabled aggregation charts
ocnaddbackuprestore.enabled BOOLEAN true/false true M To enabled backuprestore charts
ocnaddkafka.enabled BOOLEAN true/false true M To enabled kafka charts
ocnaddadminsvc.enabled BOOLEAN true/false true M To enabled adminsvc charts
ocnaddbackendrouter.enabled BOOLEAN true/false true M To enabled backendrouter charts
nodeName STRING - occne-ocdd-k8s-node-x O Defines the worker NodeName of the k8 cluster.
OCNADD_SSL_KEY_TYPE STRING - PKCS12 M Type of ssl key
OCNADD_SSL_TRUST_TYPE STRING - PKCS12 M Type of ssl store
OCNADD_TRUST_KEYSTORE STRING true/false true M Enable trust keystore
OCWEBCLIENT_TIMEOUT INTEGER - 30 M Webclient timeout in seconds
OCWEBCLIENT_KEEPALIVE_IDLE INTEGER - 90 M Webclient keepalive idle time in seconds
scaleDownOnePodAtATime BOOLEAN true/false false M Scale Down Pods One at a Time
stabilizationWindowSeconds INTEGER - 60 M Stabilization period in seconds post which scale down starts
scaleDownPeriodSeconds INTEGER - 30 M Period of each scale down opeartion in seconds
scaleDownValue INTEGER - 1 M Number of pods which shall go down in every scaleDownPeriodSeconds
global.cluster.nameSpace.name STRING - ocnadd-deploy M Namespace name
global.cluster.mysqlNameSpace STRING - occne-cndbtierone O DB Tier Namespace
global.cluster.secret.name STRING - ***** M DB secret name
global.cluster.secret.data.dbUsername STRING - ***** M DB User name (value shoud be converted into base64)
global.cluster.secret.data.dbPassword STRING - ***** M DB Password (value shoud be converted into base64)
global.cluster.serviceAccount.create BOOLEAN true/false true M To create a ServiceAccount (true/false)
global.cluster.serviceAccount.name STRING - ocnadd-deploy-sa M Service Account Name used during RBAC authorization creation
global.cluster.clusterRole.create BOOLEAN true/false true M To create clusterRole (true/false)
global.cluster.clusterRole.name STRING - ocnadd-deploy-cr M ClusterRole name used during RBAC authorization creation
global.cluster.clusterRoleBinding.create BOOLEAN true/false true M To create clusterRoleBinding (true/false)
global.cluster.clusterRoleBinding.name STRING - ocnadd-deploy-crb M ClusterRoleBinding name used during authorization creation
global.cluster.prometheusScrapePort INTEGER - 9000 O Port to scape metrics required if metrics enabled
global.cluster.prometheusPortName STRING - cnc-metrics O Role required to define in alert rules yaml
global.cluster.max_latency FLOAT - 0.05 M Max latency range of 50ms
global.cluster.memory_threshold INTEGER [0-100] 70 M Max Threshold limit for memory
global.cluster.cpu_threshold INTEGER [0-100] 70 M CPU max threshold limit
global.cluster.mps INTEGER - 5000 M Default MPS rate
global.cluster.egwGroupLatencyMessageCountMax INTEGER - 50 M Max latency count for Egress Gateway
serviceAccount.create BOOLEAN true/false true M Disable if Service Account already created and not required to create again
clusterRole.create BOOLEAN true/false true M ClusterRole creation parameter make it false if already created
clusterRoleBinding.create BOOLEAN true/false true M ClusterRoleBinding creation parameter make it false if already created
ocnaddhelmhook.config.name STRING - helmhook-configmap M Name of ConfigMap
ocnaddhelmhook.cluster.secret.name STRING - db-secret M Name of database secret object
ocnaddhelmhook.name STRING - 
ocnaddhelmhook
 M Helm Hook Name
ocnaddhelmhook.container.name STRING - 
ocnaddhelmhook
 M Container Name of Helm Hook Job
ocnaddhelmhook.container.image STRING - ***** M Image will be depending on setup and image repo
ocnaddhelmhook.container.imagePullPolicy STRING IfNotPresent/Always/Never IfNotPresent M Image Pull Policy

Aggregation Service Parameters

Table 3-2 Aggregation Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
OCNADD_AGGREGATION_NAME STRING - ocnaddnrfaggregation M Name of the application
OCNADD_AGGREGATION_ACTIVE_PROFILE STRING dev, prod prod M Active Profile to be used by the application.
OCNADD_AGGREGATION_SERVICE_SOURCE_TOPIC STRING SCP/NRF SCP M Source topic details for Aggregation Service (i.e., To Read)
OCNADD_AGGREGATION_SERVICE_SOURCE_NAME STRING - AGGREGATION_SOURCE M Name of the Kafka Stream Source Node.
OCNADD_AGGREGATION_SERVICE_PROCESSROR_NAME STRING - AGGREGATION_PROCESSOR M Name of the Kafka Stream Processor Node.
OCNADD_AGGREGATION_SERVICE_SINK_NAME STRING - AGGREGATION_SINK M Name of the Kafka Stream Sink Node.
OCNADD_AGGREGATION_LOG_ROOT STRING - INFO O Default Log level set for the application.
OCNADD_AGGREGATION_LOG_NETTY STRING - INFO O Default Netty Log level set for the application.
OCNADD_AGGREGATION_LOG_FILENAME STRING - logs/aggregation-service.log O Location where the application specific logs are stored.
OCNADD_AGGREGATION_APPLICATION_NAME STRING - OCNADD O Aggregation Service Pod name to capture metrics related information.
OCNADD_AGGREGATION_MICROSERVICE_NAME STRING ocnadd-aggregation-service O Aggregation Service Name to communicate & Capture Metrics related information.
OCNADD_AGGREGATION_ENABLED_SCHEDULING_JOBS BOOLEAN true, false false O Parameters to enable scheduling Jobs (i.e., Calculating the Metrics) for CPU, Memory, Kafka Lag and Kafka Streams.
OCNADD_METRICS_CPU_THRESHOLD FLOAT [ 0, 1 ] 0.75 O
  1. Parameter to compute the CPU related metrics of the application.
  2. Work only when OCNADD_AGGREGATION_ENABLED_SCHEDULING_JOBS is enabled.
OCNADD_METRICS_MEM_THRESHOLD FLOAT [ 0, 1 ] 0.95 O
  1. Parameter to compute the Memory related metrics of the application.
  2. Work only when OCNADD_AGGREGATION_ENABLED_SCHEDULING_JOBS is enabled.
ALARM_SERVICE_URL STRING - http://ocnaddalarm:9099 M Alarm Service API Root to raise alarm
OCNADD_PRODUCER_SERVER_SSL_ENABLED BOOLEAN true, false false M Parameter to enable SSL support for the application.
KAFKA_PRODUCER_SECURITY_PROTOCOL STRING - PLAINTEXT M Kafka Producer Secutiry Protocol.
OCNADD_PRODUCER_SSL_KEYSTORE_LOCATION STRING - <location in pod> M SSL Key store file location.
OCNADD_PRODUCER_SSL_TRUSTSTORE_LOCATION STRING - <location in pod> M SSL Trust store file location.
KAFKA_PRODUCER_SSL_PROTOCOL STRING - TLSv1.3 M SSL Protocol
KAFKA_PRODUCER_SASL_MECHANISM STRING - PLAIN M Kafka Producer SSAL Mechanism.
KAFKA_PRODUCER_SSL_CLIENT_AUTH BOOLEAN true, false false M Kafka SSL client authentication.
KAFKA_BOOTSTRAP_SERVER STRING - kafka-broker1:9092 M Kafka Boot strap server address.
AGGREGATION_SERVICE_KAFKA_APPLICATION_ID STRING - ocnadd-aggregation-service M Aggregation Service Kafka Stream application Id (By using this name Kafka Consumer Group will be created).
AGGREGATION_SERVICE_KAFKA_GROUP_NAME STRING - ocnadd-aggregation-service-group M Aggregation Service Kafka Consumer Group Id.
KAFKA_STREAM_STATE STRING - /tmp/ocnadd/kafka/state M Location to store any stateful information by the application.
KAFKA_REPLICATION_FACTOR INTEGER >= 1 1 M The replication factor for changelog topics and repartition topics created by the application.
KAFKA_OFFSET_CONFIG STRING latest, earliest latest M A flag to tell Kafka application from where to start reading offsets in case you do not have any 'commit' yet.
KAFKA_ENABLE_AUTO_COMMIT STRING true, false false M A flag for consumer auto commit, to guarantee at-least-once processing semantics.
KAFKA_AUTOCOMMIT_INT_CONFIG INTEGER - 10000 M A hard auto commit by the Kafka set in the application.
KAFKA_COMMIT_INT_CONFIG INTEGER - 10000 M The frequency with which to save the position (offsets in source topics) of tasks.
KAFKA_NUMBER_THREADS_CONFIG INTEGER >= 1 2 M The number of threads to execute stream processing.
KAFKA_MAX_AGE_CONFIG INTEGER - 10000 M The period of time in milliseconds after which we force a refresh of metadata.
OCNADD_AGGREGATION_HEALTH_SVC_TYPE STRING - AGGREGATION M Service Type
OCNADD_TRUST_KEYSTORE BOOLEAN true, false false M Enable to secure connection via OCWeb Client.
OCNADD_TRUST_CLIENT_TRUST_STORE STRING - <location of truststore> M OCWeb Client Trust Store location.

Configuration Service Parameters

Table 3-3 Configuration Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
OCNADD_CONFIGURATION_PROFILE STRING dev,prod prod O Application profile to use
ALARM_SERVICE_URL STRING - http://ocnaddalarm:9099 M Alarm Application URL
CONFIGURATION_SSL_ENABLED BOOLEAN - FALSE M whether to enable ssl
SPRING_MVC_LOG_DETAILS BOOLEAN - true M -
CONFIGURATION_ROOT_LOG_LEVEL STRING - INFO O Set Default Log Level for Spring Application
CONFIGURATION_WEB_LOG_LEVEL STRING - INFO O Set Default Log level for Spring Web
CONFIGURATION_DB_SHOW_SQL BOOLEAN - false O Whether to enable logging of SQL statements.
CONFIGURATION_DB_SQL_COMMENTS BOOLEAN - false O If turned on, Hibernate will generate comments inside the SQL, for easier debugging, defaults to 
false
.
CONFIGURATION_DB_QUERY_TIMEOUT INTEGER - 30000 M sets the length of time to wait for an SQL request to complete.
CONFIGURATION_DB_LOCK_TIMEOUT INTEGER - 30000 M sets the length of time to wait on a blocked resource.
DB_DATASOURCE_URL STRING - jdbc:mysql://<DB_IP>:3306//configuration_schema M Ip address of Database service
DB_DATASOURCE_USER STRING - ****** M Database User name from secret
DB_DATASOURCE_PASSWORD STRING - ****** M Database User Password from secret

Consumer Adapter Service Parameters

Table 3-4 Consumer Adapter Service Parameters

Parameter Name Data Type Default Value Mandatory(M)/Optional(O)/Conditional(C)
OCNADD_CONSUMER_ADAPTER_PORT Integer 9182 M
OCNADD_CONSUMER_ADAPTER_PROTOCOL String http M
OCNADD_CONSUMER_ADAPTER_SERVICE_NAME String ocnadd-consumeradapter M
CONSUMER_ADAPTER_SELF_URL String ${protocol}://${spring.application.name}:${server.port}/ocnadd-consumeradapter/v1/notifications O
EGRESS_GATEWAY_ENDPOINT String http://10.75.245.109:32122/ M
THIRD_PARTY_CONSUMER-ENDPOINT String http://10.75.245.109:30513/ocdd-consumer/v1/messages M
BOOTSTRAP_SERVER String 10.75.245.109:30511 M
OCNADD_CONSUMER_ADAPTER_TOPIC String FILTER M
OCNADD_CONSUMER_ADAPTER_CONFIGURATION_NAME String first1 M
OCNADD_CONSUMER_ADAPTER_FETCH_MIN_BYTES String 1024 M
OCNADD_CONSUMER_ADAPTER_FETCH_MAX_WAIT_MS String 50 M
OCNADD_CONSUMER_ADAPTER_FETCH_MAX_BYTES String 52428800 M
OCNADD_CONSUMER_ADAPTER_MAX_PARTITION_FETCH_BYTES String 250000000 M
OCNADD_CONSUMER_ADAPTER_AUTO_OFFSET_RESET String earliest M
OCNADD_CONSUMER_ADAPTER_MAX_POLL_RECORDS String 10000 M
OCNADD_CONSUMER_ADAPTER_AUTO_COMMIT String false M
OCNADD_CONFIGURATION_SERVICE_API_ROOT String http://localhost:9192/ocnadd-configuration/v1/subscription M
OCNADD_CONSUMER_ADAPTER_ENABLE_FIRE_AND_IGNORE String true M
OCNADD_CONSUMER_ADAPTER_PAGE_NUMBER String 10 M
OCNADD_CONSUMER_ADAPTER_PAGE_SIZE String 100 M
EGRESS_RETRY_INTERVAL Integer 10000 M
INITIAL_DATA_DELIVERY_DELAY Integer 0 -
SERVICEID_RETRY Integer 20 -
OCNADD_CONSUMER_ADAPTER_CONFIG_RETRY_COUNT Integer 0 -
OCNADD_CONSUMER_ADAPTER_CONFIG_RETRY_DELAY Integer 10 -
CONNECTION_THRESHOLD Integer 5 -
PUBLISHER_THRESHOLD Integer 1000 -
THIRD_PARTY_RETRY_INTERVAL_MS Integer 10000 -
OCNADD_CONSUMER_ADAPTER_MAX_PARTITION Integer 15 -
KAFKA_SESSION_TIMEOUT_MS Integer 5000 -
CONFIGURATION_HTTP2_ENABLED String true -
CONFIGURATION_SSL_ENABLED String false -
OCNADD_SSL_KEY_TYPE String PKCS12 -
OCNADD_SSL_KEY_STORE - - -
OCNADD_SSL_KEY_STORE_PASSWORD String secret -
OCNADD_SSL_TRUST_TYPE String PKCS12 -
OCNADD_SSL_TRUST_STORE - - -
OCNADD_SSL_KEY_TRUST_PASSWORD String secret M
OCNADD_TRUST_CLIENT_KEY_STORE - - M
OCNADD_TRUST_CLIENT_TRUST_STORE String src/main/resources/keystore/clientTrustStore.p12 M
OCNADD_TRUST_CLIENT_PASSWORD String secret M
OCNADD_TRUST_CLIENT_KEY_TYPE String PKCS12 M
OCNADD_TRUST_KEYSTORE String true M
OCNADD_TRUST_PASSWORD String secret M
OCNADD_CONSUMER_ADAPTER_TARGET_CONSUMER_NAME Integer 100 M
ADAPTER_TIMEOUT Integer 10 M
ADAPTER_CHANNEL_TIMEOUT Integer 60 M
ADAPTER_CONN_POOL_MAX_CNT Integer 400 M
ADAPTER_CONN_POOL_MAX_IDLE Integer 90 M
ADAPTER_CONN_POOL_MAX_LIFE Integer 3600 M
ADAPTER_CONN_POOL_MAX_PENDING Integer 50 M
ADAPTER_PENDING_CONN Integer 50 M
ADAPTER_KEEPALIVE_IDLE Integer 60 M
ADAPTER_KEEPALIVE_INT Integer 60 M
ADAPTER_KEEPALIVE_CNT: Integer 10 M
ADAPTER_PUBLISHER_TIMEOUT Integer 12 M
OCWEBCLIENT_TIMEOUT Integer 60 O
OCWBCLIENT_CHANNEL_TIMEOUT Integer 60 O
OCWEBCLIENT_SSL_HANDSHAKE_TIMEOUT Integer 30 O
OCWEBCLIENT_SSL_FLUSH_TIMEOUT Integer 10 O
OCWEBCLIENT_SSL_READ_TIMEOUT Integer 10 O
OCWEBCLIENT_CONN_POOL_MAX_CNT Integer 50 O
OCWEBCLIENT_CONN_POOL_MAX_IDLE Integer 60 O
OCWEBCLIENT_CONN_POOL_MAX_LIFE Integer 120 O
OCWEBCLIENT_CONN_POOL_MAX_PENDING Integer 120 O
OCWEBCLIENT_KEEPALIVE_IDLE Integer 60 O
OCWEBCLIENT_KEEPALIVE_INT Integer 60 O
OCWEBCLIENT_KEEPALIVE_CNT Integer 10 O
OCNADD_CONSUMER_ADAPTER_MAX_REPLICA Integer 1 M
OCNADD_ALARM_SVC_URL String - M
SPRING_MVC_LOG_DETAILS String true M
ADAPTER_LOG_LEVEL String INFO M
OCNADD_CONSUMER_ADAPTER_LOG_LEVEL String INFO M
OCNADD_CONFIGURATION_SERVICE_LOG_FILENAME String configuration-service.log M
OCNADD_CONSUMER_ADAPTER_HEALTH_RETRY_COUNT Integer 3 M
OCNADD_CONSUMER_ADAPTER_HEALTH_RETRY_DELAY Integer 10 M
OCNADD_CONSUMER_ADAPTER_HEALTH_ENDPOINT Integer - M
OCNADD_CONSUMER_ADAPTER_HEALTH_HB_TIMER Integer 120000 M
OCNADD_CONSUMER_ADAPTER_HEALTH_SVC_TYPE String CONSUMER_ADAPTER M
OCNADD_CONSUMER_ADAPTER_HEALTH_SELF_ENDPOINT String https://ocnadd-consumeradapter:9182/healthmonitoring M

Health Monitoring and Alarm Service Parameters

Table 3-5 Health Monitoring Service Parameters

Parameter Name Data Type Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
DD_HEALTH_PROFILE_ACTIVE STRING Prod M Service profile
ALARM_SERVICE_URL STRING http://ocnaddalarm:9099/ocnadd-alarm/v1 M Alarm Application URL
ALARM_FOR_DEREGISTEREDSERVICE BOOLEAN True M Alarm on deregistered service
HEALTH_MONITORING_TIMER INTEGER 5000 M Timer to check Health of integrated services
HEALTH_METRICS_SCHEDULED BOOLEAN FALSE M Scheduler for metrics
HEALTH_METRICS_TIMER INTEGER 120000 M Timer for health metrics
HEALTH_PURGE_TIME_HR INTEGER 24 M 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
HEALTH_LOG_REQUEST_DETAILS BOOLEAN TRUE O Set detailed log for spring mvc
HEALTH_APPLICATION_LOG_LEVEL STRING INFO O Set application logger level
DATA Source Properties
DB_URL STRING jdbc:mysql://<DB_HOST>:<DB_PORT>/<HEALTH SCHEMA> M Ip address of Database service
MYSQL_USER STRING <Secret> M Database User name
MYSQL_PASSWORD STRING <Secret> M Database User Password
SHOW_SQL BOOLEAN FALSE O Whether to enable logging of SQL statements.
LOGGING_LEVEL_SQL STRING INFO O SQL Logs
HTTP2 Properties
HEALTH_SSL_ENABLED BOOLEAN FALSE M whether to enable ssl

Table 3-6 Alarm Service Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
OCNADD_ALARM_PORT INTEGER - 9099 M Server HTTP port
OCNADD_ALARM_PROFILE STRING dev,prod prod M Alarm Service Profile (choose Based on Environment)
Alarm Purging Properties
ALARM_PURGE_DAYS INTEGER >1 30 M Delete the Alarms which are terminated more than this no of days
ALARM_SCHEDULED_CRON STRING - 0 0 0 * * 0 M

cron expression for scheduled deletion of alarms.

Default: once a week or can also mention macros i.e( @yearly,@monthly,@weekly,@daily,@hourly,@midnight)
Logging Properties
ALARM_WEB_LOG_LEVEL STRING - INFO O Set Default Log level for Spring Web
ALARM_ROOT_LOG_LEVEL STRING - INFO O Set Default Log Level for Spring Application
ALARM_LOGGING_TYPE STRING STDOUT/LOGJSON STDOUT O Logging Type Standard Out / JSON
JPA Properties
ALARM_DB_SHOW_SQL BOOLEAN - false O Whether to enable logging of SQL statements.
ALARM_DB_SQL_COMMENTS BOOLEAN - true O If turned on, Hibernate will generate comments inside the SQL, for easier debugging, defaults to 
false
.
ALARM_DB_QUERY_TIMEOUT INTEGER - 30000 M sets the length of time to wait for an SQL request to complete.
ALARM_DB_LOCK_TIMEOUT INTEGER - 30000 M sets the length of time to wait on a blocked resource.
DATA Source Properties
MYSQL_URL STRING - localhost M Ip address of Database service
MYSQL_PORT INTEGER - 3306 M Port for Database service
ALARM_SCHEMA_NAME STRING - alarm_schema M Name of Alarm Schema
DB_DATASOURCE_USER STRING - ocdd M Database User name
DB_DATASOURCE_PASSWORD STRING - ocdd M Database User Password
HTTP2 Properties
ALARM_SSL_ENABLED BOOLEAN - false M whether to enable ssl

Admin Service Parameters

Table 3-7 Admin Service Parameters

Parameter Name Data Type Default Value Mandatory(M)/Optional(O)/Conditional(C) Description
ADMINSVC_HTTP2_ENABLED BOOLEAN true M Whether to enable HTTP2
ADMINSVC_SSL_ENABLED BOOLEAN false M Whether to enable ssl
OCNADD_SSL_KEY_TYPE STRING PKCS12 M -
OCNADD_SSL_KEY_STORE STRING - M -
OCNADD_SSL_KEY_STORE_PASSWORD STRING - M -
OCNADD_SSL_TRUST_TYPE STRING PKCS12 M -
OCNADD_SSL_TRUST_STORE STRING - M -
OCNADD_SSL_KEY_TRUST_PASSWORD STRING - M -
OCNADD_TRUST_CLIENT_KEY_STORE STRING - M -
OCNADD_TRUST_CLIENT_TRUST_STORE STRING - M -
OCNADD_TRUST_CLIENT_PASSWORD STRING - M -
OCNADD_TRUST_CLIENT_KEY_TYPE STRING PKCS12 M -
OCNADD_TRUST_KEYSTORE STRING - M -
OCNADD_TRUST_PASSWORD STRING - M -
OCWebClient
OCWEBCLIENT_TIMEOUT INTEGER 60 M -
OCWBCLIENT_CHANNEL_TIMEOUT INTEGER 60 M -
OCWEBCLIENT_SSL_HANDSHAKE_TIMEOUT INTEGER 30 M -
OCWEBCLIENT_SSL_FLUSH_TIMEOUT INTEGER 10 M -
OCWEBCLIENT_SSL_READ_TIMEOUT INTEGER 10 M -
OCWEBCLIENT_CONN_POOL_MAX_CNT INTEGER 50 M -
OCWEBCLIENT_CONN_POOL_MAX_IDLE INTEGER 60 M -
OCWEBCLIENT_CONN_POOL_MAX_LIFE INTEGER 120 M -
OCWEBCLIENT_CONN_POOL_MAX_PENDING INTEGER 120 M -
OCWEBCLIENT_KEEPALIVE_IDLE INTEGER 60 M -
OCWEBCLIENT_KEEPALIVE_INT INTEGER 60 M -
OCWEBCLIENT_KEEPALIVE_CNT INTEGER 10 M -
Configurable Kafka parameters and their default values
OCNADD_KAFKA_BOOTSTRAP_SERVER URL - M -
Configurable Kubernetes Parameters
OCNADD_NAMESPACE STRING - M -
OCNADD_NODE_NAME STRING - M -
OCNADD_NODE_KEY STRING - M -
OCNADD_NODE_OPERATOR STRING In M -
OCNADD_STORAGE_CLASS STRING standard M -
Consumer Adapter Properties
OCNADD_CONSUMER_GROUP_NAME STRING consumer M -
OCNADD_EGRESS_GATEWAY_ENDPOINT URL - M -
OCNADD_THIRD_PARTY_CONSUMER_ENDPOINT URL - M -
OCNADD_CONSUMER_ADAPTER_IMAGE_NAME STRING - M -
OCNADD_CONSUMER_GROUP_MAX_REPLICAS INTEGER 1 M -
OCNADD_SERVICE_ACCOUNT STRING - M -
OCNADD_CONSUMER_TOPIC_NAME STRING FILTER M -
CONFIGURATION_SERVICE_API_ROOT URL - M -
OCNADD_CONSUMER_PORT INTEGER - M -
OCNADD_CONSUMER_PROTOCOL STRING - M -
OCNADD_CONSUMER_ADAPTER_SERVICE_NAME STRING - M -
CONSUMER_ADAPTER_SELF_URL URL ocnaddconsumeradapter M -
OCNADD_ADMINSVC_HEALTH_RETRY_COUNT INTEGER 3 M -
OCNADD_ADMINSVC_HEALTH_RETRY_DELAY INTEGER 10 M -
OCNADD_ADMINSVC_HEALTH_ENDPOINT URL - M -
OCNADD_ADMINSVC_HEALTH_HB_TIMER INTEGER 120000 M -
OCNADD_ADMINSVC_HEALTH_SVC_TYPE STRING - M -
OCNADD_ADMINSVC_HEALTH_SELF_ENDPOINT URL - M -
ALARM_SERVICE_URL URL - M -
Egress Gateway Parameter
OCNADD_NAMESPACE STRING <namespace> M Namespace to spawn egw
OCNADD_CONSUMER_EGW_TLS_CN STRING egw M Suffix for egw configuration
OCNADD_CONSUMER_EGW_IMAGE_PULLPOLICY STRING IfNotPresent M Image Pull Policy for deployment
OCNADD_CONSUMER_EGW_IMAGE_PULLSECRET STRING <secret> M Image pull secret to pull image from Repo
OCNADD_CONSUMER_EGW_INIT_IMAGE STRING <Init Image> O Init Image
OCNADD_CONSUMER_EGW_IMAGE_NAME STRING <EGW Image> M Image to spawn Egw
OCNADD_CONSUMER_EGW_CPU_LIMIT STRING 4 M CPU Limit for EGW
OCNADD_CONSUMER_EGW_CPU_REQUEST STRING 4 M CPU Min requirement for EGW
OCNADD_CONSUMER_EGW_MEMORY_LIMIT STRING 6Gi M Memory limit for EGW
OCNADD_CONSUMER_EGW_MEMORY_REQUEST STRING 6Gi M Memory Min Requirement for EGW
OCNADD_CONSUMER_EGW_MAX_REPLICA INTEGER 16 M Max Replicas for EGW
OCNADD_CONSUMER_EGW_MIN_REPLICA INTEGER 1 M Min Replicas for EGW
OCNADD_CONSUMER_EGW_MAX_SURGE INTEGER 1 M Amount of pods more than the desired number of Pods
OCNADD_CONSUMER_EGW_MAX_UNAVAILABLE INTEGER 0 M Amount of pods that can be unavailable during the update process
OCNADD_CONSUMER_EGW_BOOTUP_MINREADYSEC INTEGER 0 M The bootup time of your application, Kubernetes waits specific time till the next pod creation to serve traffic
OCNADD_CONSUMER_EGW_AVG_CPU_UTIL INTEGER 70 M Average CPU Utilization
OCNADD_CONSUMER_EGW_POD_SCALE_DOWN INTEGER 1 M No. of pod scale down
OCNADD_CONSUMER_EGW_POD_SCALE_DOWN_PERIOD INTEGER 30 M Scale down in seconds
OCNADD_CONSUMER_EGW_POD_SCALE_DOWN_STABLE INTEGER 60 M Stabilization period in seconds post which scale down starts
OCNADD_DEPLOYMENT_TERMINATION_GRACE INTEGER 30 M Grace Termination of Pods in seconds
OCNADD_CONSUMER_EGW_PROFILE_ACTIVE STRING prod M Active profile
OCNADD_CONSUMER_EGW_HTTP_CLIENT_POOL_MAX_ACQUIRE INTEGER 60000 O Max time to acquire connection pool in ms
OCNADD_CONSUMER_EGW_HTTP_CLIENT_POOL_MAX_CONN INTEGER 300 O Max number of connections per pool
OCNADD_CONSUMER_EGW_HTTP_CLIENT_POOL_MAX_IDLE INTEGER 40 O Max number of connection in a pool to be idle
OCNADD_CONSUMER_EGW_HTTP_CLIENT_CONNECT_TIMEOUT INTEGER 30000 O Connection timeout parameter
OCNADD_CONSUMER_EGW_HTTP_CLIENT_RESPONSE_TIMEOUT STRING 8s O Response timeout parameter
OCNADD_EGW_EMPHEMERAL_STORAGE_LIMIT STRING 400Mi M Ephemeral storage Max
OCNADD_EGW_EMPHEMERAL_STORAGE_REQUEST STRING 200Mi M Ephemeral storage Min
ENABLE_EGW_COUNTER_METRICS BOOLEAN true M Counter Metrics Enable
ENABLE_EGW_LATENCY_METRICS BOOLEAN true M Latency Metrics Enable
OCNADD_EGW_LIVENESS_DELAY INTEGER 60 O Pod liveliness delay
OCNADD_EGW_LIVENESS_PERIOD INTEGER 15 O Pod liveliness Timeperiod
OCNADD_EGW_LIVENESS_FAILURE INTEGER 5 O Liveliness failure in seconds
OCNADD_EGW_LIVENESS_TIMEOUT INTEGER 20 O Pod Liveliness Timeout
EGW_MIN_EXPECTED_VALUE_LATENCY_MS INTEGER 50 M Min expected latency for metrics
EGW_MAX_EXPECTED_VALUE_LATENCY_MS INTEGER 50 M Max expected latency for metrics
EGW_MIN_EXPECTED_VALUE_ETE_LATENCY_MS INTEGER 50 M Min expected latency for metrics
EGW_MAX_EXPECTED_VALUE_ETE_LATENCY_MS INTEGER 50 M Max expected latency for metrics
Logging
SPRING_MVC_LOG_LEVEL STRING INFO M Mvc logs
SPRING_MVC_LOG_TYPE STRING STDOUT M STDOUT output in pod logs

Kafka Configuration Parameters

Table 3-8 Kafka Configuration Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/ Optional(O)/ Conditional(C) Description
chart.name String   ocdd-kafka M Defines the name of the kafka chart
broker.id Int   -1 M

Gives the broker an int as an identifier.

-1 will let the cluster choose an unqiue identifier automatically
delete.topic.enable boolean   true C Enables the feature of deleting a topic
group.initial.rebalance.delay.ms Int   20   The amount of time the group coordinator will wait for more consumers to join a new group before performing the first rebalance.
log.dir String   /tmp/kafka-logs M The path to store the kafka logs
zookeeper.ssl.client.enable boolean   true M To enable or disable ssl in the connection between the kafka broker and the zookeeper
zookeeper.ssl.protocol String   TLSv1.2 M SSL protocol for connection between kafka broker and zookeeper
zookeeper.ssl.truststore.location String     M Path to where the zookeeper truststore is mounted.
zookeeper.ssl.truststore.password String     M Password for the zookeeper truststore
zookeeper.ssl.keystore.location String     M Path to where the zookeeper keystore is mounted.
zookeeper.ssl.keystore.password String     M Password for the zookeeper keystore
security.inter.broker.protocol String   PLAINTEXT M Protocol for inter broker communication
auto.create.topics.enable boolean   false   When set to true, when applications attempt to produce, consume, or fetch metadata for a non-existent topic, Kafka will automatically create the topic with the default replication factor and number of partitions.
super.users String       Super users are allowed to perform any operation on any resource in a Kafka cluster
kafkaBroker.name String       Name of the kafka broker
minReplicas Int   1   The minumum number of replicas that must be available at all times
maxReplicas Int   2   The maximum number of replicas allowed for the pod
replicas Int   1   The number of replicas that you want to be available for the pod
target.averageCpuUtilPercentage Int   50   The target average CPU utilization percentage
target.memoryUtilPercentage Int   80   The target average memory utilization percentage
container.port     9098   The port which at which the kafka container is exposed for connection
container.saslPort     9099   The port which at which the kafka container is exposed for SASL connection
kafkaBroker.container.image String       The url of the kafka image that is to be pulled
kafkaBroker.container.pullPolicy String   IfNotPresent   The image pull policy for the container.image
sharedVolumeName String       The name of the volume that is mounted
mountPath String       The path within the container where the volume will be mounted
resource.requests.cpu Int       The requested number of CPU cores
resource.requests.memory String       The requested size of memory
resource.limits.cpu         The maximum limit for the number of CPUs used for the container
resource.limits.memory Int       The maximum limit for the size of the memory used for the container
partitions Int       The number of partitions in the broker
replicationFactor Int       The number of copies of the partitions that are to be maintained
kafkaSvcName String       The name of the kafka service name
service.type String       The type of the kafka service
serivce.targetPort         The port at which the service will send requests to
service.saslSslTargetPort         The port at which the service will send SASL requests to
delete.topic.enable boolean   true C Enables the feature of deleting a topic
group.initial.rebalance.delay.ms Int   20   The amount of time the group coordinator will wait for more consumers to join a new group before performing the first rebalance.
log.dir String M /tmp/kafka-logs   The path to store the kafka logs
zookeeper.ssl.client.enable boolean M true   To enable or disable ssl in the connection between the kafka broker and the zookeeper
zookeeper.ssl.protocol String M TLSv1.2   SSL protocol for connection between kafka broker and zookeeper
zookeeper.ssl.truststore.location String M     Path to where the zookeeper truststore is mounted.
zookeeper.ssl.truststore.password String M     Password for the zookeeper truststore
zookeeper.ssl.keystore.location String M     Path to where the zookeeper keystore is mounted.
zookeeper.ssl.keystore.password String M     Password for the zookeeper keystore
ssl.truststore.location         Path to where the truststore for connection between broker and clients is mounted.
ssl.truststore.password         Password of the truststore for conection between broker and clients.
ssl.keystore.location         Path to where the keystore for coneection between broker and clients is mounted.
ssl.keystore.password         Password of the keystore for conection between broker and clients.
num.io.threads     8   Number of threads that pick up requests from the request queue to process them
num.network.threads         Network threads handle requests to the Kafka cluster, such as produce and fetch requests from client applications
socket.send.buffer.bytes         Denotes the value of the buffer size for sending messages
socket.receive.buffer.bytes         Denotes the value of the buffer size for receiving messages
num.recovery.threads.per.data.dir         This parameter is used to specify the number of threads used for log loading at startup and flushing at shutdown.

Backend Router Parameters

Table 3-9 Backend Router Parameters

Parameter Name Data Type Range Default Value Mandatory(M)/ Optional(O)/ Conditional(C) Description
OCNADD_BKNROUTER_APPLICATION_NAME String   ocnaddbackendrouter M Application Name
OCNADD_BKNROUTER_PORT Int   8988 M Server port
OCNADD_BKNROUTER_ROOT_LOG_LEVEL String   INFO  

Root log level configuration

(INFO,DEBUG,ERROR)
OCNADD_BKNROUTER_COM_LOG_LEVEL String   INFO  

Log level configuration

(INFO,DEBUG,ERROR)
OCNADD_BKNROUTER_LOG_LEVEL String   INFO  

Log level configuration

(INFO,DEBUG,ERROR)
OCNADD_BKNROUTER_LOG_FILENAME String   var/occne/ocnaddbackendrouter.dir   Log file directory update.
OCNADD_BKNROUTER_CONFIG_REDIRECTURI String   http://ocnaddconfiguration:12590 M Configuration service URl
OCNADD_BKNROUTER_HEALTHSVC_REDIRECTURI String   http://ocnaddhealthmonitoring:12591 M Health service URI
OCNADD_BKNROUTER_AlARM_REDIRECTURI String   http://ocnaddalarm:9099 M Alarm Service URI
OCNADD_BKNROUTER_CONFIG_PATH_PATERN String   /ocnadd-configuration/**    
OCNADD_BKNROUTER_HEALTH_PATH_PATERN String   /ocnaddapi/ocnadd-health/**    
WEBCLIENT_MAX_BUFFER_SIZE String   17777216