About Helm

Using metricbeat as an example.

Refer to Metricbeat Helm Chart

Outline —
1. By default, without any custom options.
2. If you want to choose the version by yourself …
3. You need to change some configurations let it working, but how do you get the default values.yaml?
4. Do you want to check the current values for your release locally?
5. After you have edited the custom_values.yaml, how do you install Metricbeat with your custom_values.yaml?
6. How can I download the helm template, adjust it, and then use it?

By default, without any custom options.

# Add the Elastic Helm charts repo
> helm repo add elastic https://helm.elastic.co

# verify
> helm repo list | grep elastic
elastic         https://helm.elastic.co

# install the Metricbeat
> helm install metricbeat elastic/metricbeat

If you want to choose the version by yourself …

# Using helm search to check avaiablible version
> helm search repo elastic/metricbeat --versions
NAME                    CHART VERSION   APP VERSION     DESCRIPTION
elastic/metricbeat      8.5.1           8.5.1           Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.17.3          7.17.3          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.17.1          7.17.1          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.16.3          7.16.3          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.16.2          7.16.2          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.16.1          7.16.1          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.15.0          7.15.0          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.14.0          7.14.0          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.13.4          7.13.4          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.13.3          7.13.3          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.13.2          7.13.2          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.13.1          7.13.1          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.13.0          7.13.0          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.12.1          7.12.1          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.12.0          7.12.0          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.11.2          7.11.2          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.11.1          7.11.1          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.10.2          7.10.2          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.10.1          7.10.1          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.10.0          7.10.0          Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.9.3           7.9.3           Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.9.2           7.9.2           Official Elastic helm chart for Metricbeat
elastic/metricbeat      7.9.1           7.9.1           Official Elastic helm chart for Metricbeat

# By default, you will install version 8.5.1, but I will pick up version 7.17.3 for my example.
> helm install metricbeat elastic/metricbeat --version 7.17.3

But refer this document — https://github.com/elastic/helm-charts/blob/main/metricbeat/README.md#usage-notes

Get Kanglin’s stories in your inbox

Join Medium for free to get updates from this writer.

Remember me for faster sign in

You need to change some configurations let it working, but how do you get the default values.yaml?

# inspects a chart (directory, file, or URL) and displays the contents
of the values.yaml file and export to current folder ( name - custom_values.yaml )
> helm show values elastic/metricbeat --version 7.17.3 > custom_values.yaml

Do you want to check the current values for your release locally?

# assume local release name is metricbeat
> helm get values metricbeat

# or get the manifest
> helm get manifest metricbeat

After you have edited the custom_values.yaml, how do you install Metricbeat with your custom_values.yaml?

# Assuming you are already in the same folder as the custom_values.yaml file
> helm install metricbeat elastic/metricbeat --version 7.17.3 -f custom_values.yaml

How can I download the helm template, adjust it, and then use it?

# 1 - Get the templates
> helm pull elastic/metricbeat --version 7.17.3

# It will download as "metricbeat-7.17.3.tgz" to your current folder.

# 2 - Create the folder 
> mkdir metricbeat-templates

# 3 - Extract the tgz file
> tar -zxvf metricbeat-*.tgz -C metricbeat-templates/ --strip-components=1 --wildcards "metricbeat/templates/*"

# 4 - After you have edited the template YAML, compress it as metricbeat-templates.tar.gz
> tar -czvf metricbeat-templates.tar.gz -C ~/metricbeat/metricbeat-templates .

# 5 - Install metricbeat and set values from respective files specified via the command line
> helm install metricbeat elastic/metricbeat --version 7.17.3 --set-file metricbeat.config.modules=~/metricbeat/metricbeat-templates