This Helm chart is a lightweight way to configure and run our official Kibana Docker image.
Warning: This branch is used for development, please use 7.7.1 release for supported version.
- Helm >=2.8.0 and <3.0.0
- Kubernetes >=1.9
See supported configurations for more details.
-
Add the Elastic Helm charts repo:
helm repo add elastic https://helm.elastic.co -
Install it:
helm install --name kibana elastic/kibana
-
Clone the git repo:
git clone [email protected]:elastic/helm-charts.git -
Install it:
helm install --name kibana ./helm-charts/kibana --set imageTag=7.7.1
Please always check CHANGELOG.md and BREAKING_CHANGES.md before upgrading to a new chart version.
This chart is tested with the latest supported versions. The currently tested versions are:
| 6.x | 7.x |
|---|---|
| 6.8.10 | 7.7.1 |
Examples of installing older major versions can be found in the examples directory.
While only the latest releases are tested, it is possible to easily install old
or new releases by overriding the imageTag. To install version 7.7.1 of
Kibana it would look like this:
helm install --name kibana elastic/kibana --set imageTag=7.7.1
-
Automated testing of this chart is currently only run against GKE (Google Kubernetes Engine).
-
This repo includes a number of examples configurations which can be used as a reference. They are also used in the automated testing of this chart.
| Parameter | Description | Default |
|---|---|---|
affinity |
Configurable affinity | {} |
elasticsearchHosts |
The URLs used to connect to Elasticsearch | http://elasticsearch-master:9200 |
envFrom |
Templatable string to be passed to the environment from variables which will be appended to the envFrom: definition for the container |
[] |
extraContainers |
Templatable string of additional containers to be passed to the tpl function |
"" |
extraEnvs |
Extra environment variables which will be appended to the env: definition for the container |
see values.yaml |
extraInitContainers |
Templatable string of additional containers to be passed to the tpl function |
"" |
fullnameOverride |
Overrides the full name of the resources. If not set the name will default to " .Release.Name - .Values.nameOverride orChart.Name " |
"" |
healthCheckPath |
The path used for the readinessProbe to check that Kibana is ready. If you are setting server.basePath you will also need to update this to /${basePath}/app/kibana |
/app/kibana |
httpPort |
The http port that Kubernetes will use for the healthchecks and the service | 5601 |
imagePullPolicy |
The Kubernetes imagePullPolicyvalue | IfNotPresent |
imagePullSecrets |
Configuration for imagePullSecrets so that you can use a private registry for your image | [] |
imageTag |
The Kibana Docker image tag | 7.7.1 |
image |
The Kibana Docker image | docker.elastic.co/kibana/kibana |
ingress |
Configurable ingress to expose the Kibana service. | see values.yaml |
kibanaConfig |
Allows you to add any config files in /usr/share/kibana/config/ such as kibana.yml See values.yaml for an example of the formatting |
{} |
labels |
Configurable labels applied to all Kibana pods | {} |
lifecycle |
Allows you to add lifecycle hooks. See values.yaml for an example of the formatting | {} |
nameOverride |
Overrides the chart name for resources. If not set the name will default to .Chart.Name |
"" |
nodeSelector |
Configurable nodeSelector so that you can target specific nodes for your Kibana instances | {} |
podAnnotations |
Configurable annotations applied to all Kibana 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 | "" |
protocol |
The protocol that will be used for the readinessProbe. Change this to https if you have server.ssl.enabled: true set |
http |
readinessProbe |
Configuration for the readiness probe | see values.yaml |
replicas |
Kubernetes replica count for the Deployment (i.e. how many pods) | 1 |
resources |
Allows you to set the resources for the Deployment | see values.yaml |
secretMounts |
Allows you easily mount a secret as a file inside the Deployment. 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 |
serverHost |
The server.host Kibana setting. This is set explicitly so that the default always matches what comes with the Docker image | 0.0.0.0 |
serviceAccount |
Allows you to overwrite the "default" serviceAccount for the pod | [] |
service |
Configurable service to expose the Kibana service. | see values.yaml |
tolerations |
Configurable tolerations) | [] |
updateStrategy |
Allows you to change the default updateStrategy for the Deployment. A standard upgrade of Kibana requires a full stop and start which is why the default strategy is set to Recreate |
type: Recreate |
| Parameter | Description | Default |
|---|---|---|
elasticsearchURL |
The URL used to connect to Elasticsearch. needs to be used for Kibana versions < 6.6 | "" |
This chart is highly tested with [GKE][], but some K8S distribution also requires specific configurations.
We provide examples of configuration for the following K8S providers:
This Helm chart can use existing Kubernetes secrets to setup credentials or certificates for examples. These secrets should be created outside of this chart and accessed using environment variables and volumes.
An example can be found in examples/security.
Deploying OSS version of Elasticsearch can be done by setting image value to
kibana OSS Docker image
An example of APM Server deployment using OSS version can be found in examples/oss.
The recommended way to install plugins into our Docker images is to create a custom Docker image.
The Dockerfile would look something like:
ARG kibana_version
FROM docker.elastic.co/kibana/kibana:${kibana_version}
RUN bin/kibana-plugin install <plugin_url>
And then updating the image in values to point to your custom image.
There are a couple reasons we recommend this:
- Tying the availability of Kibana to the download service to install plugins is not a great idea or something that we recommend. Especially in Kubernetes where it is normal and expected for a container to be moved to another host at random times.
- Mutating the state of a running Docker image (by installing plugins) goes against best practices of containers and immutable infrastructure.
You can use postStart lifecycle hooks to run code triggered after a
container is created.
Here is an example of postStart hook to import an index-pattern and a
dashboard:
lifecycle:
postStart:
exec:
command:
- bash
- -c
- |
#!/bin/bash
# Import a dashboard
KB_URL=http://localhost:5601
while [[ "$(curl -s -o /dev/null -w '%{http_code}\n' -L $KB_URL)" != "200" ]]; do sleep 1; done
curl -XPOST "$KB_URL/api/kibana/dashboards/import" -H "Content-Type: application/json" -H 'kbn-xsrf: true' -d'"objects":[{"type":"index-pattern","id":"my-pattern","attributes":{"title":"my-pattern-*"}},{"type":"dashboard","id":"my-dashboard","attributes":{"title":"Look at my dashboard"}}]}'Please check CONTRIBUTING.md before any contribution or for any questions about our development and testing process.