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

awx_collection/plugins/doc_fragments/auth.py

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

awx_collection/plugins/modules/tower_credential.py

@@ -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"

awx_collection/plugins/modules/tower_credential_type.py

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

awx_collection/plugins/modules/tower_group.py

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

awx_collection/plugins/modules/tower_host.py

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

awx_collection/plugins/modules/tower_inventory.py

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

awx_collection/plugins/modules/tower_inventory_source.py

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

awx_collection/plugins/modules/tower_job_cancel.py

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

awx_collection/plugins/modules/tower_job_launch.py

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

awx_collection/plugins/modules/tower_job_list.py

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

awx_collection/plugins/modules/tower_job_template.py

@@ -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"
 

awx_collection/plugins/modules/tower_job_wait.py

@@ -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"

awx_collection/plugins/modules/tower_label.py

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

awx_collection/plugins/modules/tower_license.py

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

awx_collection/plugins/modules/tower_notification.py

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

awx_collection/plugins/modules/tower_organization.py

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

awx_collection/plugins/modules/tower_project.py

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

awx_collection/plugins/modules/tower_role.py

@@ -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"
 

awx_collection/plugins/modules/tower_settings.py

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

awx_collection/plugins/modules/tower_team.py

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

awx_collection/plugins/modules/tower_user.py

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

awx_collection/plugins/modules/tower_workflow_job_template.py

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

awx_collection/plugins/modules/tower_workflow_job_template_node.py

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

awxkit/awxkit/cli/docs/source/authentication.rst

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

awxkit/awxkit/cli/docs/source/usage.rst

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

awxkit/awxkit/cli/format.py

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

awxkit/awxkit/cli/resource.py

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