NETWAYS / NETWAYS/ansible-collection-elasticstack
Clean up small issues in the elasticsearch role
Nobody has claimed this yet.
- Dominant language
- Jinja
- Stars
- 14
- Forks
- 11
- Avg merge
- 1d 47m
- Merged PRs (30d)
- 6
Description
Minor code-quality issues found while documenting the elasticsearch role. Relates to #396.
1. Typo elaticsearch_cluster_set_up (missing "s") — set in tasks/main.yml and tasks/elasticsearch-security.yml, read in templates/elasticsearch.yml.j2. Consistently misspelled so it works, but fragile (fixing one occurrence breaks it). Rename to elasticsearch_cluster_set_up everywhere.
2. elasticstack_temperature is misnamed and undocumented — used only by this role (node.attr.temp) but carries the shared elasticstack_* prefix, so it falls outside both the role's argument_specs.yml and the shared-variables doc. Rename to elasticsearch_temperature and document it (optionally switch node.attr.temp to data-tier node.roles). Breaking; also relates to #485.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Elasticsearch role files tasks/main.yml, tasks/elasticsearch-security.yml, templates/elasticsearch.yml.j2, and argument_specs.yml, then locate the shared-variables documentation. Rename both variables consistently, document elasticsearch_temperature, and verify that the role's references and argument specifications agree; the optional node.roles change is separately noted as breaking.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ansible, elasticsearch
- Domain
- devops, documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100