From 0c19892158609d1eb64015f84e53eb5685c97441 Mon Sep 17 00:00:00 2001
From: Max Campbell <maxc@maxc.in>
Date: Tue, 26 Mar 2019 09:32:21 +0100
Subject: Add initial README.md and CONTRIBUTING.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b82fdb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Labitat Ansible
+
+Ansible playbooks for space infrastructure
+
+## Running ansible
+
+```
+ansible-playbook <playbook>.yml -D [-t <tag>[,<tag2>,..]] [-C]
+```
+- `<playbook>.yml`: the playbook you wish to run
+- `-D`: prints the changes made, fx. the difference between old and updated files
+- `-t <tag>`: limit the run to certain tags, tasks are usually tagged with their name
+- `-C`: don't make any changes, just show what would be changed
+
+example:
+```
+ansible-playbook jumbotron.yml -D -t irssi -C
+```
+
+This will log into the jumbotron server and show how the irssi configuration
+would be updated by your local changes in your ansible repo.
+
+```
+ansible-playbook jumbotron.yml -D -t irssi
+```
+This will actually do the changes, but again limit itself to just the tasks that are
+tagged `irssi`.
-- 
cgit v1.2.1