From: Christian Pointner <equinox@realraum.at>
Date: Sun, 23 Dec 2018 14:12:56 +0000 (+0100)
Subject: add some info about ansible-lint
X-Git-Url: https://git.realraum.at/?p=noc.git;a=commitdiff_plain;h=43e4d798581d4755c4e32dcc179ceb514384cebe

add some info about ansible-lint
---

diff --git a/ansible/README.md b/ansible/README.md
index a020642..967d1db 100644
--- a/ansible/README.md
+++ b/ansible/README.md
@@ -40,6 +40,24 @@ ansible-playbook foo.yml
 ./apply-role.sh servers base -C -D
 ```
 
+ansible-lint
+------------
+
+We use ansible-lint to check all roles when changes are pushed to Github.
+Some rules have been globally disabled. See [.ansible-lint](/ansible/.ansible-lint)
+for a list of all disabled rules. If ansible-lint produces a false positive for
+a specific task you can disable it by adding the following to the task:
+
+```
+  tags:
+  - skip_ansible_lint
+```
+
+For now only roles are checked and every role must be manually added to the
+generic playbook [_lint_roles.yml](/ansible/_lint_roles.yml) in order to be checked.
+If an entire role should be skipped please add it to the playbook commented out
+and supply a reason why this roles must be skipped.
+
 
 Local ssh config
 ----------------