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/README.md | |
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/README.md')
-rw-r--r-- | awx_collection/README.md | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/awx_collection/README.md b/awx_collection/README.md index 73efb5e249..767073c4ef 100644 --- a/awx_collection/README.md +++ b/awx_collection/README.md @@ -32,11 +32,28 @@ Installing the `tar.gz` involves no special instructions. ## 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 @@ -46,6 +63,7 @@ Notable releases of the `awx.awx` collection: - 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. |