mirror of
https://github.com/ansible/awx.git
synced 2026-01-27 00:21:30 -03:30
7dd8e35e8c
doc fragment will now be at awx.awx.auth changed from just tower, which source from core remove Makefile things no longer needed
59 lines
2.0 KiB
Markdown
59 lines
2.0 KiB
Markdown
# AWX Ansible Collection
|
|
|
|
This Ansible collection allows for easy interaction with an AWX or Ansible Tower
|
|
server in Ansible playbooks.
|
|
|
|
The previous home for this collection was in https://github.com/ansible/ansible
|
|
inside the folder `lib/ansible/modules/web_infrastructure/ansible_tower`
|
|
as well as other folders for the inventory plugin, module utils, and
|
|
doc fragment.
|
|
|
|
## Running
|
|
|
|
To use this collection, the "old" tower-cli needs to be installed
|
|
in the virtual environment where the collection runs.
|
|
You can install it from either:
|
|
|
|
- https://github.com/ansible/tower-cli/
|
|
- https://pypi.org/project/ansible-tower-cli/
|
|
|
|
To use this collection in AWX, you should create a custom virtual environment
|
|
to install the requirement into. NOTE: running locally, you will also need
|
|
to set the job template extra_vars to include `ansible_python_interpreter`
|
|
to be the python in that virtual environment.
|
|
|
|
## Running Tests
|
|
|
|
Tests to verify compatibility with the most recent AWX code are
|
|
in `awx_collection/test/awx`. These tests require that python packages
|
|
are available for all of `awx`, `ansible`, `tower_cli`, and the collection
|
|
itself.
|
|
|
|
The target `make prepare_collection_venv` will prepare some requirements
|
|
in the `awx_collection_test_venv` folder so that `make test_collection` can
|
|
be ran to actually run the tests. A single test can be ran via:
|
|
|
|
```
|
|
make test_collection MODULE_TEST_DIRS=awx_collection/test/awx/test_organization.py
|
|
```
|
|
|
|
## Building
|
|
|
|
The build target `make build_collection` will template out a `galaxy.yml` file
|
|
with automatic detection of the current AWX version. Then it builds the
|
|
collection with the `ansible-galaxy` CLI.
|
|
|
|
## Roadmap
|
|
|
|
Major future development items on the agenda include:
|
|
|
|
- Removing tower-cli as a dependency
|
|
- Renaming the modules, for example `tower_organization` to just `organization`
|
|
and giving a deprecation period for the switch
|
|
|
|
## Licensing
|
|
|
|
All content in this folder is licensed under the same license as Ansible,
|
|
which is the same as license that applied before the split into an
|
|
independent collection.
|