diff options
author | Pablo H. <palonso@redhat.com> | 2024-11-19 21:08:10 +0100 |
---|---|---|
committer | Alan Rominger <arominge@redhat.com> | 2024-11-20 17:18:52 +0100 |
commit | 3ba6e2e394be319d41c80243f88399dc2bf2e4a0 (patch) | |
tree | 11c97a5e2f9e13b586553364c15d9f0a9fefa172 /awx_collection/tools | |
parent | Removal of OAuth2 stuff from CLI (diff) | |
download | awx-3ba6e2e394be319d41c80243f88399dc2bf2e4a0.tar.xz awx-3ba6e2e394be319d41c80243f88399dc2bf2e4a0.zip |
feat: remove collection support for oauth (#15623)
Co-authored-by: Alan Rominger <arominge@redhat.com>
Diffstat (limited to 'awx_collection/tools')
-rw-r--r-- | awx_collection/tools/roles/generate/templates/module.j2 | 5 | ||||
-rw-r--r-- | awx_collection/tools/roles/template_galaxy/templates/README.md.j2 | 23 |
2 files changed, 21 insertions, 7 deletions
diff --git a/awx_collection/tools/roles/generate/templates/module.j2 b/awx_collection/tools/roles/generate/templates/module.j2 index 57e6bc4c77..6efe6340e9 100644 --- a/awx_collection/tools/roles/generate/templates/module.j2 +++ b/awx_collection/tools/roles/generate/templates/module.j2 @@ -82,11 +82,6 @@ options: choices: ["present", "absent"] default: "present" type: str - controller_oauthtoken: - description: - - The OAuth token to use. - required: False - type: str extends_documentation_fragment: awx.awx.auth ''' diff --git a/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 b/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 index e7c232b263..def1d0c64d 100644 --- a/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 +++ b/awx_collection/tools/roles/template_galaxy/templates/README.md.j2 @@ -37,11 +37,28 @@ This collection should be installed from [Content Hub](https://cloud.redhat.com/ ## Running Non-deprecated modules in this collection have no Python requirements, but -may require the AWX CLI +may require the official [AWX CLI](https://pypi.org/project/awxkit/) in the future. The `DOCUMENTATION` for each module will report this. You can specify authentication by host, username, and password. +These can be specified via (from highest to lowest precedence): + + - direct module parameters + - environment variables (most useful when running against localhost) + - a config file path specified by the `tower_config_file` parameter + - a config file at `~/.tower_cli.cfg` + - a config file at `/etc/tower/tower_cli.cfg` + +Config file syntax looks like this: + +``` +[general] +host = https://localhost:8043 +verify_ssl = true +username = foo +password = bar +``` ## Release and Upgrade Notes @@ -52,12 +69,14 @@ Notable releases of the `{{ collection_namespace }}.{{ collection_package }}` co - 11.0.0 has no non-deprecated modules that depend on the deprecated `tower-cli` [PyPI](https://pypi.org/project/ansible-tower-cli/). - 19.2.1 large renaming purged "tower" names (like options and module names), adding redirects for old names - 21.11.0 "tower" modules deprecated and symlinks removed. + - 25.0.0 "token" and "application" modules have been removed as oauth is no longer supported, use basic auth instead - X.X.X added support of named URLs to all modules. Anywhere that previously accepted name or id can also support named URLs - 0.0.1-devel is the version you should see if installing from source, which is intended for development and expected to be unstable. {% else %} - 3.7.0 initial release - 4.0.0 ansible.tower renamed to ansible.controller - tower_ prefix is dropped from the module names, e.g. tower_inventory becomes inventory + - 4.7.0 "token" module has been removed as oauth is no longer supported, use basic auth instead {% endif %} The following notes are changes that may require changes to playbooks: @@ -90,7 +109,7 @@ The following notes are changes that may require changes to playbooks: - The `notification_configuration` parameter of `tower_notification_template` has changed from a string to a dict. Please use the `lookup` plugin to read an existing file into a dict. - `tower_credential` no longer supports passing a file name to `ssh_key_data`. - The HipChat `notification_type` has been removed and can no longer be created using the `tower_notification_template` module. - - Lookup plugins now always reutrn a list, and if you want a scalar value use `lookup` as opposed to `query` + - Lookup plugins now always return a list, and if you want a scalar value use `lookup` as opposed to `query` {% if collection_package | lower() == "awx" %} ## Running Unit Tests |