mirror of
https://github.com/ansible/awx.git
synced 2026-02-21 05:00:07 -03:30
Moving tower_oauthtoken into a doc fragement
This commit is contained in:
@@ -28,6 +28,12 @@ options:
|
|||||||
- Password for your Tower or AWX instance.
|
- Password for your Tower or AWX instance.
|
||||||
- If value not set, will try environment variable C(TOWER_PASSWORD) and then config files
|
- If value not set, will try environment variable C(TOWER_PASSWORD) and then config files
|
||||||
type: str
|
type: str
|
||||||
|
tower_oauthtoken:
|
||||||
|
description:
|
||||||
|
- The Tower OAuth token to use.
|
||||||
|
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
||||||
|
type: str
|
||||||
|
version_added: "3.7"
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- Whether to allow insecure connections to Tower or AWX.
|
- Whether to allow insecure connections to Tower or AWX.
|
||||||
|
|||||||
52
awx_collection/plugins/doc_fragments/auth_legacy.py
Normal file
52
awx_collection/plugins/doc_fragments/auth_legacy.py
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
# -*- 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)
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
|
||||||
|
class ModuleDocFragment(object):
|
||||||
|
|
||||||
|
# Ansible Tower documentation fragment
|
||||||
|
DOCUMENTATION = r'''
|
||||||
|
options:
|
||||||
|
tower_host:
|
||||||
|
description:
|
||||||
|
- URL to your Tower or AWX instance.
|
||||||
|
- If value not set, will try environment variable C(TOWER_HOST) and then config files
|
||||||
|
- If value not specified by any means, the value of C(127.0.0.1) will be used
|
||||||
|
type: str
|
||||||
|
tower_username:
|
||||||
|
description:
|
||||||
|
- Username for your Tower or AWX instance.
|
||||||
|
- If value not set, will try environment variable C(TOWER_USERNAME) and then config files
|
||||||
|
type: str
|
||||||
|
tower_password:
|
||||||
|
description:
|
||||||
|
- Password for your Tower or AWX instance.
|
||||||
|
- If value not set, will try environment variable C(TOWER_PASSWORD) and then config files
|
||||||
|
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.
|
||||||
|
- If value not set, will try environment variable C(TOWER_VERIFY_SSL) and then config files
|
||||||
|
type: bool
|
||||||
|
aliases: [ tower_verify_ssl ]
|
||||||
|
tower_config_file:
|
||||||
|
description:
|
||||||
|
- Path to the Tower or AWX config file.
|
||||||
|
- If provided, the other locations for config files will not be considered.
|
||||||
|
type: path
|
||||||
|
|
||||||
|
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
|
||||||
|
'''
|
||||||
@@ -184,13 +184,6 @@ options:
|
|||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
default: "present"
|
default: "present"
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
required: False
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
|
|
||||||
|
|||||||
@@ -59,12 +59,6 @@ options:
|
|||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -64,12 +64,6 @@ options:
|
|||||||
- A new name for this group (for renaming)
|
- A new name for this group (for renaming)
|
||||||
type: str
|
type: str
|
||||||
version_added: "3.7"
|
version_added: "3.7"
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -57,12 +57,6 @@ options:
|
|||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
default: "present"
|
default: "present"
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -59,12 +59,6 @@ options:
|
|||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -119,12 +119,6 @@ options:
|
|||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
notification_templates_started:
|
notification_templates_started:
|
||||||
description:
|
description:
|
||||||
- list of notifications to send on start
|
- list of notifications to send on start
|
||||||
|
|||||||
@@ -33,12 +33,6 @@ options:
|
|||||||
- Fail loudly if the I(job_id) can not be canceled
|
- Fail loudly if the I(job_id) can not be canceled
|
||||||
default: False
|
default: False
|
||||||
type: bool
|
type: bool
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -87,12 +87,6 @@ options:
|
|||||||
- Passwords for credentials which are set to prompt on launch
|
- Passwords for credentials which are set to prompt on launch
|
||||||
type: dict
|
type: dict
|
||||||
version_added: "3.7"
|
version_added: "3.7"
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -41,12 +41,6 @@ options:
|
|||||||
description:
|
description:
|
||||||
- Query used to further filter the list of jobs. C({"foo":"bar"}) will be passed at C(?foo=bar)
|
- Query used to further filter the list of jobs. C({"foo":"bar"}) will be passed at C(?foo=bar)
|
||||||
type: dict
|
type: dict
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -268,12 +268,6 @@ options:
|
|||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
notification_templates_started:
|
notification_templates_started:
|
||||||
description:
|
description:
|
||||||
- list of notifications to send on start
|
- list of notifications to send on start
|
||||||
|
|||||||
@@ -49,13 +49,6 @@ options:
|
|||||||
description:
|
description:
|
||||||
- Maximum time in seconds to wait for a job to finish.
|
- Maximum time in seconds to wait for a job to finish.
|
||||||
type: int
|
type: int
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
required: False
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -45,12 +45,6 @@ options:
|
|||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present"]
|
choices: ["present"]
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -34,12 +34,6 @@ options:
|
|||||||
required: True
|
required: True
|
||||||
type: bool
|
type: bool
|
||||||
version_added: "3.7"
|
version_added: "3.7"
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -210,12 +210,6 @@ options:
|
|||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
version_added: "3.7"
|
|
||||||
type: str
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -50,12 +50,6 @@ options:
|
|||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
notification_templates_started:
|
notification_templates_started:
|
||||||
description:
|
description:
|
||||||
- list of notifications to send on start
|
- list of notifications to send on start
|
||||||
|
|||||||
@@ -121,12 +121,6 @@ options:
|
|||||||
on the project may be successfully created
|
on the project may be successfully created
|
||||||
type: bool
|
type: bool
|
||||||
default: True
|
default: True
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
notification_templates_started:
|
notification_templates_started:
|
||||||
description:
|
description:
|
||||||
- list of notifications to send on start
|
- list of notifications to send on start
|
||||||
|
|||||||
@@ -105,7 +105,7 @@ requirements:
|
|||||||
notes:
|
notes:
|
||||||
- Specifying a name of "all" for any asset type will export all items of that asset type.
|
- Specifying a name of "all" for any asset type will export all items of that asset type.
|
||||||
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth_legacy
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -76,15 +76,6 @@ options:
|
|||||||
default: "present"
|
default: "present"
|
||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
|
|
||||||
requirements:
|
|
||||||
- ansible-tower-cli >= 3.0.2
|
|
||||||
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ requirements:
|
|||||||
- six.moves.StringIO
|
- six.moves.StringIO
|
||||||
- sys
|
- sys
|
||||||
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth_legacy
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -38,12 +38,6 @@ options:
|
|||||||
- A data structure to be sent into the settings endpoint
|
- A data structure to be sent into the settings endpoint
|
||||||
type: dict
|
type: dict
|
||||||
version_added: "3.7"
|
version_added: "3.7"
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
requirements:
|
requirements:
|
||||||
- pyyaml
|
- pyyaml
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
|
|||||||
@@ -48,12 +48,6 @@ options:
|
|||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
default: "present"
|
default: "present"
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -62,12 +62,6 @@ options:
|
|||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
default: "present"
|
default: "present"
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -107,12 +107,6 @@ options:
|
|||||||
- absent
|
- absent
|
||||||
default: "present"
|
default: "present"
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
notification_templates_started:
|
notification_templates_started:
|
||||||
description:
|
description:
|
||||||
- list of notifications to send on start
|
- list of notifications to send on start
|
||||||
|
|||||||
@@ -135,12 +135,6 @@ options:
|
|||||||
choices: ["present", "absent"]
|
choices: ["present", "absent"]
|
||||||
default: "present"
|
default: "present"
|
||||||
type: str
|
type: str
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
- If value not set, will try environment variable C(TOWER_OAUTH_TOKEN) and then config files
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -68,12 +68,6 @@ options:
|
|||||||
- If waiting for the workflow to complete this will abort after this
|
- If waiting for the workflow to complete this will abort after this
|
||||||
amount of seconds
|
amount of seconds
|
||||||
type: int
|
type: int
|
||||||
tower_oauthtoken:
|
|
||||||
description:
|
|
||||||
- The Tower OAuth token to use.
|
|
||||||
required: False
|
|
||||||
type: str
|
|
||||||
version_added: "3.7"
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|||||||
@@ -92,7 +92,7 @@ options:
|
|||||||
requirements:
|
requirements:
|
||||||
- ansible-tower-cli >= 3.0.2
|
- ansible-tower-cli >= 3.0.2
|
||||||
|
|
||||||
extends_documentation_fragment: awx.awx.auth
|
extends_documentation_fragment: awx.awx.auth_legacy
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user