Improve the documentation of logstash role#473
Open
afeefghannam89 wants to merge 24 commits into
Open
Conversation
7 tasks
Saeid-Abadi
approved these changes
Jul 1, 2026
This was referenced Jul 1, 2026
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.
Migrates the logstash role's documentation to a single source of truth:
its
meta/argument_specs.yml. Variable docs are no longer hand-maintained indocs/role-logstash.md, instead Ansible validates the variables at runtime andansible-docsmith generates the
variable table in
roles/logstash/README.mdfrom the spec.Part of #234, #218.
Changes
Documentation source & output
roles/logstash/meta/argument_specs.yml— documents all role variables(incl. nested
logstash_pipelinessub-options and outputcondition/congestion).roles/logstash/README.md— generated, compact variable table + hand-writtenintro, requirements, example, Tags section.
.docsmith/readme.md.j2— shared compact README template for all roles.roles/logstash/docs/pipelines.md— fixed examples to the correct listformat and
queue_type/queue_max_bytes; merged the duplicatedocs/logstash-pipelines.md(removed).Wiring & cleanup
README.md/docs/getting-started.md— link to the role README.docs/role-logstash.md— slim pointer to the role README.README.md— Contributing note describing the argument_specs/README workflow.galaxy.yml— ignore.docsmith/in the build.roles/logstash/defaults/main.yml—logstash_config_backupnow an explicitboolean (
falseinstead ofno).logstash_reset_writer_role(role/user managementis handled by the
netways.elasticstack.elasticsearch_rolemodule) andlogstash_queue_type(never wired into any template or any task)CI
.github/workflows/test_docs.yml— new docs gate (validate + README freshness).test_roles_pr.yml/test_role_logstash.yml— documentation-only changes nolonger trigger the heavy molecule matrix.