Helm chart values
Helm chart values description
Bellow you can find helm chart values usage with description.
Values
| Key | Type | Default | Description |
|---|---|---|---|
| additionalJobAnnotations | object | {} |
Additional annotations for jobs pods |
| additionalJobPodAnnotations | string | nil |
Additional annotations for job pods |
| additionalJobPodLabels | object | {} |
Additional labels for job pods |
| client.affinity | object | {} |
|
| client.heapSize | string | "512M" |
Set JVM parameters -Xms and -Xmx, basicaly set JVM memory size. Consider this value as a half of total pod memory. |
| client.ingress.annotations | object | {} |
Annotations for ingress object. |
| client.ingress.className | string | "" |
Opensearch ingress class name |
| client.ingress.enabled | bool | false |
Switch to enable / disable ingress for OpenSearch cluster. |
| client.ingress.host | list | [] |
Array of Opensearch ingress host names |
| client.ingress.path | string | "/" |
|
| client.ingress.tls | list | [] |
Certificate setting for hostname. |
| client.podLabels | object | {} |
Additional labels for the workload pods |
| client.priorityClass | object | {} |
|
| client.replicas | int | 1 |
Replicas count for OpenSearch client node role. |
| client.resources.limits.memory | string | "2000Mi" |
Define maximum memory allocation. |
| client.resources.requests.memory | string | "1000Mi" |
Define minimum memory allocation. |
| client.tolerations | list | [] |
|
| client.topologySpreadConstraints | list | [] |
|
| clusterManager.affinity | object | {} |
|
| clusterManager.heapSize | string | "256M" |
Set JVM parameters -Xms and -Xmx, basicaly set JVM memory size. Consider this value as a half of total pod memory. |
| clusterManager.podLabels | object | {} |
Additional labels for the workload pods |
| clusterManager.priorityClass | object | {} |
|
| clusterManager.replicas | int | 1 |
Replicas count for OpenSearch master node role. Minimal is 2. |
| clusterManager.resources.limits.memory | string | "700Mi" |
Define maximum memory allocation. |
| clusterManager.resources.requests.memory | string | "700Mi" |
Define minimum memory allocation. |
| clusterManager.storage | string | "1Gi" |
Persistent volume size. |
| clusterManager.storageClass | object | {} |
|
| clusterManager.tolerations | list | [] |
|
| clusterName | string | "logging" |
Default cluster name. |
| data.affinity | object | {} |
|
| data.heapSize | string | "512M" |
Set JVM parameters -Xms and -Xmx, basicaly set JVM memory size. Consider this value as a half of total pod memory. |
| data.podLabels | object | {} |
Additional labels for the workload pods |
| data.priorityClass | object | {} |
|
| data.replicas | int | 1 |
Replicas count for OpenSearch data node role. |
| data.resources.limits.memory | string | "2000Mi" |
Define maximum memory allocation. |
| data.resources.requests.memory | string | "1000Mi" |
Define minimum memory allocation. |
| data.storage | string | "1Gi" |
Persistent volume size. |
| data.storageClass | object | {} |
|
| data.tolerations | list | [] |
|
| data_prepper.affinity | object | {} |
|
| data_prepper.enabled | bool | false |
Switch to enable / disable DataPrepper on cluster. |
| data_prepper.heapSize | string | "256M" |
Set JVM parameters -Xms and -Xmx, basicaly set JVM memory size. Consider this value as a half of total pod memory. |
| data_prepper.image | string | "opensearchproject/data-prepper" |
Used image name. |
| data_prepper.imageTag | string | "2.6.1" |
Used component version. |
| data_prepper.podLabels | object | {} |
Additional labels for the workload pods |
| data_prepper.priorityClass | object | {} |
|
| data_prepper.replicas | int | 1 |
Replicas count for DataPrepper pods. |
| data_prepper.resources.limits.memory | string | "600Mi" |
Define maximum memory allocation. |
| data_prepper.resources.requests.memory | string | "600Mi" |
Define minimum memory allocation. |
| data_prepper.retention.purge | int | 3 |
Days to hold oldest slot |
| data_prepper.retention.slotSize | int | 10 |
Slot size in GB |
| data_prepper.tolerations | list | [] |
|
| data_prepper.topologySpreadConstraints | list | [] |
|
| fluentbit.affinity | object | {} |
|
| fluentbit.caCertificateSecret | string | "" |
|
| fluentbit.containersLogsHostPath | string | "/var/log/pods" |
|
| fluentbit.containersRuntime | string | "containerd" |
Define container runtime engine: docker or containerd. |
| fluentbit.disableTailInput | bool | false |
|
| fluentbit.enabled | bool | true |
|
| fluentbit.extraEnvs | object | {} |
|
| fluentbit.image | string | "fluent/fluent-bit" |
Used image name. |
| fluentbit.imagePullPolicy | string | "IfNotPresent" |
Image pull policy. |
| fluentbit.imageTag | string | "2.2.0" |
Used component version. |
| fluentbit.indexPrefix | string | "" |
|
| fluentbit.journalsLogsHostPath | string | "/var/log" |
|
| fluentbit.mergeLog | string | "On" |
|
| fluentbit.metrics.enabled | bool | false |
Switch to enable / disable FluentBit metrics for Prometheus. |
| fluentbit.metrics.interval | string | "30s" |
|
| fluentbit.metrics.namespace | string | "" |
|
| fluentbit.podLabels | object | {} |
Additional labels for the workload pods |
| fluentbit.priorityClass | string | "" |
|
| fluentbit.readFromHead | bool | false |
|
| fluentbit.resources.limits.memory | string | "100Mi" |
Define maximum memory allocation. |
| fluentbit.resources.requests.memory | string | "50Mi" |
Define minimum memory allocation. |
| fluentbit.tolerations[0].operator | string | "Exists" |
|
| imagePullSecrets | list | [] |
Secrets containing credentials for pulling images from private registers |
| init_container.image | string | "nickytd/init-container" |
Used image name. |
| init_container.imagePullPolicy | string | "IfNotPresent" |
Image pull policy. |
| init_container.imageTag | string | "1.1.0" |
Used component version. |
| kafka.SSLInterConnectExp | int | 60 |
Set days for SSL broker interconnect communication certificate expiration |
| kafka.affinity | object | {} |
|
| kafka.certManager | object | {"enabled":false,"issuerRef":{}} |
Settings for CertManager. |
| kafka.certManager.enabled | bool | false |
Enable / disable using CertManager instance in cluster. |
| kafka.certManager.issuerRef | object | {} |
Define CertManager Issuer object |
| kafka.enabled | bool | true |
Switch to enable / disable Kafka instance on cluster. |
| kafka.heapSize | string | "256M" |
Set JVM parameters -Xms and -Xmx, basicaly set JVM memory size. Consider this value as a half of total pod memory. |
| kafka.image | string | "bitnami/kafka" |
Used image name. |
| kafka.imagePullPolicy | string | "IfNotPresent" |
Image pull policy. |
| kafka.imageTag | string | "3.4.1" |
Used component version. |
| kafka.kraftId | string | "M2M5NGQ3ZDA5NWI1NDkxYz" |
Set Kafka cluster ID in Raft mode. If not set, default is used. Details see here. |
| kafka.podLabels | object | {} |
Additional labels for the workload pods |
| kafka.priorityClass | object | {} |
|
| kafka.replicas | int | 1 |
Replicas count for Kafka’s pods. Minimal setup with redundancy is 3 pods. |
| kafka.resources.limits.memory | string | "600Mi" |
Define maximum memory allocation. |
| kafka.resources.requests.memory | string | "600Mi" |
Define minimum memory allocation. |
| kafka.storage | string | "1Gi" |
Persistent volume size. |
| kafka.storageClass | object | {} |
|
| kafka.tolerations | list | [] |
|
| kafka.topics | list | [{"config":"max.message.bytes=10000000,retention.bytes=-1,retention.ms=3600000","name":"containers"}] |
Kafka topics definition |
| logstash.affinity | object | {} |
|
| logstash.enabled | bool | true |
Switch to enable / disable Logstash instance on cluster. |
| logstash.heapSize | string | "256M" |
Set JVM parameters -Xms and -Xmx, basicaly set JVM memory size. Consider this value as a half of total pod memory. |
| logstash.image | string | "opensearchproject/logstash-oss-with-opensearch-output-plugin" |
Used image name. |
| logstash.imageTag | string | "8.9.0" |
Used component version. |
| logstash.monitoring.enabled | bool | false |
Set true here, if you want to expose metrics. |
| logstash.monitoring.image | string | "nickytd/logstash-exporter" |
Used image name. |
| logstash.monitoring.imageTag | string | "0.3.0" |
Used component version. |
| logstash.monitoring.metricsPort | int | 9198 |
TCP port to expose Exporter processing metrics. |
| logstash.monitoring.serviceMonitor.enabled | bool | false |
|
| logstash.monitoring.serviceMonitor.namespace | string | "" |
|
| logstash.podLabels | object | {} |
Additional labels for the workload pods |
| logstash.priorityClass | object | {} |
|
| logstash.replicas | int | 1 |
Replicas count for Logstash’s pods. |
| logstash.resources.limits.memory | string | "700Mi" |
Define maximum memory allocation. |
| logstash.resources.requests.memory | string | "700Mi" |
Define minimum memory allocation. |
| logstash.tolerations | list | [] |
|
| logstash.topologySpreadConstraints | list | [] |
|
| opensearch.additionalJvmParams | string | "-Djava.net.preferIPv4Stack=true -XshowSettings:properties -XshowSettings:vm -XshowSettings:system" |
Fine tune JVM parameters passed to component. |
| opensearch.certManager | object | {"enabled":false,"issuerRef":{},"namespace":""} |
Settings for CertManager. |
| opensearch.certManager.enabled | bool | false |
Enable / disable using CertManager instance in cluster. |
| opensearch.certManager.issuerRef | object | {} |
Define CertManager Issuer object |
| opensearch.certManager.namespace | string | "" |
TODO |
| opensearch.externalOpensearch.disabled | bool | true |
|
| opensearch.externalOpensearch.url | string | "" |
|
| opensearch.image | string | "opensearchproject/opensearch" |
Used image name. |
| opensearch.imagePullPolicy | string | "IfNotPresent" |
Image pull policy. |
| opensearch.imageTag | string | "2.11.1" |
Used component version. |
| opensearch.oidc | object | (see example in values file) |
Place here your settings, if you want to authenticate via OIDC method. |
| opensearch.password | string | "osadmin" |
Password for account with admin rights |
| opensearch.retentionDays | int | 7 |
Define, how long be held indices in OpenSearch cluster. |
| opensearch.saml | object | (see example in values file) |
Place here your settings, if you want to authenticate via SAML method. |
| opensearch.singleNode | bool | false |
Set deployment layout for OpenSearch |
| opensearch.snapshot.enabled | bool | false |
|
| opensearch.snapshot.size | string | "5Gi" |
|
| opensearch.snapshot.storageClass | object | {} |
|
| opensearch.timeNanoSeconds | bool | false |
If true, timestamp will be collected and showed with full precision. |
| opensearch.user | string | "osadmin" |
User name with admin rights |
| opensearch_dashboards.affinity | object | {} |
|
| opensearch_dashboards.branding | object | {} |
|
| opensearch_dashboards.developer.password | string | "develop" |
|
| opensearch_dashboards.developer.user | string | "developer" |
|
| opensearch_dashboards.externalOpensearchDashboards.caCertificateSecret | string | "" |
|
| opensearch_dashboards.externalOpensearchDashboards.disabled | bool | true |
|
| opensearch_dashboards.externalOpensearchDashboards.runJob | bool | false |
|
| opensearch_dashboards.externalOpensearchDashboards.url | string | "" |
|
| opensearch_dashboards.extraEnvs | list | [] |
|
| opensearch_dashboards.image | string | "opensearchproject/opensearch-dashboards" |
Used image name. |
| opensearch_dashboards.imageTag | string | "2.11.1" |
Used component version. |
| opensearch_dashboards.indexPatterns | list | ["containers","systemd","nginx"] |
Set indices name for inject patterns to OpenSearchDashboards |
| opensearch_dashboards.ingress.annotations | object | {} |
Annotations for ingress object. |
| opensearch_dashboards.ingress.className | string | "" |
|
| opensearch_dashboards.ingress.enabled | bool | false |
Switch to enable / disable ingress for OpenSearch Dashboards. |
| opensearch_dashboards.ingress.host | list | [] |
|
| opensearch_dashboards.ingress.hosts | object | {} |
|
| opensearch_dashboards.ingress.path | string | "/" |
|
| opensearch_dashboards.ingress.tls | list | [] |
Certificate setting for hostname. |
| opensearch_dashboards.password | string | "opensearch" |
Set password for user with admin privileges. |
| opensearch_dashboards.podLabels | object | {} |
Additional labels for the workload pods |
| opensearch_dashboards.priorityClass | object | {} |
|
| opensearch_dashboards.readonly.password | string | "view" |
Set password for user with read only privileges. |
| opensearch_dashboards.readonly.user | string | "viewer" |
Set user name with read only privileges. |
| opensearch_dashboards.replicas | int | 1 |
Replicas count for OpenSearch Dashboard pods. |
| opensearch_dashboards.resources.limits.memory | string | "500Mi" |
Define maximum memory allocation. |
| opensearch_dashboards.resources.requests.memory | string | "500Mi" |
Define minimum memory allocation. |
| opensearch_dashboards.tenants | list | ["Global","Developer"] |
Set tenants name for importing objects via helm chart |
| opensearch_dashboards.tolerations | list | [] |
|
| opensearch_dashboards.user | string | "opensearch" |
Set user name with admin privileges. |
| priorityClass | string | "" |
TODO |
| storageClass | object | {} |
Defautl Storage Class for used by Persistence Volume Claims. Can be overwritten by workloads |
| withNetworkPolicy | bool | false |
Default networkpolicy for ingress and egress traffic |
Maintainers
| Name | Url | |
|---|---|---|
| Niki Dokovski | nickytd@gmail.com | https://github.com/nickytd |
Last modified March 2, 2022: update links in documentation (cb560ce)