aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBartłomiej Piotrowski <b@bpiotrowski.pl>2013-06-06 15:26:58 +0200
committerBartłomiej Piotrowski <b@bpiotrowski.pl>2013-06-06 15:26:58 +0200
commitc744f494cb89a8203103de7c5f9358541f52f05e (patch)
treecfb8b191e173767a8e6c31c1589c5c578d44c7b8
parenteaf620d6d8550194e7f0fdabd5f97c41a1cf51a7 (diff)
downloadansible-apk-c744f494cb89a8203103de7c5f9358541f52f05e.tar.bz2
ansible-apk-c744f494cb89a8203103de7c5f9358541f52f05e.tar.xz
Add README.HEADv1master
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b2fa45b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# apk-tools module for Ansible
+
+A simple module to make use of apk-tools under Ansible. It's very possible it can be written cleaner — patches welcome (also on [Github](https://github.com/Barthalion/ansible-apk).
+
+## Installation
+Copy `apk` to `$ANSIBLE_LIBRARY` on the management host.
+ install -m444 library/apk $ANSIBLE_LIBRARY/apk
+
+## Examples
+ - name: Install package foo
+ action: apk pkg=foo state=present
+Note that default value of `state` is `present`, therefore it doesn't have to be explicitly defined.
+
+ - name: Update the package database and upgrade package bar
+ action: apk pkg=bar update=yes state=latest
+
+ - name: Remove package foo and purge its configuration files
+ action: apk pkg=foo state=purge
+
+ - name: Force removal of package bar
+ action: apk pkg=bar force=yes
+
+## To-do
+* return more verbose messages
+* add support for `upgrade`, `verify` and `fix`