diff options
author | Kenny Woodson <kwoodson@redhat.com> | 2015-10-29 11:14:51 -0400 |
---|---|---|
committer | Kenny Woodson <kwoodson@redhat.com> | 2015-10-29 11:14:51 -0400 |
commit | 9bbaa824da5e1a049cdec1a6523c3841d713386c (patch) | |
tree | 93e80f1577ad0f2f5f8931b493c50cd9aa657c77 /docs/style_guide.adoc | |
parent | 15df494fb781dd1509854eeb366e981930b52c22 (diff) | |
parent | 16d1bce0be2f8c3942489630adcb7030aecadc55 (diff) | |
download | openshift-9bbaa824da5e1a049cdec1a6523c3841d713386c.tar.gz openshift-9bbaa824da5e1a049cdec1a6523c3841d713386c.tar.bz2 openshift-9bbaa824da5e1a049cdec1a6523c3841d713386c.tar.xz openshift-9bbaa824da5e1a049cdec1a6523c3841d713386c.zip |
Merge pull request #763 from openshift/master
Merge master into prod.
Diffstat (limited to 'docs/style_guide.adoc')
-rw-r--r-- | docs/style_guide.adoc | 38 |
1 files changed, 34 insertions, 4 deletions
diff --git a/docs/style_guide.adoc b/docs/style_guide.adoc index 3b888db12..09d4839c7 100644 --- a/docs/style_guide.adoc +++ b/docs/style_guide.adoc @@ -1,6 +1,6 @@ // vim: ft=asciidoc -= Openshift-Ansible Style Guide += openshift-ansible Style Guide The purpose of this guide is to describe the preferred coding conventions used in this repository (both in ansible and python). @@ -43,18 +43,48 @@ This is a hard limit and is enforced by the build bot. This check MUST NOT be di == Ansible -=== Ansible Global Variables -Ansible global variables are defined as any variables outside of ansible roles. Examples include playbook variables, variables passed in on the cli, etc. +=== Ansible Yaml file extension +''' +[cols="2v,v"] +|=== +| **Rule** +| All Ansible Yaml files MUST have a .yml extension (and NOT .YML, .yaml etc). +|=== + +Ansible tooling (like `ansible-galaxy init`) create files with a .yml extension. Also, the Ansible documentation website references files with a .yml extension several times. Because of this, it is normal in the Ansible community to use a .yml extension for all Ansible Yaml files. + +Example: `tasks.yml` + + +=== Ansible CLI Variables +''' +[cols="2v,v"] +|=== +| **Rule** +| Variables meant to be passed in from the ansible CLI MUST have a prefix of cli_ +|=== + +Ansible allows variables to be passed in on the command line using the `-e` option. These variables MUST have a prefix of cli_ so that it's clear where they came from, and that they could be exploited. + + +.Example: +[source] +---- +ansible-playbook -e cli_foo=bar someplays.yml +---- + +=== Ansible Global Variables ''' [cols="2v,v"] |=== | **Rule** | Global variables MUST have a prefix of g_ |=== +Ansible global variables are defined as any variables outside of ansible roles. Examples include playbook variables, variables passed in on the cli, etc. -Example: +.Example: [source] ---- g_environment: someval |