[ECK] Update documentation for 3.1.0 #2019

barkbay · 2025-07-03T06:14:31Z

This PR is to update the documentation for the next ECK release.

Do not merge before ECK 3.1.0 release

Related ECK release issue: https://github.com/elastic/k8s-dev/issues/538

This adds documentation for the feature implemented in elastic/cloud-on-k8s#8623 Merge target is `eck-3.1.0` so that we can in preparation for the next ECK release merge all pertinent docs at once to main. --------- Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>

github-actions · 2025-07-03T06:16:43Z

🔍 Preview links for changed docs

barkbay · 2025-07-15T08:38:34Z

Created as a draft as I'm still trying to understand what is expected here and also the process when a product version is updated.

👋 doc team, I would be glad to get a first review, just to be sure I can safely merge this PR on release date. Thanks! 🙇

eedugon · 2025-07-15T11:19:54Z

deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md


+One of those exceptions is the configuration of providers as described in [advanced Agent configuration managed by Fleet](/reference/fleet/advanced-kubernetes-managed-by-fleet.md). When {{agent}} is managed by {{fleet}} and is orchestrated by ECK, the configuration of providers can simply be done through the `.spec.config` element in the Agent resource as of {applies_to}`stack: ga 8.13`:


@barkbay : what do we mean with the applies_to stack 8.13 here? That the providers configuration can be done only for Agents running 8.13 or later?

Suggested change

One of those exceptions is the configuration of providers as described in [advanced Agent configuration managed by Fleet](/reference/fleet/advanced-kubernetes-managed-by-fleet.md). When {{agent}} is managed by {{fleet}} and is orchestrated by ECK, the configuration of providers can simply be done through the `.spec.config` element in the Agent resource as of {applies_to}`stack: ga 8.13`:

One of those exceptions is the configuration of providers as described in [advanced Agent configuration managed by Fleet](/reference/fleet/advanced-kubernetes-managed-by-fleet.md). Starting in stack version 8.13, if {{agent}} is managed by {{fleet}} and orchestrated by ECK, you can configure providers using the `.spec.config` element in the Agent resource:

Possible version switching the 8.13 statement to the narrative side.

This content was already reviewed here without notes: #1446

Thanks @pebrc for the extra details!

My opinion is still the same but of course it's not a big deal. Also when we reviewed the linked PR, I think the applies_to was added in a later commit, as otherwise I'd probably have highlighted it.

Anyway the current text and usage of the badge is all right too, so whatever you want.
cc: @shainaraskas

We can totally change it to whatever makes most sense from a docs perspective.

Perfect, let's allow @shainaraskas to share her thoughts for a final decision :)

Shaina, do you like the usage of the inline badge there? I don't feel it very intuitive and I've suggested to change it to a narrative sentence, but maybe both approaches are fine.

I agree that this is not ideal, partially because our labels don't look right in sentences.

one reason this is hard to reframe is that this is positioned as "one of these exceptions" - is this the only exception? are exceptions only valid as of 8.13?

this could get an Exceptions subheading that has an applies label at the heading level, ideally, if it makes sense.

if that doesn't make sense, I'd go with prose inline or a note inline. we'll have to refactor it later when we have more components at our disposal, but will read better in the short term.

I approved this PR already but some ECK 3.1 tagging should be added here before this is shipped

reference/fleet/advanced-kubernetes-managed-by-fleet.md

eedugon

LGTM!
Just minor suggestions for your consideration.

The applies_to inline badge doesn't feel natural here. In this case I'd prefer to use a narrative approach, but whatever you prefer.

barkbay · 2025-07-15T11:59:46Z

@eedugon, sorry it's my fault, I asked for a review without explaining why. I wanted to get a validation that this change was the way to go for the next ECK release, and that I was not missing something.

eedugon · 2025-07-15T12:16:02Z

no worries @barkbay! Yes, we just need to change the substitutions. PR approved already.
If upgrade or installation instructions remain the same we don't need to change anything else after releasing.

shainaraskas

overall this looks good. I think you've gotten most of what needs to be done for a release - sorry we weren't more proactive with sharing what needs to be done with you.

Provided a little additional feedback in the context of our cumulative docs model.

One other thing that you should check is that the upgrade instructions are still accurate in the context of 3.1. Does a 3.1 upgrade require an incremental 3.0 upgrade?

shainaraskas · 2025-07-16T18:41:42Z

deploy-manage/deploy/cloud-on-k8s.md

+* Kubernetes 1.29-1.33
+* OpenShift 4.15-4.19
 * Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)
 * Helm: {{eck_helm_minimum_version}}+


because these docs are going to continue to be valid for 3.0, we need to keep the 3.0 compatibility in this doc present.

could do it in tabs, table, or bulleted list. quickest hack would be:

Suggested change

* Kubernetes 1.29-1.33

* OpenShift 4.15-4.19

* Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)

* Helm: {{eck_helm_minimum_version}}+

* Kubernetes:

* {applies_to}`eck: 3.0`: 1.28-1.32

* {applies_to}`eck: 3.1`: 1.29-1.33

* OpenShift

* {applies_to}`eck: 3.0`: 4.14-4.18

* {applies_to}`eck: 3.1`: 4.15-4.19

* Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)

* Helm: {{eck_helm_minimum_version}}+

could do it in tabs, table, or bulleted list. quickest hack would be:

I think tabs would be the most appropriate, but let's try your suggestion first.

I'll now try the tabs...

Tab variant:

I think I'll stick with tabs, happy to get feedbacks though

Any option is fine. I like both.
The list will probably not scale well when having 8-10 releases to mention, so better the tabs for that reason probably.

IMHO, the tabs are not user friendly if the user knows his k8s version and wants to find out which ECK version he needs

Not a strong argument but this is already the case today. Also I can only remember users asking if the last version of K8s or OpenShift is supported by ECK. My feeling is that we're going to have to revisit this in the future, whatever our choice is today.

Anyways, I created this issue: elastic/docs-builder#1570

Maybe this could be a case for it.

I think if we go with tabs, the whole list will need to go in the tabs, because it's weird to split a list between tabs and not tabs

looking at the mock of the bulleted list, I think removing the colon would make it look right if you were still considering using it

I think if we go with tabs, the whole list will need to go in the tabs, because it's weird to split a list between tabs and not tabs

Makes sense, I'll do the change

shainaraskas · 2025-07-16T18:50:24Z

deploy-manage/deploy/cloud-on-k8s/configuration-fleet.md


+One of those exceptions is the configuration of providers as described in [advanced Agent configuration managed by Fleet](/reference/fleet/advanced-kubernetes-managed-by-fleet.md). When {{agent}} is managed by {{fleet}} and is orchestrated by ECK, the configuration of providers can simply be done through the `.spec.config` element in the Agent resource as of {applies_to}`stack: ga 8.13`:


I agree that this is not ideal, partially because our labels don't look right in sentences.

one reason this is hard to reframe is that this is positioned as "one of these exceptions" - is this the only exception? are exceptions only valid as of 8.13?

this could get an Exceptions subheading that has an applies label at the heading level, ideally, if it makes sense.

if that doesn't make sense, I'd go with prose inline or a note inline. we'll have to refactor it later when we have more components at our disposal, but will read better in the short term.

Fixes elastic/cloud-on-k8s#8689 --------- Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>

barkbay · 2025-07-17T07:13:29Z

Does a 3.1 upgrade require an incremental 3.0 upgrade?

Thanks for your reviews @shainaraskas! No this is not needed.

bmorelli25

Approving to unblock

barkbay · 2025-07-29T13:50:38Z

It seems eck_version has been removed from docset.yml, is it expected? (Also eck_release_branch)

barkbay · 2025-07-29T14:02:18Z

It seems eck_version has been removed from docset.yml, is it expected? (Also eck_release_branch)

It seems it has been renamed to version.eck, where is it managed now?

florent-leborgne · 2025-07-29T14:29:53Z

@barkbay Here: https://github.com/elastic/docs-builder/blob/main/config/versions.yml

barkbay · 2025-07-29T14:34:00Z

@florent-leborgne can we get some guidance on how to update it? Does it mean that we have to create 2 PRs for each ECK release? Which one should be merged first (if it matters?).

florent-leborgne · 2025-07-29T15:29:20Z

@barkbay I think that @elastic/docs-engineering is working on making this simpler but right now yes, you have to sync with them to bump the version in docs-builder (also see https://elastic.github.io/docs-builder/contribute/release-new-version/)

reakaleek · 2025-07-29T15:44:24Z

We need to update the current version here: https://github.com/elastic/docs-builder/blob/main/config/versions.yml#L22

Generally, we should update the versions.yml after the documentation change.

Applies_to tags will be rendered as ECK Planned if you are specifying the new version already in the docs.

After we bump the version in the versions.yml file, it will be rendered as ECK 3.1.0

eedugon · 2025-07-29T16:09:08Z

@barkbay : I've created elastic/docs-builder#1648 to bump the current version of ECK to 3.1.0.

We can merge it as soon as we merge this PR. I'll contact you in private if case you want me to update all our ECK docs in this PR and move the usage of the legacy substitutions to the new variables.

eedugon · 2025-07-29T16:35:08Z

I think this is ready for merging, I don't see any problem with this PR in relation with the new variables.
I see {{version.eck}} and {{version.eck | M.M}} are used properly.

Worst thing it could happen is to find certain places in the docs where something is not properly rendered due to this, and we could apply a quick fix afterwards.

eedugon

LGTM

pebrc and others added 3 commits May 22, 2025 21:12

Merge remote-tracking branch 'origin/main' into eck-3.1.0

8f9ab83

Update supported versions

9eb86fc

barkbay requested a review from a team July 3, 2025 06:14

barkbay added eck v9.1.0 labels Jul 3, 2025

Update ECK version in docset.yml

02d6b31

barkbay requested a review from eedugon July 15, 2025 08:36

eedugon reviewed Jul 15, 2025

View reviewed changes

reference/fleet/advanced-kubernetes-managed-by-fleet.md Show resolved Hide resolved

eedugon approved these changes Jul 15, 2025

View reviewed changes

Merge remote-tracking branch 'origin/main' into eck-3.1.0

a87dc88

shainaraskas reviewed Jul 16, 2025

View reviewed changes

ECK: Document annotations and labels propagation (#2144)

a2b1869

Fixes elastic/cloud-on-k8s#8689 --------- Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com> Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>

barkbay marked this pull request as ready for review July 17, 2025 06:32

barkbay requested review from a team as code owners July 17, 2025 06:32

barkbay and others added 3 commits July 17, 2025 08:34

Keep supported versions for 3.0 available

8bfed5d

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>

fix applies_to syntax

10267d2

Test tabs

9138b0d

barkbay mentioned this pull request Jul 17, 2025

[3.1] Add release notes elastic/cloud-on-k8s#8754

Merged

reakaleek mentioned this pull request Jul 17, 2025

[Feature Request]: Compatibility matrix elastic/docs-builder#1570

Open

2 tasks

Include CSP and Helm info in the tabs

8359ee0

shainaraskas approved these changes Jul 22, 2025

View reviewed changes

bmorelli25 approved these changes Jul 22, 2025

View reviewed changes

Merge remote-tracking branch 'origin/main' into eck-3.1.0

fb200bd

barkbay requested review from shainaraskas and eedugon July 29, 2025 14:04

eedugon approved these changes Jul 29, 2025

View reviewed changes

barkbay mentioned this pull request Jul 30, 2025

Update ECK current version to 3.1.0 elastic/docs-builder#1648

Merged

Merge branch 'main' into eck-3.1.0

eb216f8

eedugon enabled auto-merge (squash) July 30, 2025 07:24

eedugon merged commit c5f6b13 into main Jul 30, 2025
7 of 8 checks passed

eedugon deleted the eck-3.1.0 branch July 30, 2025 07:27


		One of those exceptions is the configuration of providers as described in [advanced Agent configuration managed by Fleet](/reference/fleet/advanced-kubernetes-managed-by-fleet.md). When {{agent}} is managed by {{fleet}} and is orchestrated by ECK, the configuration of providers can simply be done through the `.spec.config` element in the Agent resource as of {applies_to}`stack: ga 8.13`:

[ECK] Update documentation for 3.1.0 #2019

[ECK] Update documentation for 3.1.0 #2019

Uh oh!

Conversation

barkbay commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 Preview links for changed docs

Uh oh!

barkbay commented Jul 15, 2025

Uh oh!

eedugon Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eedugon Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eedugon left a comment

Choose a reason for hiding this comment

Uh oh!

barkbay commented Jul 15, 2025

Uh oh!

eedugon commented Jul 15, 2025

Uh oh!

shainaraskas left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

barkbay commented Jul 17, 2025

Uh oh!

bmorelli25 left a comment

Choose a reason for hiding this comment

Uh oh!

barkbay commented Jul 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

barkbay commented Jul 29, 2025

Uh oh!

florent-leborgne commented Jul 29, 2025

Uh oh!

barkbay commented Jul 29, 2025

barkbay commented Jul 3, 2025 •

edited

Loading

github-actions bot commented Jul 3, 2025 •

edited

Loading

eedugon Jul 15, 2025 •

edited

Loading

eedugon Jul 15, 2025 •

edited

Loading

shainaraskas left a comment •

edited

Loading

barkbay commented Jul 29, 2025 •

edited

Loading

reakaleek commented Jul 29, 2025 •

edited

Loading