summaryrefslogtreecommitdiffstats
path: root/STYLEGUIDE
blob: 7a6863035b338caeaaa3da5b2b144b3cae8f1574 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
infrastructure ansible style guide
==================================

* run changes through 'ansible-review'. 
  ERRORs must be corrected or rules changed. 
  WARNs should be corrected.

  Rules changes can be proposed to 
  https://pagure.io/cpe/ansible-review-templates/ 

* Use 'yml' instead of 'yaml' 

* do add '.j2' to the end of templates

* in general let readablity trump grepability, ie: 

DONT:
- name: This is some play
  module: name=thing arg=thing2 anotherlongerarg=thing arg4=anodheranth
  
DO:
- name: This is some play
  module:
  - name: thing
  - arg: thing2
..etc