Author: zaran.krleza

Description:
At the moment, there are two ways to enable a role in the puppet configuration: either by editing the Roles.yaml file in the root directory, or by editing puppet/manifests/sites.pp

I want to point out that this can be confusing for someone who is not familiar with the puppet machinery. As I am myself unfamiliar with it, here are the questions which naturally came to my mind:

• how does puppet know how to use the Roles.yaml file?
• which file has precedence over which?

Maybe (and this is just a suggestion) it would be less confusing to have the file sites.pp being automatically updated to reflect the content of Roles.yaml and vice versa?

Is the Roles.yaml file really needed? Is it much simpler for the user to edit Roles.yaml instead of puppet/manifests/sites.pp? Especially since it is just a matter of commenting/uncommenting lines?

There are probably other reasons that I am missing here, but in any case, the documentation should be updated to presently recommend editing the Roles.yaml file.

Version: unspecified
Severity: enhancement