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 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 |
| ocnaddgui.enabled | BOOLEAN | true/false | true | M | To enabled gui charts |
| env.ocwebclient.OCWEBCLIENT_TIMEOUT | INTEGER | - | 30 | O | Webclient timeout in seconds |
| env.ocwebclient.OCWEBCLIENT_KEEPALIVE_IDLE | INTEGER | - | 90 | O | 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 |
| initContainers.name | STRING | - | ocnaddinitcontainer | M | Name of initContainer for SSL support |
| initContainers.image | STRING | - | jdk17-openssl:1.0.6 | M | InitContainer Image |
| initContainers.REPO_PATH | STRING | - | utils.repo | M | Repo path where init image is stored |
| initContainers.volumeMounts.ts_ks_volumeName | STRING | - | truststore-keystore-volume | M | Volume name for truststore |
| initContainers.volumeMounts.ts_ks_volumePath | STRING | - | /var/securityfiles/keystore | M | Path where keystore files are stored |
| initContainers.volumeMounts.certificateName | STRING | - | client-server-certificate | M | Volume name for server certificates |
| initContainers.volumeMounts.certificatePath | STRING | - | /var/securityfiles/certs | M | Path where cert files are stored |
| initContainers.env.cert_file_params.SERVER_CERT_FILE | STRING | - | servercert.pem | M | Server cert filename |
| initContainers.env.cert_file_params.CLIENT_CERT_FILE | STRING | - | clientcert.pem | M | Client cert filename |
| initContainers.env.cert_file_params.SERVER_KEY_FILE | STRING | - | serverprivatekey.pem | M | Server Private Key filename |
| initContainers.env.cert_file_params.CLIENT_KEY_FILE | STRING | - | clientprivatekey.pem | M | Client Private Key filename |
| initContainers.env.ks_file_params.SERVER_KEY_STORE | STRING | - | serverKeyStore.p12 | M | Server Keystore file |
| initContainers.env.ks_file_params.CLIENT_KEY_STORE | STRING | - | clientKeyStore.p12 | M | Client Keystore file |
| initContainers.env.ks_file_params.TRUST_STORE | STRING | - | trustStore.p12 | M | Truststore file |
| initContainers.cacert.key | STRING | - | CA_CERT_FILE | M | Cacert key file |
| initContainers.cacert.value | STRING | - | 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 |
| image.ocnaddadminsvc.name | STRING | ocnaddadminsvc:1.0.72 | M | Admin Service Image | |
| image.ocnaddconsumeradapter.name | STRING | ocnaddconsumeradapter:1.0.76 | M | Consumer Adapter Image | |
| image.ocnaddaggregation.name | STRING | ocnaddaggregation:1.0.51 | M | Aggregation Service Image | |
| image.ocnaddalarm.name | STRING | ocnaddalarm:1.0.45 | M | Alarm Service Image | |
| image.ocnaddconfiguration.name | ocnaddfilter:1.0.29-dev | ocnaddconfiguration:1.0.61 | M | Configuration Service Image | |
| image.ocnaddegressgateway.name | STRING | ocnaddegressgateway:1.0.41-dev | M | Egress gateway image | |
| image.ocnaddfilter.name | STRING | ocnaddfilter:1.0.29-dev | M | Filter Service Image | |
| image.ocnaddhealthmonitoring.name | STRING | ocnaddhealthmonitoring:1.0.52 | M | Health Monitoring Image | |
| image.ocnaddbackendrouter.name | STRING | ocnaddbackendrouter:1.0.48 | M | Backend Router Image | |
| image.ocnaddbackuprestore.name | STRING | ocnaddbackuprestore:1.0.7 | M | Backup Restore Image | |
| image.ocnadd_kafka_healthclient.name | STRING | ocnadd-kafka-healthclient-3.2.3:1.0.11 | M | Kafka Image | |
| image.ocnadd_jmx_exporter.name | STRING | jmx-exporter-jdk-17.0.6:0.17.2 | M | JMX exporter image | |
| image.ocnaddaggregation.name | STRING | ocnaddgui:23.6.9-feature-mergeTest | M | OCNADD GUI Image | |
| cluster.clusterName | STRING | occne-ocdd | M | Default cluster name of setup | |
| cluster.secret.name | STRING | db-secret | M | Database Secret name where DB credentials are stored | |
| cluster.mysqlNameSpace.name | STRING | occne-cndbtierone | M | DBTier namespace | |
| cluster.mysqlPod | STRING | ndbmysqld-0 | M | DBTier Pod Name | |
| cluster.database.db_ip | STRING | mysql-connectivity-service.occne-cndbtierone | M | Hostname or IP of DBTier | |
| cluster.database.db_port | INTEGER | 3306 | M | DB Port | |
| cluster.database.configuration_db | STRING | configuration_schema | M | Configuration Service Schema Name | |
| cluster.database.alarm_db | STRING | alarm_schema | M | Alarm Service Schema Name | |
| cluster.database.health_db | STRING | healthdb_schema | M | Health Service Schema Name | |
| cluster.storageClass | STRING | standard | M | Storage Class Name | |
| cluster.nameSpace.name | STRING | - | ocnadd-deploy | M | OCNADD Namespace |
| cluster.serviceAccount.create | BOOLEAN | true/false | true | M | To create a ServiceAccount (true/false) |
| cluster.clusterRole.create | BOOLEAN | true/false | true | M | To create clusterRole (true/false) |
| cluster.clusterRoleBinding.create | BOOLEAN | true/false | true | M | To create clusterRoleBinding (true/false) |
| cluster.terminationGracePeriodSeconds | INTEGER | - | 5 | O | Pod grace termination |
| cluster.imagePullSecret.enable | BOOLEAN | true/false | false | M | Image Pull secret creation |
| cluster.imagePullSecret.name | STRING | - | regcred | O | Set to regcred if cluster.imagePullSecret.enable is true |
| cluster.kafka.ocnadd_kafka_bootstrap_servers | STRING | - | kafka-broker:9092 | M | Bootstrap server for PLAINTEXT |
| cluster.kafka.ocnadd_kafka_bootstrap_servers_ssl | STRING | - | kafka-broker:9093 | M | Bootstrap server for SSL |
| cluster.kafka.ocnadd_kafka_bootstrap_servers_sasl | STRING | - | kafka-broker:9094 | M | Bootstrap server for SASL |
| cluster.prometheusScrapePort | INTEGER | - | 9000 | O | Port to scape metrics required if metrics enabled |
| cluster.prometheusPortName | STRING | - | cnc-metrics | O | Role required to define in alert rules yaml |
| cluster.max_latency | FLOAT | - | 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] | 70 | M | CPU max threshold limit |
| cluster.mps | INTEGER | - | 55000 | M | Default MPS rate |
| cluster.egwGroupLatencyMessageCountMax | INTEGER | - | 50 | M | Max latency count for Egress Gateway |
| cluster.prometheus_url | STRING | - | 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 | - |
- 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 | - | - 10.0.0.0/8 | C | Cidr for network communication |
| network.egress.denyall | BOOLEAN | true/false | false | C | Deny egress traffic |
3.2 Helm Hook Parameters
Table 3-2 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 | - | pre-install-image:1.0.5 | M | Image used for pre-install 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 |
3.3 Aggregation Service Parameters
Table 3-3 Aggregation Service Parameters
| Parameter Name | Data Type | Range | Default Value | Mandatory(M)/Optional(O)/Conditional(C) | Description |
|---|---|---|---|---|---|
| ocnaddnrfaggregation.name | STRING | - | ocnaddnrfaggregation | M | Name of the application |
| ocnaddscpaggregation.name | STRING | - | ocnaddscpaggregation | M | Name of the application |
| ocnaddseppaggregation.name | STRING | - | ocnaddnrfaggregation | M | Name of the application |
| ocnaddnrfaggregation.resources.limit.cpu | INTEGER | - | 3 | M | Number of max CPU for NRF Aggregation |
| ocnaddnrfaggregation.resources.limit.memory | STRING | - | 2Gi | M | Max Memory limit for NRF Aggregation |
| ocnaddnrfaggregation.resources.limit.ephemeralstorage | STRING | - | 500Mi | M | Ephemeral Storage for NRF Aggregation |
| ocnaddscpaggregation.resources.limit.cpu | INTEGER | - | 3 | M | Number of max CPU for SCP Aggregation |
| ocnaddscpaggregation.resources.limit.memory | STRING | - | 2Gi | M | Max Memory limit for SCP Aggregation |
| ocnaddscpaggregation.resources.limit.ephemeralstorage | STRING | - | 500Mi | M | Ephemeral Storage for SCP Aggregation |
| ocnaddseppaggregation.resources.limit.cpu | INTEGER | - | 3 | M | Number of max CPU for SEPP Aggregation |
| ocnaddseppaggregation.resources.limit.memory | STRING | - | 2Gi | M | Max Memory limit for SEPP Aggregation |
| ocnaddseppaggregation.resources.limit.ephemeralstorage | STRING | - | 500Mi | M | Ephemeral Storage for SEPP Aggregation |
| 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_SERVICE_TOPIC_RETRIES_THRESHOLD | INTEGER | - | 120000 | O | Retry Threshold for TOPIC reachability |
| OCNADD_METRICS_CPU_THRESHOLD | FLOAT | [ 0, 1 ] | 0.45 | O | Parameter to compute the CPU related metrics of the application. |
| OCNADD_METRICS_MEM_THRESHOLD | FLOAT | [ 0, 1 ] | 0.95 | O | Parameter to compute the Memory related metrics of the application. |
| ALARM_SERVICE_URL | STRING | - | http://ocnaddalarm:9099 | M | Alarm Service API Root to raise alarm |
| KAFKA_PRODUCER_SECURITY_PROTOCOL | STRING | - | PLAINTEXT | M | Kafka Producer Secutiry Protocol. |
| 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-broker:9092 | M | Kafka Boot strap server address. |
| KAFKA_MAX_AGE_CONFIG | INTEGER | - | 7500 | M | The period of time in milliseconds after which we force a refresh of metadata. |
| OCNADD_TRUST_KEYSTORE | BOOLEAN | true, false | true | M | Enable to secure connection via OCWeb Client. |
| KAFKA_FETCH_MIN_BYTES | STRING | - | 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_MAX_PARTITIONS_FETCH_BYTES | INTEGER | - | 104858 | 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 | - | 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() |
| 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 |
| KAFKA_SOCKET_BYTES_BUFFER | INTEGER | - | 104857 | O | Kafka Socket Buffer setting for consumer |
3.4 Configuration Service Parameters
Table 3-4 Configuration Service Parameters
| Parameter Name | Data Type | Range | Default Value | Mandatory(M)/Optional(O)/Conditional(C) | Description |
|---|---|---|---|---|---|
| ocnaddconfiguration.name | STRING | - | ocnaddconfiguration | M | Name of configuration service |
| logging.type | STRING | STDOUT/LOGJSON | STDOUT | O | Logging type Standard Output or JSON format |
| logging.level.reactor.netty | STRING | - | INFO | O | Netty logging level |
| OCNADD_TRUST_KEYSTORE | BOOLEAN | - | false | O | Truststore enable for Configuration Service |
| 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 |
3.5 Health Monitoring and Alarm Service Parameters
Table 3-5 Health Monitoring Service Parameters
| Parameter Name | Data Type | Default Value | Mandatory(M)/Optional(O)/Conditional(C) | Description |
|---|---|---|---|---|
| ocnaddhealthmonitoring.name | STRING | ocnaddhealthmonitoring | M | Healthmonitoring 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 | 24 | 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 |
Table 3-6 Alarm Service Parameters
| Parameter Name | Data Type | Range | Default Value | Mandatory(M)/Optional(O)/Conditional(C) | Description |
|---|---|---|---|---|---|
| ocnaddalarm.name | STRING | - | ocnaddalarm | M | Application name for Alarm Service |
| 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 |
3.6 Admin Service Parameters
Table 3-7 Admin Service Parameters
| Parameter Name | Data Type | Range | Default Value | Mandatory(M)/Optional(O)/Conditional(C) | Description |
|---|---|---|---|---|---|
| ocnadd.admin.name | STRING | - | ocnaddadminservice | M | Application name admin service |
| Environment Variables | |||||
| OCNADD_ADAPTER_LOG_LEVEL_NETTY | STRING | - | INFO | O | Netty log level |
| OCNADD_ADAPTER_LOG_LEVEL | STRING | - | INFO | O | Adapter service log level |
| 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 |
| OCNADD_ADAPTER_MIN_REPLICAS | INTEGER | - | 2 | M | Minimum Replicas for Adapter |
| OCNADD_ADAPTER_MAX_REPLICAS | INTEGER | - | 8 | M | Max Replicas for Adapter |
| MAX_TCP_CONNECTION_PER_DEST | INTEGER | - | 1 | M | Max allowed TCP connection per destination |
| ADAPTER_KAFKA_FETCH_MAX_BYTES | INTEGER | - | 576720 | O | The maximum amount of data the server should return for a fetch request |
| ADAPTER_KAFKA_MAX_PARTITION_FETCH_BYTES | INTEGER | - | 104857 | 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 | INTEGER | - | 9 | O | The number of threads to execute stream processing |
| ADAPTER_KAFKA_CONSUMER_POLL_MS | INTEGER | - | 30 | O | The amount of time in milliseconds to block waiting for input |
| ADAPTER_KAFKA_RECEIVE_BUFFER_BYTES | INTEGER | - | 104857 | M | The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. |
| ADAPTER_WEBCLIENT_TYPE | STRING | - | netty | M | Webclient Type for Adapter Service |
| OCNADD_ADAPTER_USE_TS | BOOLEAN | true/false | true | M | Parameter to enable trustore use for Adapter |
| OCNADD_ADAPTER_SERVER_SSL | BOOLEAN | true/false | false | M | Enable Server SSL for Adapter |
| EGRESS_MAX_CONNECTION_POOL_COUNT | INTEGER | - | 100 | O | Max number of connections per connection pool |
| EGRESS_SSL_HANDSHAKE_TIMEOUT | INTEGER | - | 40 | O | SSL handshake timeout |
| EGRESS_SSL_CLOSE_NOTIFY_FLUSH_TIMEOUT | INTEGER | - | 20 | O | HttpClient Notify Flush timeout |
| EGRESS_SSL_CLOSE_NOTIFY_READ_TIMEOUT | INTEGER | - | 20 | O | HttpClient Notify Read timeout |
| EGRESS_CLIENT_MAX_INMEMORY | INTEGER | - | 12 | O | Webclient Max In Memory in Mb |
| EGRESS_JETTY_MAX_CONNECTION_PER_DESTINATION | INTEGER | - | 12 | O | Jetty Max Connection per Destination |
| EGRESS_JETTY_MAX_REQUEST_PER_DESTINATION | INTEGER | - | 1000 | O | Jetty Max Request per Destination |
| EGRESS_JETTY_CLIENT_IDLE_TIMEOUT | INTEGER | - | 300000 | O | Jetty client IDLE timeout |
| EGRESS_JETTY_CLIENT_CONNECT_BLOCKING | BOOLEAN | true/false | false | O | Jetty Client Connection Block Enable |
| EGRESS_JETTY_CLIENT_CONNECT_TIMEOUT | INTEGER | - | 120000 | O | Jetty Client Connection Timeout |
| EGRESS_JETTY_CLIENT_STREAM_IDLE_TIMEOUT | INTEGER | - | 300000 | O | Jetty Client Stream IDLE timeout |
| EGRESS_JETTY_CLIENT_MAX_CONCURR_PUSHED_STREAM | INTEGER | - | 12 | O | Jetty HTTP2 client max concurrent pushed stream |
| ADAPTER_TCP_CLIENT_MSG_RETRY_MAX_ATTEMPTS | INTEGER | - | 10 | O | Max TCP message retry |
| ADAPTER_TCP_CLIENT_MSG_RETRY_DELAY | INTEGER | - | 50 | O | TCP Message retry delay |
| ENABLE_ADAPTER_COUNTER_METRICS | BOOLEAN | true/false | true | O | Enable Adapter Counter Metric |
| ENABLE_ADAPTER_LATENCY_METRICS | BOOLEAN | true/false | true | O | Enable Adapter Latency Metric |
3.7 Kafka Configuration Parameters
Table 3-8 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 | 1 | The number of replicas that you want to 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 | 512 | M | Number of concurrent connections | |
| kafkaBroker.kafkaProperties.numIoThreads | Int | 640 | M | Number of threads that pick up requests from the request queue to process them | |
| kafkaBroker.kafkaProperties.numNetworkThreads | Int | 640 | M | Network threads handle requests to the Kafka cluster, such as produce and fetch requests from client applications | |
| kafkaBroker.kafkaProperties.numReplicaFetchers | Int | 512 | M | Number of fetcher threads used to replicate records from each source broker | |
| kafkaBroker.kafkaProperties.backgroundThreads | Int | 128 | 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 | 50 | 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.externalAccess.enabled | Boolean | false | M | Flag to enable External access for Kafka | |
| kafkaBroker.externalAccess.autoDiscovery | Boolean | false | M | Flag to enable auto-discovery of LoadBalancer IPs | |
| kafkaBroker.externalAccess.type | String | LoadBalancer | M | Service Type of Kafka Broker | |
| kafkaBroker.externalAccess.setstaticLoadBalancerIps | Boolean | false | M | Setting Static LoadBalancer IPs | |
| kafkaBroker.externalAccess.LoadBalancerIPList | List | [ ] | C | List if LoadBalancer Static IP available for use |
3.8 Backend Router Parameters
Table 3-9 Backend Router Parameters
| Parameter Name | Data Type | Range | Default Value | Mandatory(M)/ Optional(O)/ Conditional(C) | Description |
|---|---|---|---|---|---|
| ocnaddbackendrouter.name | String | - | ocnaddbackendrouter | M | Application name for ocnaddbackendrouter |
| OCNADD_BKNROUTER_ROOT_LOG_LEVEL | String | INFO | O |
Root log level configuration (INFO,DEBUG,ERROR) |
|
| OCNADD_BKNROUTER_COM_LOG_LEVEL | String | INFO | O |
Log level configuration (INFO,DEBUG,ERROR) |
|
| OCNADD_BKNROUTER_LOG_LEVEL | String | INFO | O |
Log level configuration (INFO,DEBUG,ERROR) |
|
| OCNADD_BKNROUTER_CLIENT_SSL_USE_TS | Boolean | true | O | Client SSL Truststore enable | |
| OCNADD_BKNROUTER_CLIENT_WIRETAP | Boolean | false | O | Client Wiretap | |
| OCNADD_BKNROUTER_SERVER_WIRETAP | Boolean | false | O | Server Wiretap | |
| WEBCLIENT_MAX_BUFFER_SIZE | String | 17777216 | O | Webclient Max buffer size for Backend router |