ansible-modules: update

ansible-modules.md

@@ -8,100 +8,226 @@ updated: 2017-10-03
 
 {% raw %}
 
+## Format
+
+### Basic file
+
+```yaml
+---
+- hosts: production
+  remote_user: root
+  tasks:
+  - ···
+```
+
+Place your modules inside `tasks`.
+
+### Task formats
+
+#### One-line
+
+```yaml
+- apt: pkg=vim state=present
+```
+
+#### Map
+
+```yaml
+- apt:
+    pkg: vim
+    state: present
+```
+
+#### Foldable scalar
+
+```yaml
+- apt: >
+    pkg=vim
+    state=present
+```
+
+Define your tasks in any of these formats. One-line format is preferred for short declarations, while maps are preferred for longer.
+
+## Modules
+
 ### Aptitude
 
 #### Packages
 
 ```yaml
-- apt: pkg=nodejs state=present
+- apt:
-    state=present # absent | latest
+    pkg: nodejs
-    update_cache=yes
+    state: present # absent | latest
-    force=no
+    update_cache: yes
+    force: no
 ```
 
 #### Deb files
 
 ```yaml
-- apt: deb=https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb
+- apt:
+    deb: "https://packages.erlang-solutions.com/erlang-solutions_1.0_all.deb"
 ```
 
 #### Repositories
 
 ```yaml
-- apt_repository: repo='deb https://... raring main'
+- apt_repository:
-    state=present
+    repo: "deb https://··· raring main"
+    state: present
 ```
 
 #### Repository keys
 
 ```yaml
-- apt_key: id=AC40B2F7 url="http://..."
+- apt_key:
-    state=present
+    id: AC40B2F7
-```
+    url: "http://···"
-
+    state: present
-### file
-
-#### File
-
-```yaml
-- file:
-    state=directory # file | link | hard | touch | absent
-    path=/etc/dir
-    owner=bin
-    group=wheel
-    mode=0644
-    recurse=yes  # mkdir -p
-    force=yes    # ln -nfs
-```
-
-#### Copy
-
-```yaml
-- copy:
-    src=/app/config/nginx.conf
-    dest=/etc/nginx/nginx.conf
-```
-
-#### Templates
-
-```yaml
-- template:
-    src=config/redis.j2
-    dest=/etc/redis.conf
 ```
 
 ### git
 
 ```yaml
-- git: repo=git://github.com/
+- git:
-    dest=/srv/checkout
+    repo: git://github.com/
-    version=master
+    dest: /srv/checkout
-    depth=10
+    version: master
-    bare=yes
+    depth: 10
+    bare: yes
 ```
 
-### user
+See: [git module](http://devdocs.io/ansible/git_module)
+
+### git_config
+
 ```yaml
-- user: state=present name=git
+- git_config:
-    system=yes
+    name: user.email
-    shell=/bin/sh
+    scope: global # local | system
-    groups=admin
+    value: hi@example.com
-    comment="Git Version Control"
 ```
 
+See: [git_config module](http://devdocs.io/ansible/git_config_module)
+
+### user
+
+```yaml
+- user:
+    state: present
+    name: git
+    system: yes
+    shell: /bin/sh
+    groups: admin
+    comment: "Git Version Control"
+```
+
+See: [user module](http://devdocs.io/ansible/user_module)
+
 ### service
 
 ```yaml
-- service: name=nginx state=started [enabled=yes]
+- service:
+    name: nginx
+    state: started
+    enabled: yes     # optional
 ```
 
+See: [service module](http://devdocs.io/ansible/service_module)
+
+## Shell
+
 ### shell
 
 ```yaml
 - shell: apt-get install nginx -y
-- script: /x/y/script.sh
 ```
 
+#### Extra options
+
+```yaml
+- shell: echo hello
+  args:
+    creates: /path/file  # skip if this exists
+    removes: /path/file  # skip if this is missing
+    chdir: /path         # cd here before running
+```
+
+#### Multiline example
+
+```yaml
+- shell: |
+    echo "hello there"
+    echo "multiple lines"
+```
+
+See: [shell module](http://devdocs.io/ansible/shell_module)
+
+### script
+
+```yaml
+- script: /x/y/script.sh
+  args:
+    creates: /path/file  # skip if this exists
+    removes: /path/file  # skip if this is missing
+    chdir: /path         # cd here before running
+```
+
+See: [script module](http://devdocs.io/ansible/script_module)
+
+## Files
+
+### file
+
+```yaml
+- file:
+    path: /etc/dir
+    state: directory # file | link | hard | touch | absent
+
+    # Optional:
+    owner: bin
+    group: wheel
+    mode: 0644
+    recurse: yes  # mkdir -p
+    force: yes    # ln -nfs
+```
+
+See: [file module](http://devdocs.io/ansible/file_module)
+
+### copy
+
+```yaml
+- copy:
+    src: /app/config/nginx.conf
+    dest: /etc/nginx/nginx.conf
+
+    # Optional:
+    owner: user
+    group: user
+    mode: 0644
+    backup: yes
+```
+
+See: [copy module](http://devdocs.io/ansible/copy_module)
+
+### template
+
+```yaml
+- template:
+    src: config/redis.j2
+    dest: /etc/redis.conf
+
+    # Optional:
+    owner: user
+    group: user
+    mode: 0644
+    backup: yes
+```
+
+See: [template module](http://devdocs.io/ansible/template_module)
+
+## Local actions
+
 ### local_action
 
 ```yaml
@@ -116,4 +242,6 @@ updated: 2017-10-03
     msg: "Hello {{ var }}"
 ```
 
+See: [debug module](http://devdocs.io/ansible/debug_module)
 {% endraw %}
+