Elastic Stack Helm chart upgrade and configuration changes documentation #4388
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Vale Linting ResultsSummary: 1 suggestion found 💡 Suggestions (1)
|
Contributor
shainaraskas
approved these changes
Dec 17, 2025
Collaborator
There was a problem hiding this comment.
although I don't know too much about kubernetes / helm, none of this struck me as superfluous information. I think you did a good job of adding the right amount of info but keeping it task-based for the ECK context.
approving because this is nearly perfect - whatever you do from here is mergeable from my pov.
one thing that might be missing: do I need a specific version of the helm chart to access later versions of the stack? e.g. is upgrading the helm chart version a prerequisite? If that is the case, I believe it is not clear.
| helm install es-quickstart elastic/eck-elasticsearch -n elastic-stack --create-namespace | ||
| ``` | ||
|
|
||
| ## Upgrade or change {{stack}} configuration with Helm [k8s-upgrade-modify-helm] |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Upgrade or change {{stack}} configuration with Helm [k8s-upgrade-modify-helm] | |
| ## Upgrade or change your {{stack}} configuration with Helm [k8s-upgrade-modify-helm] |
|
|
||
| ## Upgrade or change {{stack}} configuration with Helm [k8s-upgrade-modify-helm] | ||
|
|
||
| Whether you want to upgrade your {{stack}} components to a new version or modify the configuration of your existing installation (known as a `release`), you use the [`helm upgrade`](https://helm.sh/docs/helm/helm_upgrade/) command. The key principle is to use the same options and values you used during installation, along with any changes you want to apply. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Whether you want to upgrade your {{stack}} components to a new version or modify the configuration of your existing installation (known as a `release`), you use the [`helm upgrade`](https://helm.sh/docs/helm/helm_upgrade/) command. The key principle is to use the same options and values you used during installation, along with any changes you want to apply. | |
| To upgrade your {{stack}} components to a new version or modify the configuration of your existing installation (known as a `release`), use the [`helm upgrade`](https://helm.sh/docs/helm/helm_upgrade/) command. The key principle is to use the same options and values you used during installation, along with any changes you want to apply. |
| There is an important distinction between the Helm chart version and the {{stack}} component version: | ||
|
|
||
| - **Chart version**: The version of the Helm chart itself (for example, `eck-stack` version 0.17.0). You can specify this using the `--version` flag in your Helm `install` or `upgrade` commands. | ||
| - **Component version**: The version of a {{stack}} component (for example, {{es}} 8.15.0 or {{kib}} 8.15.0). You can specify this in your values file or by using `--set` parameters. |
Collaborator
There was a problem hiding this comment.
let's use latest values here
Suggested change
| - **Component version**: The version of a {{stack}} component (for example, {{es}} 8.15.0 or {{kib}} 8.15.0). You can specify this in your values file or by using `--set` parameters. | |
| - **Component version**: The version of a {{stack}} component (for example, {{es}} {{version.stack}} or {{kib}} {{version.stack}}). You can specify this in your values file or by using `--set` parameters. |
|
|
||
| Each chart version defines default {{stack}} component versions. Unless explicitly overridden, installing or upgrading the chart deploys those default versions. | ||
|
|
||
| % When available we can tell users how to check the default {{stack}} version associated with each chart release. That's not feasible today and users are a bit blind on this regard. |
Collaborator
There was a problem hiding this comment.
careful about language - these comments are public
Suggested change
| % When available we can tell users how to check the default {{stack}} version associated with each chart release. That's not feasible today and users are a bit blind on this regard. | |
| % When available we can tell users how to check the default {{stack}} version associated with each chart release. That's not feasible today. |
|
|
||
| ### Upgrade to specific {{stack}} version | ||
|
|
||
| If for example you want to upgrade the {{stack}} components to a later version that is not the default for the Helm chart, you can explicitly set the component versions using Helm values or `--set` options. |
Collaborator
There was a problem hiding this comment.
I understand the for example likely covers the case above - does it cover any other case? consider:
Suggested change
| If for example you want to upgrade the {{stack}} components to a later version that is not the default for the Helm chart, you can explicitly set the component versions using Helm values or `--set` options. | |
| If you want to upgrade the {{stack}} components to a later version that is not the default for the Helm chart, or you want to update your Helm chart without upgrading the {{stack}}, you can explicitly set the component versions using Helm values or `--set` options. |
| ``` | ||
|
|
||
| ::::{warning} | ||
| The previous example also upgrades the {{stack}} components if a newer Helm chart version is available. To avoid this, [identify the chart version](#show-versions) currently used by your release and include the `--version` option when running `helm upgrade`. |
Collaborator
There was a problem hiding this comment.
because it's all grouped under one heading with only one code example, we can just say this
Suggested change
| The previous example also upgrades the {{stack}} components if a newer Helm chart version is available. To avoid this, [identify the chart version](#show-versions) currently used by your release and include the `--version` option when running `helm upgrade`. | |
| This example also upgrades the {{stack}} components if a newer Helm chart version is available. To avoid this, [identify the chart version](#show-versions) currently used by your release and include the `--version` option when running `helm upgrade`. |
| The previous example also upgrades the {{stack}} components if a newer Helm chart version is available. To avoid this, [identify the chart version](#show-versions) currently used by your release and include the `--version` option when running `helm upgrade`. | ||
| :::: | ||
|
|
||
| ## Adding Ingress to the {{stack}} [k8s-eck-stack-ingress] |
Collaborator
There was a problem hiding this comment.
little consistency tweak
Suggested change
| ## Adding Ingress to the {{stack}} [k8s-eck-stack-ingress] | |
| ## Add Ingress to the {{stack}} [k8s-eck-stack-ingress] |
|
|
||
| ## View available chart versions [show-versions] | ||
|
|
||
| To view the available versions of a Helm chart, update the local chart cache and use the `helm repo search` command with `--versions` option: |
Collaborator
There was a problem hiding this comment.
Suggested change
| To view the available versions of a Helm chart, update the local chart cache and use the `helm repo search` command with `--versions` option: | |
| To view the available versions of a Helm chart, update the local chart cache and use the `helm repo search` command with `--versions` option. You can use this flag with `eck-stack` or [individual charts](#k8s-eck-stack-individual-components). |
Comment on lines
+319
to
+323
| ```sh | ||
| helm repo update | ||
| helm repo search elastic/eck-stack --versions <1> | ||
| ``` | ||
| 1. Applicable to `eck-stack` or the [individual charts](#k8s-eck-stack-individual-components) |
Collaborator
There was a problem hiding this comment.
no need to bury this helpful hint as a code comment
Suggested change
| ```sh | |
| helm repo update | |
| helm repo search elastic/eck-stack --versions <1> | |
| ``` | |
| 1. Applicable to `eck-stack` or the [individual charts](#k8s-eck-stack-individual-components) | |
| ```sh | |
| helm repo update | |
| helm repo search elastic/eck-stack --versions | |
| ``` |
Comment on lines
+22
to
+24
| ::::{note} | ||
| If you deploy your {{stack}} resources using our Helm chart, refer to [](/deploy-manage/deploy/cloud-on-k8s/managing-deployments-using-helm-chart.md#k8s-upgrade-modify-helm) for details on how to perform upgrades with Helm. | ||
| :::: |
Collaborator
There was a problem hiding this comment.
this note kind of works, but I don't like how it's splitting the instructions and example, and it is burying an up-front choice in the middle of the procedure
consider instead:
- introducing that there are two ways to do it in the intro for the page
- making two H2s, one for each: e.g. "Perform the upgrade in the cluster spec file" "Perform the upgrade using a Helm chart"
not sure if there is a better way to word the headings, because it's less about the method of performing the upgrade, than the context of the configuration ... some alternative headings might be:
"For orchestrators using spec files"
"For orchestrators using Helm charts"
orchestrators / operators / environments / deployments / clusters ... whatever feels the most accurate
you see what I'm getting at :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds documentation for Elastic Stack Helm chart (provided by ECK) users to know how to upgrade and apply configuration changes.
As you'll see, certain parts of the content are not purely about ECK and Elastic Stack specifics, but a bit about how Helm works and educates the reader in areas that are not purely ours.
I've tried to fit the content to our exact domain, but giving enough information to understand the basics.
Closes #3591
After admin-docs review we will need to find devs to review the content.