1
0
mirror of https://github.com/ansible/awx.git synced 2024-10-27 09:25:10 +03:00

Merge pull request #6629 from AlanCoding/one_token_to_rule_them_all

Document and align the env var for OAuth token

Reviewed-by: https://github.com/apps/softwarefactory-project-zuul
This commit is contained in:
softwarefactory-project-zuul[bot] 2020-04-08 06:09:29 +00:00 committed by GitHub
commit a26c0dfb8a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 31 additions and 4 deletions

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
- 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:

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"

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

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

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

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

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

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

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

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

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"

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"

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

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

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

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

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

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"

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:

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

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

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

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

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:

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

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',
)

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())