Initiative Overview
It is very easy for the implementation of Ansible roles to become an unmaintainable mess if we don't set clear standards and expectations to ensure that the roles don't leak variables and get implemented in entirely different ways.
We can see that already happening when we implemented this PR where we observe that multiple services have different entrypoints for the service updates, making it more difficult to maintain than if there was just one. There should really be one entrypoint, and the ordering should be an internal detail to the role, not exposed externally.
To help reduce this from happening, we should clearly define the update & upgrade interfaces for the roles, and then to work with the teams to implement the changes and ensure that all roles implemented conform to the same standard.
Goals
- Document the standard for Ansible roles for update & upgrade workflows
- Socialise the standard across the teams
- Work with the teams to implement the common standard across all existing roles
Done - Acceptance Criteria
- All roles have a single entrypoint for ** updates
- All roles have a single entrypoint for upgrades
Out of Scope _{}(Initial completion while in Refinement status):{_}
High-level list of items or persona’s that are out of scope.
<your text here>
- …