Use namespaced doc fragment, cleanup

doc fragment will now be at awx.awx.auth changed from just tower, which source from core remove Makefile things no longer needed
2026-03-16 16:37:30 -02:30 · 2019-09-18 08:43:36 -04:00
parent 75bb7aae14
commit 7dd8e35e8c
27 changed files with 88 additions and 29 deletions
--- a/awx_collection/plugins/doc_fragments/auth.py
+++ b/awx_collection/plugins/doc_fragments/auth.py
@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2017, Wayne Witzel III <wayne@riotousliving.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+
+class ModuleDocFragment(object):
+
+    # Ansible Tower documentation fragment
+    DOCUMENTATION = r'''
+options:
+  tower_host:
+    description:
+    - URL to your Tower or AWX instance.
+    type: str
+  tower_username:
+    description:
+    - Username for your Tower or AWX instance.
+    type: str
+  tower_password:
+    description:
+    - Password for your Tower or AWX instance.
+    type: str
+  validate_certs:
+    description:
+    - Whether to allow insecure connections to Tower or AWX.
+    - If C(no), SSL certificates will not be validated.
+    - This should only be used on personally controlled sites using self-signed certificates.
+    type: bool
+    aliases: [ tower_verify_ssl ]
+  tower_config_file:
+    description:
+    - Path to the Tower or AWX config file.
+    type: path
+
+requirements:
+- ansible-tower-cli >= 3.0.2
+
+notes:
+- If no I(config_file) is provided we will attempt to use the tower-cli library
+  defaults to find your Tower host information.
+- I(config_file) should contain Tower configuration in the following format
+    host=hostname
+    username=username
+    password=password
+'''
--- a/awx_collection/plugins/modules/tower_credential.py
+++ b/awx_collection/plugins/modules/tower_credential.py
@@ -145,7 +145,7 @@ options:
      choices: ["present", "absent"]
      default: "present"
      type: str
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_credential_type.py
+++ b/awx_collection/plugins/modules/tower_credential_type.py
@@ -64,7 +64,7 @@ options:
      required: False
      type: bool
      aliases: [ tower_verify_ssl ]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_group.py
+++ b/awx_collection/plugins/modules/tower_group.py
@@ -77,7 +77,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_host.py
+++ b/awx_collection/plugins/modules/tower_host.py
@@ -47,7 +47,7 @@ options:
        - Desired state of the resource.
      choices: ["present", "absent"]
      default: "present"
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_inventory.py
+++ b/awx_collection/plugins/modules/tower_inventory.py
@@ -52,7 +52,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_inventory_source.py
+++ b/awx_collection/plugins/modules/tower_inventory_source.py
@@ -143,7 +143,7 @@ options:
        - Tower option to avoid certificates check.
      type: bool
      aliases: [ tower_verify_ssl ]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_job_cancel.py
+++ b/awx_collection/plugins/modules/tower_job_cancel.py
@@ -32,7 +32,7 @@ options:
        - Fail loudly if the I(job_id) does not reference a running job.
      default: False
      type: bool
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''

 EXAMPLES = '''
--- a/awx_collection/plugins/modules/tower_job_launch.py
+++ b/awx_collection/plugins/modules/tower_job_launch.py
@@ -54,7 +54,7 @@ options:
        - Disable launching jobs from job template.
      type: bool
      default: 'no'
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''

 EXAMPLES = '''
--- a/awx_collection/plugins/modules/tower_job_list.py
+++ b/awx_collection/plugins/modules/tower_job_list.py
@@ -38,7 +38,7 @@ options:
    query:
      description:
        - Query used to further filter the list of jobs. C({"foo":"bar"}) will be passed at C(?foo=bar)
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_job_template.py
+++ b/awx_collection/plugins/modules/tower_job_template.py
@@ -176,7 +176,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 notes:
  - JSON for survey_spec can be found in Tower API Documentation. See
    U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/api_ref.html#/Job_Templates/Job_Templates_job_templates_survey_spec_create)
--- a/awx_collection/plugins/modules/tower_job_wait.py
+++ b/awx_collection/plugins/modules/tower_job_wait.py
@@ -38,7 +38,7 @@ options:
    timeout:
      description:
        - Maximum time in seconds to wait for a job to finish.
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''

 EXAMPLES = '''
--- a/awx_collection/plugins/modules/tower_label.py
+++ b/awx_collection/plugins/modules/tower_label.py
@@ -36,7 +36,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_notification.py
+++ b/awx_collection/plugins/modules/tower_notification.py
@@ -164,7 +164,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_organization.py
+++ b/awx_collection/plugins/modules/tower_organization.py
@@ -35,7 +35,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_project.py
+++ b/awx_collection/plugins/modules/tower_project.py
@@ -85,7 +85,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_receive.py
+++ b/awx_collection/plugins/modules/tower_receive.py
@@ -79,7 +79,7 @@ requirements:
 notes:
  - Specifying a name of "all" for any asset type will export all items of that asset type.

-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''

 EXAMPLES = '''
--- a/awx_collection/plugins/modules/tower_role.py
+++ b/awx_collection/plugins/modules/tower_role.py
@@ -58,7 +58,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_send.py
+++ b/awx_collection/plugins/modules/tower_send.py
@@ -54,7 +54,7 @@ requirements:
  - six.moves.StringIO
  - sys

-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''

 EXAMPLES = '''
--- a/awx_collection/plugins/modules/tower_settings.py
+++ b/awx_collection/plugins/modules/tower_settings.py
@@ -31,7 +31,7 @@ options:
      description:
        - Value to be modified for given setting.
      required: True
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''

 RETURN = ''' # '''
--- a/awx_collection/plugins/modules/tower_team.py
+++ b/awx_collection/plugins/modules/tower_team.py
@@ -36,7 +36,7 @@ options:
        - Desired state of the resource.
      choices: ["present", "absent"]
      default: "present"
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_user.py
+++ b/awx_collection/plugins/modules/tower_user.py
@@ -59,7 +59,7 @@ options:
 requirements:
  - ansible-tower-cli >= 3.2.0

-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''


--- a/awx_collection/plugins/modules/tower_workflow_launch.py
+++ b/awx_collection/plugins/modules/tower_workflow_launch.py
@@ -41,7 +41,7 @@ options:

 requirements:
  - "python >= 2.6"
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''

 RETURN = '''
--- a/awx_collection/plugins/modules/tower_workflow_template.py
+++ b/awx_collection/plugins/modules/tower_workflow_template.py
@@ -73,7 +73,7 @@ options:
        - Desired state of the resource.
      default: "present"
      choices: ["present", "absent"]
-extends_documentation_fragment: tower
+extends_documentation_fragment: awx.awx.auth
 '''