cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add checklist item on how to use env vars with basic auth helpers

Browse source
This commit is contained in:
Toshio Kuratomi 2016-08-31 09:33:33 -07:00
parent 71ef25d5e8
commit 33245b2011
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docsite/rst/developing_modules.rst
View file

@ -729,6 +729,12 @@ The following checklist items are important guidelines for people who want to c
playbooks which conditionalize based on fact information will only playbooks which conditionalize based on fact information will only
conditionalize correctly in check_mode if the facts are returned in conditionalize correctly in check_mode if the facts are returned in
check_mode). check_mode).
* Basic auth: module_utils.api has some helpers for doing basic auth with
module_utils.urls.fetch_url(). If you use those you may find you also want
to fallback on environment variables for default values. If you do that,
be sure to use non-generic environment variables (like
:envvar:`API_<MODULENAME>_USERNAME`). Using generic environment variables
like :envvar:`API_USERNAME` would conflict between modules.
Windows modules checklist Windows modules checklist
````````````````````````` `````````````````````````