Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

dont do it #17128

Merged
merged 2 commits into from
Aug 19, 2016
Merged

dont do it #17128

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b581780
dont do it
bcoca Aug 17, 2016
dac5af6
corrected typo, expanded server types
bcoca Aug 17, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions docsite/rst/developing_modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down