Commit Graph

1050 Commits (018f756c9d057ba048923a7f597af896500a5345)
 

Author SHA1 Message Date
Dag Wieers b64821d543 Module to assist users in understanding Ansible
After helping someone on IRC he was interested to have this debug module in upstream. This module simply 'prints' a message, and can be ordered to fail if needed. It helps to troubleshoot or understand inventory/facts issues and/or experiment with statements and conditions using only_if.

Here is a small example playbook:

```yaml
- hosts: all
  tasks:
  - local_action: debug msg="System $inventory_hostname has uuid ${ansible_product_uuid}"
  - local_action: debug msg="System $inventory_hostname lacks a gateway" fail=yes
    only_if: "is_unset('$ansible_default_ipv4.gateway')"
  - local_action: debug msg="System $inventory_hostname has gateway ${ansible_default_ipv4.gateway}"
    only_if: "is_set('$ansible_default_ipv4.gateway')"
```

outputting:
```
[root@moria ansible]# ansible-playbook -v -l localhost:x220 test6.yml

PLAY [all] *********************

GATHERING FACTS *********************
ok: [localhost]
ok: [x220]

TASK: [debug msg="System $inventory_hostname has uuid $ansible_product_uuid"] *********************
ok: [localhost] => {"msg": "System localhost has uuid d125a48c-364f-4e65-b225-fed42ed61fac"}
ok: [x220] => {"msg": "System x220 has uuid d125a48c-364f-4e65-b225-fed42ed61fac"}

TASK: [debug msg="System $inventory_hostname lacks a gateway" fail=yes] *********************
failed: [localhost] => {"failed": true, "msg": "System localhost lacks a gateway", "rc": 1}
ok: [x220] => {"msg": "System x220 has gateway 192.168.1.1"}

PLAY RECAP *********************
localhost                      : ok=2    changed=0    unreachable=0    failed=1
x220                           : ok=3    changed=0    unreachable=0    failed=0

```

I had some other plans for the module, like displaying host inventory and complete inventory to help understand inventory and facts modules, but that would require an action-plugin for transfering inventory information etc... And I am not sure this is wanted/best done in a module.
12 years ago
Michael DeHaan 1bd1e3ed1f Added documentation on file force parameter 12 years ago
Michael DeHaan d404737543 various small doc tweaks 12 years ago
Michael DeHaan 2d096ea425 Fixing various module related things. 12 years ago
Michael DeHaan f3e8ffce43 Call os.path.expanduser in the creates= and removes= section of the command module so ~/ and the like works. 12 years ago
Dag Wieers 2886084ac0 Added a fail module in order to fail execution on certain conditions
In some cases you may want to deliberately fail the execution of a playbook. In our provisioning workflow we want to have safeguards in place to avoid provisioning systems that are already in production. Since we reboot physical and virtual systems, it is mandatory we take all the precautions to prevent accidental provisioning.

So in our use-case we have the following at the very start of the provisioning playbook:

    ### Safeguard to protect production systems
    - local_action: fail msg="System is not ready to be staged according to CMDB"
      only_if: "'$cmdb_status' != 'to-be-staged'"

and we repeat the same task in the (separate included) play that takes care of (re)booting the system using our own boot-media, so that it cannot be accidentally separately run by someone.
12 years ago
Petetin Ludovic e3cb4163a9 Fix issue https://github.com/ansible/ansible/issues/1194 12 years ago
Michael DeHaan 873013363c Merge pull request #1189 from jpmens/nagpause
standardize DOCUMENTATION for nagios, pause
12 years ago
Jan-Piet Mens c01354d12d attempt at DOCUMENTATION for async_status 12 years ago
Jan-Piet Mens d27706f7c5 standardize DOCUMENTATION for nagios, pause 12 years ago
Michael DeHaan ef7811e4d4 Teach fireball mode to disable the fireball by paying attention to 'minutes=N' (default 30) and do not let fireball module crash
on input.
12 years ago
Michael DeHaan 413a03f723 Merge pull request #1185 from tbielawa/pause_docs
Add DOCUMENTATION to pause task
12 years ago
Tim Bielawa 6f7b3e9907 Add DOCUMENTATION to pause task 12 years ago
Tim Bielawa 3eff193e4c Add DOCUMENTATION to nagios module. 12 years ago
Michael DeHaan ac4d62d4dc Merge pull request #1176 from jpmens/fireball-doc1
fireball DOCUMENTATION
12 years ago
Jan-Piet Mens 8baea3d38a fireball DOCUMENTATION
- amended
12 years ago
Michael DeHaan 2f14545f2c Merge pull request #1170 from jpmens/docspatch01
Jumbo DOCUMENTATION patch
12 years ago
Michael DeHaan 0f83fefeda Merge pull request #1173 from dhozac/command-quote-less
Use a regexp to filter out arguments instead
12 years ago
Jan-Piet Mens a790c399f4 Added attribution to all module DOCUMENTATION strings 12 years ago
Daniel Hokka Zakrisson 98be6a328b Use a regexp to filter out arguments instead
pipes.quote is a bit overzealous for what we want to do, quoting ;
and other characters that you most likely want to use in your shell
invocations. The regexp is the best I could come up with to be able
to only replace the parts of the arguments that shouldn't be
executed.
12 years ago
Jan-Piet Mens c78a0a4a49 Jumbo DOCUMENTATION patch 12 years ago
Michael DeHaan d7ee918419 Merge pull request #1167 from jpmens/slurp01
module docs for slurp
12 years ago
Jan-Piet Mens a722e4fc79 module docs for slurp 12 years ago
Michael DeHaan 85b98abe33 Merge pull request #1166 from mavimo/documentation-seboolean
Added DOCUMENTATION to seboolean module.
12 years ago
Marco Vito Moscaritolo 054f99b10d Added DOCUMENTATION to seboolean module. 12 years ago
Michael DeHaan 20da86d1fd Merge pull request #1165 from mavimo/documentation-selinux
Added DOCUMENTATION to selinux module.
12 years ago
Michael DeHaan 51dbc211a0 Merge pull request #1164 from jpmens/modformatter
module_formatter now also uses Jinja2 trim_blocks
12 years ago
Marco Vito Moscaritolo 6cf1c78335 Added DOCUMENTATION to selinux module. 12 years ago
Jan-Piet Mens 4c57b1672e module_formatter now also uses Jinja2 trim_blocks
- Updated man template accordingly
- seem to have left in illegal char in facter DOCUMENTATION...
12 years ago
Jan-Piet Mens a804eb8866 template DOCUMENTATION added to fireball 12 years ago
Jan-Piet Mens 4a4979314f Attribute author of virt correctly (sorry) 12 years ago
Michael DeHaan 5b8e8ca395 Merge pull request #1156 from jpmens/m-docs5
DOCUMENTATION for virt
12 years ago
Michael DeHaan 4b911a237c Merge pull request #1155 from jpmens/m-docs4
DOCUMENTATION for fetch,mount,ohai,easy_install; .rst template tweaks
12 years ago
Michael DeHaan b7571f56c2 Merge pull request #1152 from sfromm/moduledocs
Add module documentation for git, group, service, and user
12 years ago
Jan-Piet Mens a692b4bba2 DOCUMENTATION for virt 12 years ago
Jan-Piet Mens eef198144f DOCUMENTATION for fetch,mount,ohai,easy_install
- .rst now supresses default if none is set (looks better in HTML)
  - .rst now handles empty options list
  - Fixed postgresql_user and mysql_user because YAML contained colons
  - docs for facter
12 years ago
Stephen Fromm c0d2d76fe9 Add LSB facts, as derived from lsb_release -a
This gathers LSB facts via lsb_release.  This complements the
platform facts collected via the platform module.  This reoprts
release, id, description, release, and codename.  It also adds
'major_release', which is the major version number of a distribution.
12 years ago
Stephen Fromm f5d39b8677 Add module documentation for git, group, service, and user 12 years ago
Michael DeHaan b28ee354ca Merge pull request #1146 from dhozac/command-escape-args
Properly parse escaped special arguments
12 years ago
Michael DeHaan 59ace14dbc Merge pull request #1140 from mavimo/devel
Refs #1116: DOCUMENTATION string update
12 years ago
Michael DeHaan 34bb2a3abe Merge pull request #1145 from mavimo/documentation-supervisorctl
Added DOCUMENTATION to supervisorctl module.
12 years ago
Michael DeHaan 2e98c34686 Merge pull request #1144 from mavimo/documentation-pip
Added DOCUMENTATION to pip module.
12 years ago
Daniel Hokka Zakrisson 10d31fa872 Properly parse escaped special arguments
Fixes issue #1134
12 years ago
Marco Vito Moscaritolo 1637a05846 Fixed error in author name 12 years ago
Marco Vito Moscaritolo 35f6d71057 Added DOCUMENTATION to supervisorctl module. 12 years ago
Marco Vito Moscaritolo f47530b044 Added DOCUMENTATION to pip module. 12 years ago
Marco Vito Moscaritolo 549bf4f07a Added DOCUMENTATION to shell module. 12 years ago
Marco Vito Moscaritolo ea7f457c46 Fixed error on official docs (reported on DOCUMENTATION string). Name param must be pkg and is required. 12 years ago
Marco Vito Moscaritolo babb2454c6 Added DOCUMENTATION to postgresql_user module. 12 years ago
Marco Vito Moscaritolo 0a263aea56 Added DOCUMENTATION to postgresql_db module. 12 years ago