Skip to content

[Umbrella]: Collection-wide variable naming and specification hygiene #545

Description

@afeefghannam89

Problem

Variable naming and the role argument specifications are handled ad hoc. Names follow no
documented schema, internal runtime variables are indistinguishable from user-facing ones and
are partly declared in defaults/main.yml and meta/argument_specs.yml, and single-role
variables sit in the elasticstack meta role. As a result every issue that renames something
re-decides the same rules.

Want

One documented naming schema, applied across all roles, with internal variables kept out of the
user-facing contract.

Children

#474 has to run after #495, because #495 removes internal variables from defaults/main.yml and
meta/argument_specs.yml - auditing first would cover entries that #495 then deletes. #544
comes last so that no variable is renamed twice.

elasticstack_password needs both an internal prefix and a meaningful name. It is touched only
once, in #495, with the target name __elasticstack_elastic_password.

Metadata

Metadata

Assignees

No one assigned

    Labels

    component:allAffects the whole collection, not a single rolequalityInternal improvement: refactoring, consistency, tests - no new capability

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions