diff options
author | Thomas Wiest <twiest@users.noreply.github.com> | 2015-07-08 10:50:49 -0400 |
---|---|---|
committer | Thomas Wiest <twiest@users.noreply.github.com> | 2015-07-08 10:50:49 -0400 |
commit | 6951440c539fce4aea592871a768cb34650ef2d2 (patch) | |
tree | 8fcdebfb1fe25b884e33c93d54889622bfd722b1 /docs/style_guide.adoc | |
parent | 442abb7a4cb8c5c36b38ff38f2315a6a8b380ffa (diff) | |
parent | 0e67b142b4cb069c8986ac025ece78b8acb162ef (diff) | |
download | openshift-6951440c539fce4aea592871a768cb34650ef2d2.tar.gz openshift-6951440c539fce4aea592871a768cb34650ef2d2.tar.bz2 openshift-6951440c539fce4aea592871a768cb34650ef2d2.tar.xz openshift-6951440c539fce4aea592871a768cb34650ef2d2.zip |
Merge pull request #328 from twiest/pr
documented ansible arch team decisions
Diffstat (limited to 'docs/style_guide.adoc')
-rw-r--r-- | docs/style_guide.adoc | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/docs/style_guide.adoc b/docs/style_guide.adoc index 2f89a5fae..110e7153f 100644 --- a/docs/style_guide.adoc +++ b/docs/style_guide.adoc @@ -57,18 +57,34 @@ Ansible tooling (like `ansible-galaxy init`) create files with a .yml extension. Example: `tasks.yml` -=== 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 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 how dangerous they are (can 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 |