From 2df865bb6d627f991fd69b6c554c52f15bdcdf62 Mon Sep 17 00:00:00 2001 From: Thomas Wiest Date: Wed, 27 May 2015 16:00:16 -0400 Subject: added section for role naming to the best practices guide. --- docs/best_practices_guide.adoc | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/best_practices_guide.adoc b/docs/best_practices_guide.adoc index 83df53735..301c6ccda 100644 --- a/docs/best_practices_guide.adoc +++ b/docs/best_practices_guide.adoc @@ -78,7 +78,7 @@ metadata[line] = results.pop() == Ansible -=== Role Directory +=== Roles .Context * http://docs.ansible.com/playbooks_best_practices.html#directory-layout[Ansible Suggested Directory Layout] @@ -94,6 +94,20 @@ metadata[line] = results.pop() * Make it familiar for new contributors * Make it compatible with Ansible Galaxy +''' +[cols="2v,v"] +|=== +| **Rule** +| Ansible Roles SHOULD be named like technology_component[_subcomponent]. +|=== + +For clarity, it is suggested to follow a pattern when naming roles. It is important to note that this is a recommendation for role naming, and follows the pattern used by upstream. + +Many times the `technology` portion of the pattern will line up with a package name. It is advised that whenever possible, the package name should be used. + +.Examples: +* The role to configure an OpenShift Master is called `openshift_master` +* The role to configure OpenShift specific yum repositories is called `openshift_repos` === Filters .Context: -- cgit v1.2.1