Eck 3.5.0 release - #7590
Conversation
## Summary Add documentation for the ECK feature Dynamic Namespaces Handling. (GH Issue: [here](elastic/cloud-on-k8s#9490) PR: [here](elastic/cloud-on-k8s#9569)) ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [X] Yes - [ ] No 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: Claude Fable 5 > Note: this PR is targeting an intermediate branch `eck-3.5.0` that will be pull-requested to `main` once the new release 3.5.0 is GA
…windows (#7476) <!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Adds a new ECK 3.5 page documenting the `eck.k8s.elastic.co/pause-orchestration` annotation, covering supported resources, what continues vs. pauses, observability via the OrchestrationPaused condition, and its distinction from the deprecated `managed=false` annotation. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Sonnet 4.6 <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: Sonnet 4.6 -->
…figPolicy (#7477) <!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Documents the ECK 3.5 `variablesFrom` field in StackConfigPolicy, which allows externalising environment-specific values into ConfigMaps or Secrets and referencing them as `${VAR}` expressions in policy fields, with examples and namespace restriction rules. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Sonnet 4.6 <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: Sonnet 4.6 -->
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Documents the ECK 3.5 `securityRoles` field in StackConfigPolicy, which allows defining custom Elasticsearch roles declaratively via `roles.yml` with hot-reload — no pod restart required. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> Tool(s) and model(s) used: Sonnet 4.6 --------- Co-authored-by: Peter Brachwitz <peter.brachwitz@gmail.com>
…config/configRef (#7473) <!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Extends the AutoOps data collection page with an ECK tab showing how to configure the AutoOps agent collector via `spec.config` (inline YAML) or `spec.configRef` (Secret reference) on `AutoOpsAgentPolicy`, replacing the manual file-editing approach for ECK users. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Sonnet 4.6 <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: Sonnet 4.6 -->
…s and add Fleet Server mTLS page (#7474) <!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Expands the Elasticsearch client certificate authentication docs to cover all ECK 3.5 stack components (APM, Beats, Logstash, Enterprise Search, Maps, Agent, Fleet Server) with per-component custom cert examples and known limitations, and adds a dedicated Fleet Server mTLS page. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Sonnet 4.6 <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: Sonnet 4.6 -->
…icsearch (#7475) <!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Documents the opt-in file-based secure settings hot-reload for Elasticsearch 9.5+ on ECK 3.5, covering the annotation, compatible settings, and the important caveat about startup-required settings. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Tool(s) and model(s) used: Sonnet 4.6 <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: Sonnet 4.6 -->
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Elastic Docs Style Checker (Vale)Summary: 5 warnings, 5 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/cloud-on-k8s/dynamic-namespace-handling.md | 96 | Elastic.Spelling | 'Offboarding' is a possible misspelling. |
| deploy-manage/deploy/cloud-on-k8s/dynamic-namespace-handling.md | 98 | Elastic.Spelling | 'offboard' is a possible misspelling. |
| deploy-manage/deploy/cloud-on-k8s/dynamic-namespace-handling.md | 105 | Elastic.Spelling | 'Offboarding' is a possible misspelling. |
| deploy-manage/deploy/cloud-on-k8s/dynamic-namespace-handling.md | 118 | Elastic.Spelling | 'offboarded' is a possible misspelling. |
| deploy-manage/license/manage-your-license-in-eck.md | 101 | Elastic.Spelling | 'offboarded' is a possible misspelling. |
💡 Suggestions (5): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/cloud-on-k8s/dynamic-namespace-handling.md | 36 | Elastic.WordChoice | Consider using 'deactivates, deselects, hides, turns off, makes unavailable' instead of 'disables', unless the term is in the UI. |
| deploy-manage/monitor/autoops/autoops-disable-metrics-collection.md | 17 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| deploy-manage/security/k8s-es-client-certificate-auth.md | 53 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/security/k8s-fleet-server-client-certificate-auth.md | 46 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| deploy-manage/security/k8s-fleet-server-client-certificate-auth.md | 84 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'Disable', unless the term is in the UI. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…on.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…on.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
…on.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
eedugon
left a comment
There was a problem hiding this comment.
A lot of new and useful features in this release, great work!
I've shared a few comments. If you feel any of them is too big for a last-minute update we can create a follow up issue in docs-content-internal for a later update.
|
|
||
| # Pause orchestration on ECK [k8s-pause-orchestration] | ||
|
|
||
| During maintenance windows, such as draining {{k8s}} nodes or applying infrastructure changes, you can temporarily prevent ECK from applying spec changes to your Elastic resources. The `eck.k8s.elastic.co/pause-orchestration` annotation lets you freeze spec-driven orchestration on any ECK-managed resource while ECK continues essential maintenance tasks such as certificate rotation and health monitoring (see [What continues and what pauses](#k8s-pause-orchestration-behaviour)). |
There was a problem hiding this comment.
Is there any way to pause orchestration of all resources without applying the annotation individually to all resources?
If so it would be great to explain it somewhere in the section. Otherwise I think we are fine without explicitly saying it, your call :)
| kubectl annotate --overwrite elastic --all $ANNOTATION | ||
|
|
||
| # Pause all resources in all of the namespaces: | ||
| for NS in $(kubectl get ns -o=custom-columns='NAME:.metadata.name' --no-headers); do kubectl annotate --overwrite elastic --all $ANNOTATION -n $NS; done |
There was a problem hiding this comment.
Maybe this trick could be added to the document that describes pausing orchestration too. It relates with one of my previous comments.
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Co-authored-by: Edu González de la Herrán <25320357+eedugon@users.noreply.github.com>
Update the documentation for the upcoming ECK 3.5.0 release
This pr contains all of these sub-PRs that have been approved individually.
Expect this commit 013667f that is new to this PR.