ES install: add cgroup v2 compatibility warning for affected versions - #7983
Open
kunisen wants to merge 5 commits into
Open
ES install: add cgroup v2 compatibility warning for affected versions#7983kunisen wants to merge 5 commits into
kunisen wants to merge 5 commits into
Conversation
Contributor
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. |
Contributor
Contributor
Elastic Docs Style Checker (Vale)Summary: 2 suggestions found 💡 Suggestions (2): Optional style improvements. Apply when helpful.
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. |
Contributor
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Two new sentences use literal "Elasticsearch" instead of the
{{es}}substitution used consistently throughout both pages — flagged inline with suggested fixes. Also flagged unnecessary "Note that" preamble. - Jargon: None found — "cgroups" and "JDK" are used in context with a linked man-page reference.
- Frontmatter and applies_to: No frontmatter changes in this PR; existing
applies_to/productsmetadata untouched and still valid for both files. - Content type fit: Both are how-to/reference pages; the new content is a short warning bullet/subsection consistent with surrounding structure. No mismatch.
- Contradictions: No contradictions found — the new cgroups v2 warning is additive and consistent with Elastic's published KB guidance on this bug.
- Parent issue satisfaction: Satisfied — the PR adds the requested warning in both the installation page and the system configuration checklist, each linking to the KB article.
Nits
- Vale flagged several pre-existing "may" → "can/might" and "In some cases" → "sometimes" suggestions in
installing-elasticsearch.md; these are in unchanged surrounding text and not required for this PR.
Notes
- Reviewed only the two eligible changed markdown files per
repo-wide-markdownscope.
Generated by Docs review agent for #7983 · sonnet50 · 31.6 AIC · ⌖ 6.64 AIC · ⊞ 17.1K
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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
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.
Summary
Adds a cgroup v2 compatibility warning for Elasticsearch versions 8.0.0–8.4.3 and 7.15.1–7.17.6, which fail to start on Linux hosts running pure cgroup v2 due to a bug in the bundled JDK.
This PR adds a new
### Linux cgroups versionsubsection to the Supported operating systems and JVMs section of the Install Elasticsearch page, and a corresponding bullet in the Important system configuration checklist, both pointing to the KB article for detailed guidance.Related: elastic/support-tech-lead#1913
Generative AI disclosure
Tool(s) and model(s) used: Claude (Anthropic) via Cowork