opensearch-dashboards

OpenSearch Dashboards Helm Chart

This Helm chart installs OpenSearch Dashboards with configurable TLS, RBAC and much more configurations. This chart caters to a number of different use cases and setups.

• Requirements
• Installing
• Uninstalling

Requirements

• Kubernetes >= 1.14
• Helm >= 2.17.0
• We recommend you to have 8 GiB of memory available for this deployment, or at least 4 GiB for the minimum requirement. Else, the deployment is expected to fail.

Installing

Once you've added this Helm repository as per the repository-level README then you can install the chart as follows:

helm install my-release opensearch/opensearch-dashboards

The command deploys OpenSearch Dashboards with its associated components on the Kubernetes cluster in the default configuration.

NOTE: If using Helm 2 then you'll need to add the --name command line argument. If unspecified, Helm 2 will autogenerate a name for you.

Uninstalling

To delete/uninstall the chart with the release name my-release:

helm uninstall my-release

Configuration

Parameter	Description	Default
envFrom	Templatable string to be passed to the environment from variables which will be appended to the envFrom: definition for the container	[]
config	Allows you to add any config files in /usr/share/opensearch-dashboards/ such as opensearch_dashboards.yml. String or map format may be used for specifying content of each configuration file. In case of string format, the whole content of the config file will be replaced by new config file value when in case of using map format content of configuration file will be a result of merge. In both cases content passed through tpl. See values.yaml for an example of the formatting	{}
extraContainers	Array of extra containers	""
extraEnvs	Extra environments variables to be passed to OpenSearch services	[]
extraInitContainers	Array of extra init containers	[]
extraVolumeMounts	Array of extra volume mounts	[]
extraVolumes	Array of extra volumes to be added	[]
fullnameOverride	Overrides the clusterName and nodeGroup when used in the naming of resources. This should only be used when using a single nodeGroup, otherwise you will have name conflicts	""
hostAliases	Configurable hostAliases	[]
image.pullPolicy	The Kubernetes imagePullPolicy value	IfNotPresent
imagePullSecrets	Configuration for imagePullSecrets so that you can use a private registry for your image	[]
image.tag	The OpenSearch Docker image tag	1.0.0
image.repository	The OpenSearch Docker image	opensearchproject/opensearch
ingress	Configurable ingress to expose the OpenSearch service. See values.yaml for an example	see values.yaml
labels	Configurable labels applied to all OpenSearch pods	{}
lifecycle	Allows you to add lifecycle hooks. See values.yaml for an example	{}
nameOverride	Overrides the clusterName when used in the naming of resources	""
nodeSelector	Configurable nodeSelector so that you can target specific nodes for your OpenSearch cluster	{}
podAnnotations	Configurable annotations applied to all OpenSearch pods	{}
podSecurityContext	Allows you to set the securityContext for the pod	see values.yaml
priorityClassName	The name of the PriorityClass. No default is supplied as the PriorityClass must be created first	""
rbac	Configuration for creating a role, role binding and ServiceAccount as part of this Helm chart with create: true. Also can be used to reference an external ServiceAccount with serviceAccountName: "externalServiceAccountName"	see values.yaml
resources	Allows you to set the resources for the StatefulSet	see values.yaml
secretMounts	Allows you easily mount a secret as a file inside the StatefulSet. Useful for mounting certificates and other secrets. See values.yaml for an example	[]
securityContext	Allows you to set the securityContext for the container	see values.yaml
service.annotations	LoadBalancer annotations that Kubernetes will use for the service. This will configure load balancer if service.type is LoadBalancer	{}
service.headless.annotations	Allow you to set annotations on the headless service	{}
service.externalTrafficPolicy	Some cloud providers allow you to specify the LoadBalancer externalTrafficPolicy. Kubernetes will use this to preserve the client source IP. This will configure load balancer if service.type is LoadBalancer	""
service.httpPortName	The name of the http port within the service	http
service.labelsHeadless	Labels to be added to headless service	{}
service.labels	Labels to be added to non-headless service	{}
service.loadBalancerIP	Some cloud providers allow you to specify the loadBalancer IP. If the loadBalancerIP field is not specified, the IP is dynamically assigned. If you specify a loadBalancerIP but your cloud provider does not support the feature, it is ignored.	""
service.loadBalancerSourceRanges	The IP ranges that are allowed to access	[]
service.nodePort	Custom nodePort port that can be set if you are using service.type: nodePort	""
service.transportPortName	The name of the transport port within the service	transport
service.type	OpenSearch Service Types	ClusterIP
service.ipFamilyPolicy	This sets the preferred ip addresses in case of a dual-stack server, there are three options [PreferDualStack, SingleStack, RequireDualStack], more information on dual stack	""
service.ipFamilies	Sets the preferred IP variants and in which order they are preferred, the first family you list is used for the legacy .spec.ClusterIP field, more information on dual stack	""
service.metricsPort	The metrics port (for Performance Analyzer) that Kubernetes will use for the service.	9601
service.metricsPortName	The name of the metrics port (for Performance Analyzer) within the service	metrics
tolerations	Configurable tolerations	[]
topologySpreadConstraints	Configuration for pod topologySpreadConstraints	[]
updateStrategy	The updateStrategy for the StatefulSet. By default Kubernetes will wait for the cluster to be green after upgrading each pod. Setting this to OnDelete will allow you to manually delete each pod during upgrades	RollingUpdate
extraObjects	Array of extra K8s manifests to deploy	list []
autoscaling.enabled	Prerequisite: Install/Configure metrics server, to install use kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml, See Metrics Server.	false
autoscaling.minReplicas	The lower limit for the number of replicas to which the autoscaler can scale down.	1
autoscaling.maxReplicas	The upper limit for the number of replicas to which the autoscaler can scale up.	10
autoscaling.targetCPU	The target value of the average CPU across all OpenSearch Dashboards pods.	80
autoscaling.targetMemory	The target value of the average memory across all OpenSearch Dashboards pods. Value should be tuned based on the requested memory value for OpenSearch Dashboards pods. Scaling based on memory utilization may be necessary for large datasets or complex dashboards.	80
livenessProbe	Configuration fields for the liveness probe	see exampleLiveness in values.yaml
readinessProbe	Configuration fields for the readiness probe	see exampleReadiness in values.yaml
startupProbe	Configuration fields for the startup probe	see exampleStartup in values.yaml
plugins.enabled	Allow/disallow to add 3rd Party / Custom plugins not offered in the default OpenSearchDashboards image	false
plugins.installList	Array containing the Opensearch Dashboards plugins to be installed in container	[]
opensearchDashboardsYml.defaultMode	Allow you to set the defaultMode for the opensearch_dashboards.yml mounted as configMap
dashboardAnnotations	Allows you to configure custom annotation in the deployement of the OpenSearchDashboards container	{}
serviceMonitor.enabled	Enables the creation of a ServiceMonitor resource for Prometheus monitoring. Requires the Prometheus Operator to be installed in your Kubernetes cluster.	false
serviceMonitor.path	Path where metrics are exposed. Applicable only if serviceMonitor.enabled is set to true.	/_prometheus/metrics
serviceMonitor.interval	Interval at which metrics should be scraped by Prometheus. Applicable only if serviceMonitor.enabled is set to true.	10s