diff --git a/README.md b/README.md index a527df2..295d992 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,16 @@ Ansible orcherstration for Openwrt - with Lua! Ansible is build around a collection of modules that get send to the remote host to execute different tasks or collect information. Those modules are -implemented in python. However on embedded systems such as routers, resources, +implemented in python. However, on embedded systems such as routers, resources, in particular flash memory are scarce and a python runtime often not available. -Those modules communicate with the ansible-toolsuite via well defined interfaces +Those modules communicate with the ansible-toolsuite via well-defined interfaces and are executed via ssh. As each module is a standalone program, there is no dependency whatsoever on the implementation language. There are existing attempts like [this](https://github.com/lefant/ansible-openwrt) which already implement a small set of modules as bash-scripts. -However the primary author of this project disagrees with some of the +However, the primary author of this project disagrees with some of the implementation decisions (e.g. sourcing files with key=value-pairs as a kind of parsing) and is generally a fan of (even rather limited in luas case) typing. So this project was born. @@ -53,7 +53,7 @@ following opkg packages are required, which are not part of the standard images: - luaposix - coreutils-sha1sum -However, as the opkg-module is independent from those packages, you can install +However, as the opkg-module is independent of those packages, you can install them in your playbook like this: ```yaml @@ -66,7 +66,7 @@ them in your playbook like this: Ansible currently has no notion of libraries used within modules (only limited support for ansibles own core python libraries is available). For more information please see -[this issue](https://github.com/ansible/ansible/pull/10274). Therefore all +[this issue](https://github.com/ansible/ansible/pull/10274). Therefore, all modules that should be used have to be fatpacked (that is, the module all referenced libraries have to be packed into one giant lua script). This is done by the [fatpack.pl](./src/fatpack.pl) script. Usage is like this: @@ -87,7 +87,7 @@ beforehand against a VM (e.g. the one from the openwrt-vagrant project which can be built from the submodule in `./test/`) or be sure that your router has a convenient reset/failsafe path. -Apart form the `./library/` folder, you might want to copy the provided `ansible.cfg` as it configures ansible for better interoperability with the dropbear ssh-daemon used by openwrt. +Apart from the `./library/` folder, you might want to copy the provided `ansible.cfg` as it configures ansible for better interoperability with the dropbear ssh-daemon used by openwrt. # Documentation @@ -185,7 +185,7 @@ input. If you need to force a singleentry list, please be sure to set the | state | no | present | present, absent, set, unset | State of the property | | op | no | | configs, commit, revert, get| If specified, instead of enforcing a value, either list the available configurations, execute a commit/revert operation, or query properties. | | reload | no | | Boolean | Whether to reload the configuration from disk before executing. _Aliases: reload_configs, reload-configs_ | -| autocomit | no | true | Boolean | Whether to automatically commit the changes made | +| autocommit| no | true | Boolean | Whether to automatically commit the changes made | | type | no | | | When creating a new section, a configuration-type is required. Can also be used to qualify a get. Aliases: _section-type_ | | socket | no | | | Set a nonstandard path to the ubus socket if necessary | | timeout | no | | | Change the default ubus timeout |