Kibana packaged by Bitnami¶

Kibana is an open source, browser based analytics and search dashboard for Elasticsearch. Kibana strives to be easy to get started with, while also being flexible and powerful.

Overview of Kibana

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR¶

使用加速地址添加仓库:

helm repo add bitnami "https://helm-charts.itboon.top/bitnami" --force-update
helm update bitnami

helm install my-release bitnami/kibana --set elasticsearch.hosts[0]=<Hostname of your ES instance> --set elasticsearch.port=<port of your ES instance>

Introduction¶

This chart bootstraps a Kibana deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Looking to use Kibana in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

Prerequisites¶

• Kubernetes 1.19+
• Helm 3.2.0+
• PV provisioner support in the underlying infrastructure
• ReadWriteMany volumes for deployment scaling

Installing the Chart¶

To install the chart with the release name my-release:

helm install my-release bitnami/kibana \
  --set elasticsearch.hosts[0]=<Hostname of your ES instance> \
  --set elasticsearch.port=<port of your ES instance> \

This chart requires an Elasticsearch instance to work. You can use an already existing Elasticsearch instance. These commands deploy Kibana on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart¶

To uninstall/delete the my-release statefulset:

helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release. Use the option --purge to delete all history too.

Parameters¶

Global parameters¶

Common parameters¶

Kibana parameters¶

Kibana server TLS configuration¶

Elasticsearch parameters¶

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install my-release \
  --set admin.user=admin-user bitnami/kibana

The above command sets the Kibana admin user to admin-user.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

helm install my-release -f values.yaml bitnami/kibana

Tip: You can use the default values.yaml

Configuration and installation details¶

Rolling vs Immutable tags¶

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Change Kibana version¶

To modify the application version used in this chart, specify a different version of the image using the image.tag parameter and/or a different repository using the image.repository parameter. Refer to the chart documentation for more information on these parameters and how to use them with images from a private registry.

Use custom configuration¶

The Bitnami Kibana chart supports using custom configuration settings. For example, to mount a custom kibana.yml you can create a ConfigMap like the following:

apiVersion: v1
kind: ConfigMap
metadata:
  name: myconfig
data:
  kibana.yml: |-
    # Raw text of the file

And now you need to pass the ConfigMap name, to the corresponding parameter: configurationCM=myconfig

An alternative is to provide extra configuration settings to the default kibana.yml that the chart deploys. This is done using the extraConfiguration value:

extraConfiguration:
  "server.maxPayloadBytes": 1048576
  "server.pingTimeout": 1500

Add extra environment variables¶

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property.

extraEnvVars:
  - name: ELASTICSEARCH_VERSION
    value: 6

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values.

Use custom initialization scripts¶

For advanced operations, the Bitnami Kibana chart allows using custom initialization scripts that will be mounted in /docker-entrypoint.init-db. Mount these extra scripts using a ConfigMap or a Secret (in case of sensitive data) and specify them via the initScriptsCM and initScriptsSecret chart parameters. Refer to the chart documentation on custom initialization scripts for an example.

Install plugins¶

The Bitnami Kibana chart allows you to install a set of plugins at deployment time using the plugins chart parameter. Refer to the chart documentation on installing plugins for an example.

elasticsearch.hosts[0]=elasticsearch-host
elasticsearch.port=9200
plugins[0]=https://github.com/fbaligand/kibana-enhanced-table/releases/download/v1.5.0/enhanced-table-1.5.0_7.3.2.zip

NOTE Make sure that the plugin is available for the Kibana version you are deploying

Import saved objects¶

If you have visualizations and dashboards (in NDJSON format) to import to Kibana, create a ConfigMap that includes them and then install the chart with the savedObjects.configmap or savedObjects.urls parameters. Refer to the chart documentation on importing saved objects for an example.

Use Sidecars and Init Containers¶

If additional containers are needed in the same pod (such as additional metrics or logging exporters), they can be defined using the sidecars config parameter. Similarly, extra init containers can be added using the initContainers parameter.

Refer to the chart documentation for more information on, and examples of, configuring and using sidecars and init containers.

Add a sample Elasticsearch container as sidecar¶

This chart requires an Elasticsearch instance to work. For production, the options are to use an already existing Elasticsearch instance or deploy the Elasticsearch chart with the global.kibanaEnabled=true parameter.

For testing purposes, use a sidecar Elasticsearch container setting the following parameters during the Kibana chart installation:

elasticsearch.hosts[0]=localhost
elasticsearch.port=9200
sidecars[0].name=elasticsearch
sidecars[0].image=bitnami/elasticsearch:latest
sidecars[0].imagePullPolicy=IfNotPresent
sidecars[0].ports[0].name=http
sidecars[0].ports[0].containerPort=9200

Set Pod affinity¶

This chart allows you to set custom Pod affinity using the affinity parameter. Find more information about Pod affinity in the Kubernetes documentation.

As an alternative, you can use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Persistence¶

The Bitnami Kibana image can persist data. If enabled, the persisted path is /bitnami/kibana by default.

The chart mounts a Persistent Volume at this location. The volume is created using dynamic volume provisioning.

Add extra volumes¶

The Bitnami Kibana chart supports mounting extra volumes (either PVCs, secrets or configmaps) by using the extraVolumes and extraVolumeMounts property. This can be combined with advanced operations like adding extra init containers and sidecars.

Adjust permissions of persistent volume mountpoint¶

As the image run as non-root by default, it is necessary to adjust the ownership of the persistent volume so that the container can write data into it.

By default, the chart is configured to use Kubernetes Security Context to automatically change the ownership of the volume. However, this feature does not work in all Kubernetes distributions. As an alternative, this chart supports using an initContainer to change the ownership of the volume before mounting it in the final destination.

You can enable this initContainer by setting volumePermissions.enabled to true.

Troubleshooting¶

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

Upgrading¶

To 10.0.0¶

This major release updates Kibana its latest verstion 8.x.x. In addition, missing features have been added and values have been renamed, in order to get aligned with the rest of the assets in the Bitnami charts repository.

Affected values:

• service.port renamed as service.ports.http
• service.nodePort renamed as service.nodePorts.http
• containerPort renamed as containerPorts.http

Changes to Security related values:

• elasticsearch.security.auth.kibanaUsername has been removed. Kibana must be authenticates using the built-in user 'kibana_system'
• elasticsearch.security.auth.kibanaPassword has to provide the password for the kibana_system user, otherwise random password will be generated.
• elasticsearch.security.auth.existingSecret key kibana-password now references the password of the 'kibana_system' user.
• Two new values have been added: elasticsearch.security.auth.createSystemUser and elasticsearchPasswordSecret. If provided, the kibana container will use the 'elastic' user to create the 'kibana_system' user, using the password provided under elasticsearch.security.auth.kibanaPassword.

To 9.0.0¶

This version updates the settings used to communicate Kibana with Elasticsearch, adapting it to Elasticsearch X-Pack Security features.

Previous setting elasticsearch.tls has been replaced with elasticsearch.security.tls.enabled. Other settings regarding certificate verification can be found under elasticsearch.security.tls.*, such as verification method and custom truststore.

Additionally, support for the Kibana server using TLS/SSL encryption (HTTPS for port 5601) has been added.

To 8.0.0¶

The Kibana container configuration logic was migrated to bash.

From this version onwards, Kibana container components are now licensed under the Elastic License that is not currently accepted as an Open Source license by the Open Source Initiative (OSI).

Also, from now on, the Helm Chart will include the X-Pack plugin installed by default.

Regular upgrade is compatible from previous versions.

To 6.2.0¶

This version introduces bitnami/common, a library chart as a dependency. More documentation about this new utility could be found here. Please, make sure that you have updated the chart dependencies before executing any upgrade.

To 6.0.0¶

On November 13, 2020, Helm v2 support formally ended. This major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

Learn more about this change and related upgrade considerations.

To 5.0.0¶

This version does not include Elasticsearch as a bundled dependency. From now on, you should specify an external Elasticsearch instance using the elasticsearch.hosts[] and elasticsearch.port parameters.

To 3.0.0¶

Helm performs a lookup for the object based on its group (apps), version (v1), and kind (Deployment). Also known as its GroupVersionKind, or GVK. Changing the GVK is considered a compatibility breaker from Kubernetes' point of view, so you cannot "upgrade" those objects to the new GVK in-place. Earlier versions of Helm 3 did not perform the lookup correctly which has since been fixed to match the spec.

In 4dfac075aacf74405e31ae5b27df4369e84eb0b0 the apiVersion of the deployment resources was updated to apps/v1 in tune with the api's deprecated, resulting in compatibility breakage.

This major version signifies this change.

To 2.0.0¶

This version enabled by default an initContainer that modify some kernel settings to meet the Elasticsearch requirements.

Currently, Elasticsearch requires some changes in the kernel of the host machine to work as expected. If those values are not set in the underlying operating system, the ES containers fail to boot with ERROR messages. More information about these requirements can be found in the links below:

• File Descriptor requirements
• Virtual memory requirements

You can disable the initContainer using the elasticsearch.sysctlImage.enabled=false parameter.

License¶

Copyright © 2023 VMware, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.