Update os_image documentation (ansible#49705)

* Update os_image.py docs to show auth details (cherry picked from commit f5326aa)
acozine · May 10, 2019 · 86a9309 · 86a9309
1 parent ec740ea
commit 86a9309
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/lib/ansible/modules/cloud/openstack/os_image.py b/lib/ansible/modules/cloud/openstack/os_image.py
@@ -91,6 +91,8 @@
       username: admin
       password: passme
       project_name: admin
+      os_user_domain_name: Default
+      os_project_domain_name: Default
     name: cirros
     container_format: bare
     disk_format: qcow2

diff --git a/lib/ansible/plugins/doc_fragments/openstack.py b/lib/ansible/plugins/doc_fragments/openstack.py
@@ -24,7 +24,8 @@ class ModuleDocFragment(object):
       - Dictionary containing auth information as needed by the cloud's auth
         plugin strategy. For the default I(password) plugin, this would contain
         I(auth_url), I(username), I(password), I(project_name) and any
-        information about domains if the cloud supports them. For other plugins,
+        information about domains (for example, I(os_user_domain_name) or I(os_project_domain_name)) if the cloud supports them.
+        For other plugins,
         this param will need to contain whatever parameters that auth plugin
         requires. This parameter is not needed if a named cloud is provided or
         OpenStack OS_* environment variables are present.