External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-01-10 15:32:07 -03:30
Code Issues Packages Projects Releases Wiki Activity

Document and align the env var for OAuth token

Browse Source
This commit is contained in:
AlanCoding 2020-04-07 10:00:02 -04:00
parent d40143a63d
commit b90a296d41
No known key found for this signature in database
GPG Key ID: FD2C3C012A72926B
29 changed files with 33 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
awx_collection/plugins/doc_fragments/auth.py
View File

@ -15,20 +15,25 @@ 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
default: '127.0.0.1'
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:

2
awx_collection/plugins/module_utils/ansible_tower.py
View File

@ -124,7 +124,7 @@ def tower_check_mode(module):
class TowerModule(AnsibleModule):
def __init__(self, argument_spec, **kwargs):
args = dict(
tower_host=dict(),
tower_host=dict(default='127.0.0.1'),
tower_username=dict(),
tower_password=dict(no_log=True),
validate_certs=dict(type='bool', aliases=['tower_verify_ssl']),

2
awx_collection/plugins/module_utils/tower_api.py
View File

@ -47,7 +47,7 @@ class TowerModule(AnsibleModule):
def __init__(self, argument_spec, **kwargs):
args = dict(
tower_host=dict(required=False, fallback=(env_fallback, ['TOWER_HOST'])),
tower_host=dict(required=False, default='127.0.0.1', fallback=(env_fallback, ['TOWER_HOST'])),
tower_username=dict(required=False, fallback=(env_fallback, ['TOWER_USERNAME'])),
tower_password=dict(no_log=True, required=False, fallback=(env_fallback, ['TOWER_PASSWORD'])),
validate_certs=dict(type='bool', aliases=['tower_verify_ssl'], required=False, fallback=(env_fallback, ['TOWER_VERIFY_SSL'])),

1
awx_collection/plugins/modules/tower_credential.py
View File

@ -187,6 +187,7 @@ options:
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"

1
awx_collection/plugins/modules/tower_credential_type.py
View File

@ -62,6 +62,7 @@ options:
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

1
awx_collection/plugins/modules/tower_group.py
View File

@ -67,6 +67,7 @@ options:
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

1
awx_collection/plugins/modules/tower_host.py
View File

@ -60,6 +60,7 @@ options:
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

1
awx_collection/plugins/modules/tower_inventory.py
View File

@ -62,6 +62,7 @@ options:
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

1
awx_collection/plugins/modules/tower_inventory_source.py
View File

@ -122,6 +122,7 @@ options:
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

1
awx_collection/plugins/modules/tower_job_cancel.py
View File

@ -36,6 +36,7 @@ options:
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

1
awx_collection/plugins/modules/tower_job_launch.py
View File

@ -90,6 +90,7 @@ options:
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

1
awx_collection/plugins/modules/tower_job_list.py
View File

@ -44,6 +44,7 @@ options:
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

1
awx_collection/plugins/modules/tower_job_template.py
View File

@ -272,6 +272,7 @@ options:
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"

1
awx_collection/plugins/modules/tower_job_wait.py
View File

@ -52,6 +52,7 @@ options:
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"

1
awx_collection/plugins/modules/tower_label.py
View File

@ -48,6 +48,7 @@ options:
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

1
awx_collection/plugins/modules/tower_license.py
View File

@ -37,6 +37,7 @@ options:
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

1
awx_collection/plugins/modules/tower_notification.py
View File

@ -213,6 +213,7 @@ options:
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

1
awx_collection/plugins/modules/tower_organization.py
View File

@ -53,6 +53,7 @@ options:
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

1
awx_collection/plugins/modules/tower_project.py
View File

@ -122,6 +122,7 @@ options:
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

1
awx_collection/plugins/modules/tower_role.py
View File

@ -79,6 +79,7 @@ options:
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"

1
awx_collection/plugins/modules/tower_settings.py
View File

@ -41,6 +41,7 @@ options:
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:

1
awx_collection/plugins/modules/tower_team.py
View File

@ -51,6 +51,7 @@ options:
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

1
awx_collection/plugins/modules/tower_user.py
View File

@ -65,6 +65,7 @@ options:
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

1
awx_collection/plugins/modules/tower_workflow_job_template.py
View File

@ -110,6 +110,7 @@ options:
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

1
awx_collection/plugins/modules/tower_workflow_job_template_node.py
View File

@ -138,6 +138,7 @@ options:
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

2
awxkit/awxkit/cli/docs/source/authentication.rst
View File

@ -22,7 +22,7 @@ value:
.. code:: bash
export TOWER_TOKEN=6E5SXhld7AMOhpRveZsLJQsfs9VS8U
export TOWER_OAUTH_TOKEN=6E5SXhld7AMOhpRveZsLJQsfs9VS8U
By ingesting this token, you can run subsequent CLI commands without having to
specify your username and password each time:

2
awxkit/awxkit/cli/docs/source/usage.rst
View File

@ -89,5 +89,5 @@ A few of the most important ones are:
``--conf.password, TOWER_PASSWORD``
the AWX password to use for authentication
``--conf.token, TOWER_TOKEN``
``--conf.token, TOWER_OAUTH_TOKEN``
an OAuth2.0 token to use for authentication

2
awxkit/awxkit/cli/format.py
View File

@ -16,7 +16,7 @@ def add_authentication_arguments(parser, env):
)
auth.add_argument(
'--conf.token',
default=env.get('TOWER_TOKEN', ''),
default=env.get('TOWER_OAUTH_TOKEN', env.get('TOWER_TOKEN', '')),
help='an OAuth2.0 token (get one by using `awx login`)',
metavar='TEXT',
)

2
awxkit/awxkit/cli/resource.py
View File

@ -102,7 +102,7 @@ class Login(CustomCommand):
else:
fmt = client.get_config('format')
if fmt == 'human':
print('export TOWER_TOKEN={}'.format(token))
print('export TOWER_OAUTH_TOKEN={}'.format(token))
else:
print(to_str(FORMATTERS[fmt]({'token': token}, '.')).strip())