External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-03-26 13:25:02 -02:30
Code Issues Packages Projects Releases Wiki Activity

Update auth_plugin doc extension to fix malformed Collections docs

Browse Source
This commit is contained in:
Bianca Henderson
2021-10-18 11:08:17 -04:00
parent 517f1d7991
commit f74a14e34f
3 changed files with 57 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -13,56 +13,61 @@ class ModuleDocFragment(object):
# Automation Platform Controller documentation fragment
DOCUMENTATION = r'''
options:
host:
description: The network address of your Automation Platform Controller host.
env:
- name: CONTROLLER_HOST
- name: TOWER_HOST
deprecated:
removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0'
alternatives: 'CONTROLLER_HOST'
username:
description: The user that you plan to use to access inventories on the controller.
env:
- name: CONTROLLER_USERNAME
- name: TOWER_USERNAME
deprecated:
removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0'
alternatives: 'CONTROLLER_USERNAME'
password:
description: The password for your controller user.
env:
- name: CONTROLLER_PASSWORD
- name: TOWER_PASSWORD
deprecated:
removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0'
alternatives: 'CONTROLLER_PASSWORD'
oauth_token:
description:
- The OAuth token to use.
env:
- name: CONTROLLER_OAUTH_TOKEN
- name: TOWER_OAUTH_TOKEN
deprecated:
removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0'
alternatives: 'CONTROLLER_OAUTH_TOKEN'
verify_ssl:
description:
- Specify whether Ansible should verify the SSL certificate of the controller host.
- Defaults to True, but this is handled by the shared module_utils code
type: bool
env:
- name: CONTROLLER_VERIFY_SSL
- name: TOWER_VERIFY_SSL
deprecated:
removed_from_collection: 'awx.awx.controller'
removed_in_version: '4.0.0'
alternatives: 'CONTROLLER_VERIFY_SSL'
aliases: [ validate_certs ]
host:
description: The network address of your Automation Platform Controller host.
env:
- name: CONTROLLER_HOST
- name: TOWER_HOST
deprecated:
- removed_from_collection: 'awx.awx.controller'
- removed_in: '4.0.0'
- why: Collection name change
- alternative: 'CONTROLLER_HOST'
username:
description: The user that you plan to use to access inventories on the controller.
env:
- name: CONTROLLER_USERNAME
- name: TOWER_USERNAME
deprecated:
- removed_from_collection: 'awx.awx.controller'
- removed_in: '4.0.0'
- why: Collection name change
- alternative: 'CONTROLLER_USERNAME'
password:
description: The password for your controller user.
env:
- name: CONTROLLER_PASSWORD
- name: TOWER_PASSWORD
deprecated:
- removed_from_collection: 'awx.awx.controller'
- removed_in: '4.0.0'
- why: Collection name change
- alternative: 'CONTROLLER_PASSWORD'
oauth_token:
description:
- The OAuth token to use.
env:
- name: CONTROLLER_OAUTH_TOKEN
- name: TOWER_OAUTH_TOKEN
deprecated:
- removed_from_collection: 'awx.awx.controller'
- removed_in: '4.0.0'
- why: Collection name change
- alternative: 'CONTROLLER_OAUTH_TOKEN'
verify_ssl:
description:
- Specify whether Ansible should verify the SSL certificate of the controller host.
- Defaults to True, but this is handled by the shared module_utils code
type: bool
env:
- name: CONTROLLER_VERIFY_SSL
- name: TOWER_VERIFY_SSL
deprecated:
- removed_from_collection: 'awx.awx.controller'
- removed_in: '4.0.0'
- why: Collection name change
- alternative: 'CONTROLLER_VERIFY_SSL'
aliases: [ validate_certs ]
notes:
- If no I(config_file) is provided we will attempt to use the tower-cli library