Skip to content

Fix hints autodiscovery init container doc#5640

Merged
eedugon merged 3 commits into
mainfrom
eedugon/fix-hints-autodiscovery-initcontainer
Mar 27, 2026
Merged

Fix hints autodiscovery init container doc#5640
eedugon merged 3 commits into
mainfrom
eedugon/fix-hints-autodiscovery-initcontainer

Conversation

@eedugon

@eedugon eedugon commented Mar 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Replace invalid master image/tag guidance with versioned image usage ({{version.stack}}) in the initContainer example.
  • Fix the tarball extraction command to target main paths and use explicit --strip-components=5 behavior.
  • Clarify ECK volume naming (elastic-data vs elastic-agent-state) and fix two minor doc typos (kuernetes, cat f).

Test plan

  • Verify only reference/fleet/hints-annotations-autodiscovery.md is changed in this PR.
  • Validate rendered command logic against current GitHub archive path prefix (elastic-agent-main/).
  • Run docs lint checks for the edited file in IDE (no lint errors).

Made with Cursor

Relates with #5397

Update the initContainer example to use a versioned Elastic Agent image and the main branch tarball path, and clarify the ECK volume naming caveat. Also fix minor command and spelling issues in the troubleshooting and Kubernetes log-collection sections.

Made-with: Cursor
@eedugon
eedugon requested a review from a team as a code owner March 26, 2026 12:12
@eedugon
eedugon requested a review from lucabelluccini March 26, 2026 12:13
@github-actions

github-actions Bot commented Mar 26, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

@github-actions

github-actions Bot commented Mar 26, 2026

Copy link
Copy Markdown
Contributor

Vale Linting Results

Summary: 2 suggestions found

💡 Suggestions (2)
File Line Rule Message
reference/fleet/hints-annotations-autodiscovery.md 251 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.
reference/fleet/hints-annotations-autodiscovery.md 251 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.

@lucabelluccini lucabelluccini left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you Edu

@eedugon eedugon changed the title Fix hints autodiscovery init container docs Fix hints autodiscovery init container doc Mar 26, 2026

@jeanfabrice jeanfabrice left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest change in eck volume name

- name: elastic-agent-state <1>
mountPath: /usr/share/elastic-agent/state
```
1. If you are integrating this init container into {{eck}} manifests, verify the `volume` name defined in the Pod spec, which is usually `elastic-data` rather than `elastic-agent-state`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread reference/fleet/hints-annotations-autodiscovery.md Outdated
@eedugon
eedugon requested a review from jeanfabrice March 27, 2026 09:36
@eedugon
eedugon dismissed jeanfabrice’s stale review March 27, 2026 11:34

Change made :)

@eedugon
eedugon merged commit de56d56 into main Mar 27, 2026
6 of 7 checks passed
@eedugon
eedugon deleted the eedugon/fix-hints-autodiscovery-initcontainer branch March 27, 2026 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants