summaryrefslogtreecommitdiffstats
path: root/docs/best_practices_guide.adoc
diff options
context:
space:
mode:
authorMatt Woodson <mwoodson@gmail.com>2015-05-27 16:09:22 -0400
committerMatt Woodson <mwoodson@gmail.com>2015-05-27 16:09:22 -0400
commit551562cd54f06db6e96e6f8d8986bc08a27c7d8a (patch)
tree7ae26fc148d4c86f461ded335feb03e052d485da /docs/best_practices_guide.adoc
parentf026ffd836e8a014d4cff370f695f35554f82528 (diff)
parent2df865bb6d627f991fd69b6c554c52f15bdcdf62 (diff)
downloadopenshift-551562cd54f06db6e96e6f8d8986bc08a27c7d8a.tar.gz
openshift-551562cd54f06db6e96e6f8d8986bc08a27c7d8a.tar.bz2
openshift-551562cd54f06db6e96e6f8d8986bc08a27c7d8a.tar.xz
openshift-551562cd54f06db6e96e6f8d8986bc08a27c7d8a.zip
Merge pull request #253 from twiest/pr2
added section for role naming to the best practices guide.
Diffstat (limited to 'docs/best_practices_guide.adoc')
-rw-r--r--docs/best_practices_guide.adoc16
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
.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: