From 33245b20117c73eef53baa383fffc0e0bd71328e Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Wed, 31 Aug 2016 09:33:33 -0700 Subject: [PATCH] Add checklist item on how to use env vars with basic auth helpers --- docsite/rst/developing_modules.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docsite/rst/developing_modules.rst b/docsite/rst/developing_modules.rst index d7a5ba7ecb..aa801c7168 100644 --- a/docsite/rst/developing_modules.rst +++ b/docsite/rst/developing_modules.rst @@ -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 conditionalize correctly in check_mode if the facts are returned in 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__USERNAME`). Using generic environment variables + like :envvar:`API_USERNAME` would conflict between modules. Windows modules checklist `````````````````````````