External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-07-28 00:19:54 -02:30
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11253 from beeankha/collections_docs_fix_pt2

Browse Source 
Update auth_plugin Doc Extension File to Fix Malformed Collections Docs
This commit is contained in:
Shane McDonald
2021-10-18 18:07:41 -04:00
committed by GitHub
parent 517f1d7991 f74a14e34f
commit 61eb99c46d
3 changed files with 57 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
awx_collection/plugins/doc_fragments/auth_plugin.py
View File

@@ -19,27 +19,30 @@ options:
- name: CONTROLLER_HOST - name: CONTROLLER_HOST
- name: TOWER_HOST - name: TOWER_HOST
deprecated: deprecated:
removed_from_collection: 'awx.awx.controller' - removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0' - removed_in: '4.0.0'
alternatives: 'CONTROLLER_HOST' - why: Collection name change
- alternative: 'CONTROLLER_HOST'
username: username:
description: The user that you plan to use to access inventories on the controller. description: The user that you plan to use to access inventories on the controller.
env: env:
- name: CONTROLLER_USERNAME - name: CONTROLLER_USERNAME
- name: TOWER_USERNAME - name: TOWER_USERNAME
deprecated: deprecated:
removed_from_collection: 'awx.awx.controller' - removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0' - removed_in: '4.0.0'
alternatives: 'CONTROLLER_USERNAME' - why: Collection name change
- alternative: 'CONTROLLER_USERNAME'
password: password:
description: The password for your controller user. description: The password for your controller user.
env: env:
- name: CONTROLLER_PASSWORD - name: CONTROLLER_PASSWORD
- name: TOWER_PASSWORD - name: TOWER_PASSWORD
deprecated: deprecated:
removed_from_collection: 'awx.awx.controller' - removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0' - removed_in: '4.0.0'
alternatives: 'CONTROLLER_PASSWORD' - why: Collection name change
- alternative: 'CONTROLLER_PASSWORD'
oauth_token: oauth_token:
description: description:
- The OAuth token to use. - The OAuth token to use.
@@ -47,9 +50,10 @@ options:
- name: CONTROLLER_OAUTH_TOKEN - name: CONTROLLER_OAUTH_TOKEN
- name: TOWER_OAUTH_TOKEN - name: TOWER_OAUTH_TOKEN
deprecated: deprecated:
removed_from_collection: 'awx.awx.controller' - removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0' - removed_in: '4.0.0'
alternatives: 'CONTROLLER_OAUTH_TOKEN' - why: Collection name change
- alternative: 'CONTROLLER_OAUTH_TOKEN'
verify_ssl: verify_ssl:
description: description:
- Specify whether Ansible should verify the SSL certificate of the controller host. - Specify whether Ansible should verify the SSL certificate of the controller host.
@@ -59,9 +63,10 @@ options:
- name: CONTROLLER_VERIFY_SSL - name: CONTROLLER_VERIFY_SSL
- name: TOWER_VERIFY_SSL - name: TOWER_VERIFY_SSL
deprecated: deprecated:
removed_from_collection: 'awx.awx.controller' - removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0' - removed_in: '4.0.0'
alternatives: 'CONTROLLER_VERIFY_SSL' - why: Collection name change
- alternative: 'CONTROLLER_VERIFY_SSL'
aliases: [ validate_certs ] aliases: [ validate_certs ]
notes: notes:

2
awx_collection/plugins/inventory/controller.py
View File

@@ -19,7 +19,6 @@ description:
the path in the command would be /path/to/controller_inventory.(yml|yaml). If some arguments in the config file the path in the command would be /path/to/controller_inventory.(yml|yaml). If some arguments in the config file
are missing, this plugin will try to fill in missing arguments by reading from environment variables. are missing, this plugin will try to fill in missing arguments by reading from environment variables.
- If reading configurations from environment variables, the path in the command must be @controller_inventory. - If reading configurations from environment variables, the path in the command must be @controller_inventory.
extends_documentation_fragment: awx.awx.auth_plugin
options: options:
inventory_id: inventory_id:
description: description:
@@ -35,6 +34,7 @@ options:
description: Make extra requests to provide all group vars with metadata about the source host. description: Make extra requests to provide all group vars with metadata about the source host.
type: bool type: bool
default: False default: False
extends_documentation_fragment: awx.awx.auth_plugin
''' '''
EXAMPLES = ''' EXAMPLES = '''

3
awx_collection/plugins/lookup/controller_api.py
View File

@@ -15,7 +15,6 @@ description:
U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage. U(https://docs.ansible.com/ansible-tower/latest/html/towerapi/index.html) for API usage.
- For use that is cross-compatible between the awx.awx and ansible.controller collection - For use that is cross-compatible between the awx.awx and ansible.controller collection
see the controller_meta module see the controller_meta module
extends_documentation_fragment: awx.awx.auth_plugin
options: options:
_terms: _terms:
description: description:
@@ -63,7 +62,7 @@ options:
- If a list view returns more an max_objects an exception will be raised - If a list view returns more an max_objects an exception will be raised
type: integer type: integer
default: 1000 default: 1000
extends_documentation_fragment: awx.awx.auth_plugin
notes: notes:
- If the query is not filtered properly this can cause a performance impact. - If the query is not filtered properly this can cause a performance impact.
""" """