path: root/docs
diff options
authorThomas Wiest <>2015-05-27 16:00:16 -0400
committerThomas Wiest <>2015-05-27 16:00:16 -0400
commit2df865bb6d627f991fd69b6c554c52f15bdcdf62 (patch)
tree7ae26fc148d4c86f461ded335feb03e052d485da /docs
parentf026ffd836e8a014d4cff370f695f35554f82528 (diff)
added section for role naming to the best practices guide.
Diffstat (limited to 'docs')
1 files changed, 15 insertions, 1 deletions
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
*[Ansible Suggested Directory Layout]
@@ -94,6 +94,20 @@ metadata[line] = results.pop()
* Make it familiar for new contributors
* Make it compatible with Ansible Galaxy
+| **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.
+* The role to configure an OpenShift Master is called `openshift_master`
+* The role to configure OpenShift specific yum repositories is called `openshift_repos`
=== Filters