polish etcd_common role

alex-berger · May 9, 2017 · f696358 · f696358
1 parent f7993af
commit f696358
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 10 deletions.
diff --git a/playbooks/common/openshift-cluster/upgrades/etcd/files/etcdctl.sh b/playbooks/common/openshift-cluster/upgrades/etcd/files/etcdctl.sh
diff --git a/roles/etcd_common/README.md b/roles/etcd_common/README.md
@@ -1,17 +1,21 @@
 etcd_common
 ========================
 
-TODO
+Common resources for dependent etcd roles. E.g. default variables for:
+* config directories
+* certificates
+* ports
+* other settings
 
-Requirements
-------------
-
-TODO
+Or `delegated_serial_command` ansible module for executing a command on a remote node. E.g.
 
-Role Variables
---------------
+```yaml
+- delegated_serial_command:
+    command: /usr/bin/make_database.sh arg1 arg2
+    creates: /path/to/database
+```
 
-TODO
+Or etcdctl.yml playbook for installation of `etcdctl` aliases on a node (see example).
 
 Dependencies
 ------------
@@ -21,7 +25,22 @@ openshift-repos
 Example Playbook
 ----------------
 
-TODO
+**Drop etcdctl aliases**
+
+```yaml
+- include_role:
+    name: etcd_common
+    tasks_from: etcdctl
+```
+
+**Get access to common variables**
+
+```yaml
+# meta.yml of etcd
+...
+dependencies:
+- { role: etcd_common }
+```
 
 License
 -------