aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAaron LI <aly@aaronly.me>2018-12-01 16:07:58 +0800
committerAaron LI <aly@aaronly.me>2018-12-01 16:07:58 +0800
commit8e27df82ca0bc380d72e2e44acb96be9c2ee556c (patch)
tree8ce73caac7c41fb9f5fca3581b043a9591819d9b
parent7462c9d247fcdaaf6c5d9f11238254f0a37febcc (diff)
downloadansible-dfly-vps-8e27df82ca0bc380d72e2e44acb96be9c2ee556c.tar.bz2
README: Add basic usage and Ansible version
-rw-r--r--README.md36
1 files changed, 35 insertions, 1 deletions
diff --git a/README.md b/README.md
index 95b0bfa..9fdfde5 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,11 @@ Ansible Playbooks for Personal DragonFly BSD Server
Created: 2018-02-14
+Ansible: 2.7.1
+
Introduction
------------
-An Ansible playbook to manage a small (even 512 MB RAM) personal VPS to
+An Ansible playbook to manage a very small (read 512MB RAM) VPS to
self-host various services including:
* _DNS_ (NSD for authoritative DNS service)
* _Email_ (Postfix, Dovecot)
@@ -109,6 +111,38 @@ Extensions
* `filter_plugins/`
Custom template filters
+Usages
+------
+* Test host connection:
+
+ ```
+ $ ansible vultr -m ping
+ ```
+
+* List tasks:
+
+ ```
+ $ ansible-playbook -v --list-tasks
+ ```
+
+* Run (check only but don't make changes) the whole playbook:
+
+ ```
+ $ ansible-playbook -vD [--check]
+ ```
+
+* Run the playbook from a specific task:
+
+ ```
+ $ ansible-playbook -vD --step --start-at-task="..."
+ ```
+
+* Run the tasks with specific tags:
+
+ ```
+ $ ansible-playbook -vD --tags="..."
+ ```
+
References
----------
* Securing a Server with Ansible