1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

724 commits

Author SHA1 Message Date
Dag Wieers
5fe8205d36 vsphere_facts: Various cleanups in documentation
This commit improves the following items:
 - Clean up all C() calls in documentation
 - Reindent the documentation
2012-10-12 19:46:20 +02:00
Dag Wieers
5612cce4a4 hpilo_facts: Various clean ups in documentation and code
This commit improves the following items:
 - Remove the 'match' functionality, this can now be achieve by using the `fail` module together with `only_if` after running the `hpilo_facts` module. Since this gives more functionality, e.g. comparing server names, but also serial numbers or uuids with other inventory information **and** a proper message, this is prefered. An example is added to show how this is achieved.
 - Clean up all C() calls in documentation
 - Remove trailing spaces in HP iLO's Serial Number output so that they can be compared to CMDB or other inventory information
2012-10-12 19:38:59 +02:00
Michael DeHaan
dfaef8061a Merge pull request #1289 from abondis/mysql_migration
mysql_db: connection test, dump/import state
2012-10-11 17:39:13 -07:00
Dag Wieers
dfdf4ab8eb Damn you, colons... 2012-10-11 09:26:21 +02:00
Aurélien Bondis
1a51af0e38 mysql_db: use the database to test connexion, added dump and import state - requires target=path/to/a/file 2012-10-10 23:28:42 -04:00
Michael DeHaan
e74b9e1d34 Add .gitdir 2012-10-10 20:00:15 -04:00
Michael DeHaan
e593c828b4 Merge remote branch 'dagwieers/module-mail' into devel 2012-10-10 19:46:38 -04:00
Michael DeHaan
7788dea238 Merge pull request #1268 from dagwieers/hpilo-reboot-fix
Workaround for when HP iLO is in a state it won't accept requests
2012-10-10 05:34:22 -07:00
Michael DeHaan
f1dfddc5e5 Fix typo in autogenerated docs 2012-10-10 08:32:41 -04:00
Dag Wieers
2f74cd84bd Module mail to send out emails as an action
Sending mails could be part of the workflow to have teams/responsibles perform specific task. Or simply to notify that a process has finished successfully (e.g. provisioning).
2012-10-09 19:36:23 +02:00
Dag Wieers
790ed81b14 Workaround for when HP iLO is in a state it won't accept requests
This workaround is recommended from HP iLO's documentation, but may not be sufficient in all cases. Time will tell.

I also made a few cosmetic changes with no impact.
2012-10-09 19:31:31 +02:00
Michael DeHaan
06688efb24 Merge pull request #1263 from dagwieers/hpilo_facts-fix
Sigh, another retypo
2012-10-09 05:22:49 -07:00
Dag Wieers
98624cb394 Fixes to documentation 2012-10-09 12:42:10 +02:00
Dag Wieers
3f149e09bc Sigh, another retypo problem 2012-10-09 12:30:00 +02:00
Michael DeHaan
612561ad0e Merge pull request #1250 from dagwieers/hpilo_boot-fixes
Various small fixes to boolean usage and defaults
2012-10-08 14:27:20 -07:00
Michael DeHaan
62a56a219b Merge pull request #1243 from dsummersl/squash2-cron
cron feature (w/o tests)
2012-10-08 14:25:55 -07:00
Michael DeHaan
1b36446ab3 Merge pull request #1255 from dagwieers/module-namespace
Add this module's namespace to the 'module_' namespace.
2012-10-08 14:25:20 -07:00
Tim Bielawa
1e35ac7603 Fix typo in service module docs 2012-10-08 12:46:16 -04:00
Dane Summers
c3a6e8dfd6 added new documentation string to cron library 2012-10-08 11:10:40 -04:00
Dag Wieers
b39aed8736 Add this module's namespace to the 'module_' namespace.
Much like we currently have *setup* register the variable `module_setup`, we would like other facts-modules register their own namespace. This means that:

 - *network_facts* registers `module_network`
 - *hpilo_facts* registers `module_hw`
 - *vsphere_facts* registers `module_hw`

In retrospect, it would have made more sense to have `setup` register `module_ansible` instead as the setup module uses the `ansible_` namesepace.

Having the `module_` namespace allows us to check whether a certain namespace has already been loaded so we can avoid running the facts module a second time using only_if.

```yaml
 - action: network_facts host=${ansible_hostname_short}
   only_if: is_unset('$module_network')
```
2012-10-08 15:13:17 +02:00
Dag Wieers
5503cfaa44 Various small fixes to boolean usage, using module.params.get and default values 2012-10-08 15:07:02 +02:00
Michael DeHaan
c8854a23ea Merge pull request #1251 from dagwieers/hpilo_facts-fixes
Fix typo/cosmetic change
2012-10-07 16:58:05 -07:00
Dag Wieers
250f52bfba Add an alias 'name=' for guest
This is the opposite as library/virt, but much better than using name= as the default option name.
2012-10-07 22:23:22 +02:00
Dag Wieers
8c5a146013 Fix typo/cosmetic change 2012-10-07 22:12:00 +02:00
Michael DeHaan
c5d7ef3d7f Merge pull request #1249 from dagwieers/module-hpilo_boot
Module hpilo_boot to boot from specific media using an HP iLO interface
2012-10-07 06:12:42 -07:00
Dag Wieers
b58228a73b Module hpilo_boot to boot from specific media using an HP iLO interface
This module allows to boot a system through HP iLO and can be used to start the provisioning process.
2012-10-06 23:56:50 +02:00
Michael DeHaan
323cbdafb7 Merge pull request #1240 from jpmens/hpdoc
fix examples in hpilo_facts DOCUMENTATION
2012-10-06 13:39:31 -07:00
Dane Summers
3d65d6159f cron feature (w/o tests) 2012-10-05 21:35:37 -04:00
Michael DeHaan
a1c23af6fc Merge pull request #1239 from jpmens/shelldoc
fix wording of shell documentation
2012-10-05 06:11:31 -07:00
Jan-Piet Mens
91dc8bc136 fix examples in hpilo_facts DOCUMENTATION 2012-10-05 15:07:45 +02:00
Jan-Piet Mens
70907f574e fix wording of shell documentation 2012-10-05 14:59:49 +02:00
Dag Wieers
70b063ce0e Use the standard 'dest' option for target files, make 'name' an alias 2012-10-05 11:03:14 +02:00
Michael DeHaan
f470ebe6b7 Merge pull request #1213 from dagwieers/debug-module
Module debug to assist users in understanding Ansible
2012-10-04 16:28:25 -07:00
Michael DeHaan
a95bff0f5f Merge pull request #1230 from dagwieers/module-vsphere_facts
Module vsphere_facts to add facts from a VMWare vSphere guest
2012-10-04 16:18:39 -07:00
Michael DeHaan
5d7ab8a300 Merge pull request #1231 from dagwieers/fail-doc-fix
This hopefully fixes the documentation for the fail module
2012-10-04 16:18:10 -07:00
Dag Wieers
8c8552ac32 Module vsphere_facts to add facts from a VMWare vSphere guest
This module gathers facts from a VMWare vSphere guest by querying vSphere. The facts include OS, network info (vlan, macaddress) and system info (cpu, memory, uuid) information. Useful information for provisioning and management.
2012-10-04 21:55:16 +02:00
Dag Wieers
e07674d756 Module hpilo_facts to add facts from HP iLO interfaces
This module gathers facts from the hardware interface by querying HP iLO. The facts include network info (vlan, macaddress) and system info (cpu, memory, uuid) information. Useful information for provisioning and management.

This module was previously named ilo_facts and mentioned in #1080, #1085, #1125 and #1217.
2012-10-04 21:50:34 +02:00
Dag Wieers
3d5c4df2ac This hopefully fixes the documentation for the fail module 2012-10-04 20:58:07 +02:00
Dag Wieers
03af450bdc 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.
2012-10-04 09:50:18 +02:00
Michael DeHaan
e170d7304b Added documentation on file force parameter 2012-10-03 20:57:36 -04:00
Michael DeHaan
046c6c66f2 various small doc tweaks 2012-10-02 22:43:46 -04:00
Michael DeHaan
f67aa85c3f Fixing various module related things. 2012-10-02 22:32:17 -04:00
Michael DeHaan
85a31616de Call os.path.expanduser in the creates= and removes= section of the command module so ~/ and the like works. 2012-10-02 22:12:49 -04:00
Dag Wieers
1d27909ec0 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.
2012-10-02 21:40:28 +02:00
Petetin Ludovic
17423c9268 Fix issue https://github.com/ansible/ansible/issues/1194 2012-10-02 15:12:33 +02:00
Michael DeHaan
6616fba1ab Merge pull request #1189 from jpmens/nagpause
standardize DOCUMENTATION for nagios, pause
2012-10-02 05:15:56 -07:00
Jan-Piet Mens
a1f192976f attempt at DOCUMENTATION for async_status 2012-10-02 09:56:55 +02:00
Jan-Piet Mens
83029755f7 standardize DOCUMENTATION for nagios, pause 2012-10-02 09:15:11 +02:00
Michael DeHaan
f897f19fc5 Teach fireball mode to disable the fireball by paying attention to 'minutes=N' (default 30) and do not let fireball module crash
on input.
2012-10-01 22:41:00 -04:00
Michael DeHaan
2165351f2c Merge pull request #1185 from tbielawa/pause_docs
Add DOCUMENTATION to pause task
2012-10-01 19:09:24 -07:00
Tim Bielawa
ca87fa56d8 Add DOCUMENTATION to pause task 2012-10-01 12:42:03 -04:00
Tim Bielawa
f3d9f8da7b Add DOCUMENTATION to nagios module. 2012-10-01 12:26:57 -04:00
Michael DeHaan
886a17853f Merge pull request #1176 from jpmens/fireball-doc1
fireball DOCUMENTATION
2012-10-01 05:46:02 -07:00
Jan-Piet Mens
f2dc815e3f fireball DOCUMENTATION
- amended
2012-10-01 14:39:15 +02:00
Michael DeHaan
6600f7b7ac Merge pull request #1170 from jpmens/docspatch01
Jumbo DOCUMENTATION patch
2012-10-01 05:19:16 -07:00
Michael DeHaan
ac3ec0a410 Merge pull request #1173 from dhozac/command-quote-less
Use a regexp to filter out arguments instead
2012-10-01 05:17:29 -07:00
Jan-Piet Mens
a72a6e42c5 Added attribution to all module DOCUMENTATION strings 2012-10-01 12:37:51 +02:00
Daniel Hokka Zakrisson
6477bdc6fc 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.
2012-10-01 12:13:17 +02:00
Jan-Piet Mens
e620fed755 Jumbo DOCUMENTATION patch 2012-10-01 09:18:54 +02:00
Michael DeHaan
190e4c26d1 Merge pull request #1167 from jpmens/slurp01
module docs for slurp
2012-09-30 08:15:19 -07:00
Jan-Piet Mens
8b737c959d module docs for slurp 2012-09-30 16:58:15 +02:00
Michael DeHaan
a00d6d7234 Merge pull request #1166 from mavimo/documentation-seboolean
Added DOCUMENTATION to seboolean module.
2012-09-30 06:44:02 -07:00
Marco Vito Moscaritolo
f9bdf07387 Added DOCUMENTATION to seboolean module. 2012-09-30 15:41:00 +02:00
Michael DeHaan
f8060d109e Merge pull request #1165 from mavimo/documentation-selinux
Added DOCUMENTATION to selinux module.
2012-09-30 06:36:27 -07:00
Michael DeHaan
349af83c91 Merge pull request #1164 from jpmens/modformatter
module_formatter now also uses Jinja2 trim_blocks
2012-09-30 06:36:09 -07:00
Marco Vito Moscaritolo
7491054ed6 Added DOCUMENTATION to selinux module. 2012-09-30 15:34:26 +02:00
Jan-Piet Mens
e4338d0ca3 module_formatter now also uses Jinja2 trim_blocks
- Updated man template accordingly
- seem to have left in illegal char in facter DOCUMENTATION...
2012-09-30 15:06:18 +02:00
Jan-Piet Mens
8a4df98f69 template DOCUMENTATION added to fireball 2012-09-30 14:50:32 +02:00
Jan-Piet Mens
28698d5fcf Attribute author of virt correctly (sorry) 2012-09-30 14:08:47 +02:00
Michael DeHaan
b8a2a526fc Merge pull request #1156 from jpmens/m-docs5
DOCUMENTATION for virt
2012-09-30 04:59:24 -07:00
Michael DeHaan
39c4a4f8a7 Merge pull request #1155 from jpmens/m-docs4
DOCUMENTATION for fetch,mount,ohai,easy_install; .rst template tweaks
2012-09-30 04:57:50 -07:00
Michael DeHaan
bf6e783d7a Merge pull request #1152 from sfromm/moduledocs
Add module documentation for git, group, service, and user
2012-09-30 04:56:37 -07:00
Jan-Piet Mens
7a3b2ac287 DOCUMENTATION for virt 2012-09-30 12:40:11 +02:00
Jan-Piet Mens
754888d896 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
2012-09-30 12:29:32 +02:00
Stephen Fromm
ed07940386 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.
2012-09-29 23:58:04 -07:00
Stephen Fromm
be19e21126 Add module documentation for git, group, service, and user 2012-09-29 23:50:25 -07:00
Michael DeHaan
13e8ef5f35 Merge pull request #1146 from dhozac/command-escape-args
Properly parse escaped special arguments
2012-09-29 16:25:37 -07:00
Michael DeHaan
e744e864d9 Merge pull request #1140 from mavimo/devel
Refs #1116: DOCUMENTATION string update
2012-09-29 13:26:42 -07:00
Michael DeHaan
78911f1b26 Merge pull request #1145 from mavimo/documentation-supervisorctl
Added DOCUMENTATION to supervisorctl module.
2012-09-29 13:23:54 -07:00
Michael DeHaan
4823371aff Merge pull request #1144 from mavimo/documentation-pip
Added DOCUMENTATION to pip module.
2012-09-29 13:23:41 -07:00
Daniel Hokka Zakrisson
9261d3962b Properly parse escaped special arguments
Fixes issue #1134
2012-09-29 21:05:49 +02:00
Marco Vito Moscaritolo
d80ec35183 Fixed error in author name 2012-09-29 21:04:17 +02:00
Marco Vito Moscaritolo
95d7b4c5db Added DOCUMENTATION to supervisorctl module. 2012-09-29 21:02:07 +02:00
Marco Vito Moscaritolo
ac5afcae28 Added DOCUMENTATION to pip module. 2012-09-29 20:53:28 +02:00
Marco Vito Moscaritolo
b1d88235f0 Added DOCUMENTATION to shell module. 2012-09-29 20:40:06 +02:00
Marco Vito Moscaritolo
e1c83b0367 Fixed error on official docs (reported on DOCUMENTATION string). Name param must be pkg and is required. 2012-09-29 18:23:13 +02:00
Marco Vito Moscaritolo
e30e9a74c2 Added DOCUMENTATION to postgresql_user module. 2012-09-29 16:46:30 +02:00
Marco Vito Moscaritolo
a4620920b2 Added DOCUMENTATION to postgresql_db module. 2012-09-29 16:46:13 +02:00
Marco Vito Moscaritolo
6184a0a313 Fixed doc string 2012-09-29 16:43:21 +02:00
Marco Vito Moscaritolo
0d0bc5e620 Added DOCUMENTATION to subversion module. 2012-09-29 16:28:55 +02:00
Marco Vito Moscaritolo
29ffed869c Added ping module author in docs. 2012-09-29 16:23:58 +02:00
Marco Vito Moscaritolo
2aaaf986d3 Added DOCUMENTATION to ping module. 2012-09-29 16:21:00 +02:00
Marco Vito Moscaritolo
a75348b406 Added DOCUMENTATION to musql_db module. 2012-09-29 16:15:52 +02:00
Marco Vito Moscaritolo
8898643c1d Added DOCUMENTATION to musql_user module. 2012-09-29 16:15:41 +02:00
Jan-Piet Mens
0604d580d9 Removed embedded colon in DOCUMENTATION of apt_repository: building manpages failed 2012-09-29 12:53:17 +02:00
Michael DeHaan
e108d1758c Merge pull request #1132 from jpmens/m-doc-inifile
removed EXAMPLES from ini_file
2012-09-28 17:59:30 -07:00
Jan-Piet Mens
1193810d46 module DOCUMANTATION for apt, apt_respository cleanup 2012-09-29 01:51:55 +02:00
Jan-Piet Mens
0649e637d3 removed EXAMPLES from ini_file
testing YAML in YAML: small glitch in rst template; a </pre></p> is outdented and causes messy display
2012-09-29 01:26:40 +02:00
Michael DeHaan
ce5dceab0e Merge pull request #1128 from mavimo/devel
Added documentation to APT module
2012-09-28 16:12:58 -07:00
Michael DeHaan
508e6ecf43 Merge pull request #1131 from jpmens/m-docs3
Module DOCUMENTATION for template, wait_for, and yum
2012-09-28 16:11:33 -07:00