Update documentation for accuracy and newcomer experience#101
Merged
Conversation
The cert_validate.yml shared task probes files with openssl to detect PEM vs PKCS12 format rather than relying on file extensions. The docs in several places incorrectly stated the format was auto-detected from the extension. Also adds cert_validate.yml to the shared certificate tasks table in the elasticstack role docs, where it was missing.
The getting-started guide now explains how to retrieve initial passwords and where they live in multi-node deployments. The security-disabling section correctly shows that elasticstack_security cascades in full-stack mode. Added a note that elasticstack_release defaults to 8 since the examples all use 9. Beats security auto-inheritance from the global flag is now in the main description instead of buried in a note. ES heap docs mention container cgroup recalculation.
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
1 participant
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.
Two commits here. The first fixes factual inaccuracies about certificate format detection — the docs said it was extension-based but cert_validate.yml actually probes file content with openssl. Also adds the missing cert_validate.yml entry to the shared tasks table.
The second commit improves the getting-started guide and role docs for first-time readers: explains how to retrieve initial passwords and where they live in multi-node clusters, fixes the security-disabling section to show that elasticstack_security cascades in full-stack mode, adds a note that elasticstack_release defaults to 8 (since all examples show 9), moves beats security auto-inheritance into the main variable description instead of a footnote, and mentions container cgroup heap recalculation in the ES docs.