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

Merge pull request #17128 from bcoca/DONT

Browse source 
Thanks @bcoca; will merge and do some minor wordsmithing.
This commit is contained in:
scottb 2016-08-19 11:14:40 -07:00 committed by GitHub
commit 495589230b
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docsite/rst/developing_modules.rst
View file

@ -355,6 +355,13 @@ how the command module is implemented.
If a module returns stderr or otherwise fails to produce valid JSON, the actual output
will still be shown in Ansible, but the command will not succeed.
Don't write to files directly, use a temporary file and then use the `atomic_move` function from `ansibile.module_utils.basic` to move into place.
This prevents data corruption and ensures keeping the correct context for the file.
Avoid createng a module that does the work of other modules, this is what Plays and Roles are for, modules should be the building blocks. This leads to code duplication and divergence, making things less uniform, unpredictable and harder to maintain.
Avoid creating 'caches', Ansible is designed w/o a central server or authority, you cannot guarantee it will not run with different permissions, options or locations. If you need a central authority, have it on top of Ansible (bastion/cm/ci server, tower, etc), do not try to build it into modules.
Always use the hacking/test-module script when developing modules and it will warn
you about these kind of things.