Open colin-mccarthy opened 5 years ago
cc @cidrblock @ikhan2010 @abenokraitis @privateip
The goal is to import the role, not to chop up the contents of the role. I think that's what the disclaimer is getting at. It is much easier to support a role that is imported, rather than using individual tasks within the role as part of the playbook.
It sounded to me like the author was suggesting you add this to the meta/mail.yml of the other network roles and not invoke this role by itself in a playbook. I'm okay with closing the issue if you think other folks will understand it the way you described.
ISSUE TYPE
SUMMARY
I don't beleive the README.md should advise users not to invoke the network-engine role directly in a playbook. I suggest the removal of this wording.
It's a common practice to invoke the role at the beginning of the playbook, this wording also doesn't match with the later wording.
Any of the provided functions can be implemented in Ansible playbooks directly.
If you can use the functions in the playbook why can't you invoke the role in the playbook?
STEPS TO REPRODUCE
This role provides the foundation for building network roles by providing modules and plugins that are common to all Ansible Network roles.
Typically this role should not be directly invoked in a playbook.