Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redhat-cop/controller_configuration
A collection of roles to manage Ansible Controller and previously Ansible Tower
https://github.com/redhat-cop/controller_configuration
ansible ansible-automation-platform ansible-controller ansible-tower automation automation-controller automation-cop hacktoberfest
Last synced: about 1 month ago
JSON representation
A collection of roles to manage Ansible Controller and previously Ansible Tower
- Host: GitHub
- URL: https://github.com/redhat-cop/controller_configuration
- Owner: redhat-cop
- License: gpl-3.0
- Created: 2019-08-28T21:02:16.000Z (about 5 years ago)
- Default Branch: devel
- Last Pushed: 2024-04-13T14:52:46.000Z (5 months ago)
- Last Synced: 2024-04-14T03:05:26.381Z (5 months ago)
- Topics: ansible, ansible-automation-platform, ansible-controller, ansible-tower, automation, automation-controller, automation-cop, hacktoberfest
- Language: YAML
- Homepage: https://galaxy.ansible.com/infra/controller_configuration
- Size: 3.64 MB
- Stars: 250
- Watchers: 42
- Forks: 127
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Red Hat Communities of Practice Controller Configuration Collection
This Ansible collection allows for easy interaction with an AWX or Ansible Controller server via Ansible roles using the AWX/Controller collection modules.
## Getting Help
We are on the Ansible Forums and Matrix, if you want to discuss something, ask for help, or participate in the community, please use the #infra-config-as-code tag on the fourm, or post to the chat in Matrix.
[Ansible Forums](https://forum.ansible.com/tag/infra-config-as-code)
[Matrix Chat Room](https://matrix.to/#/#aap_config_as_code:ansible.com)
## Requirements
The awx.awx or ansible.controller collections MUST be installed in order for this collection to work. It is recommended they be invoked in the playbook in the following way.
```yaml
---
- name: Playbook to configure ansible controller post installation
hosts: localhost
connection: local
vars:
controller_validate_certs: true
collections:
- awx.awx
```
## Links to Ansible Automation Platform Collections
| Collection Name | Purpose |
|:--------------------------------------------------------------------------------------------:|:----------------------------------------:|
| [awx.awx/Ansible.controller repo](https://github.com/ansible/awx/tree/devel/awx_collection) | Automation controller modules |
| [Ansible Hub Configuration](https://github.com/ansible/automation_hub_collection) | Automation hub configuration |
## Links to other Validated Configuration Collections for Ansible Automation Platform
| Collection Name | Purpose |
|:------------------------------------------------------------------------------------------:|:----------------------------------------:|
| [Controller Configuration](https://github.com/redhat-cop/controller_configuration) | Automation controller configuration |
| [EE Utilities](https://github.com/redhat-cop/ee_utilities) | Execution Environment creation utilities |
| [AAP installation Utilities](https://github.com/redhat-cop/aap_utilities) | Ansible Automation Platform Utilities |
| [AAP Configuration Template](https://github.com/redhat-cop/aap_configuration_template) | Configuration Template for this suite |
## Included content
Click the `Content` button to see the list of content included in this collection.
## Installing this collection
You can install the infra.controller_configuration.collection with the Ansible Galaxy CLI:
```console
ansible-galaxy collection install infra.controller_configuration
```
You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format:
```yaml
---
collections:
- name: infra.controller_configuration
# If you need a specific version of the collection, you can specify like this:
# version: ...
```
## Conversion from tower_configuration
If you were using a version of redhat_cop.tower_configuration, please refer to our Conversion Guide here: [Conversion Guide](docs/CONVERSION_GUIDE.md)
## Using this collection
The awx.awx or ansible.controller collection must be invoked in the playbook in order for Ansible to pick up the correct modules to use.
The following command will invoke the collection playbook. This is considered a starting point for the collection.
```console
ansible-playbook infra.controller_configuration.configure_controller.yml
```
Otherwise it will look for the modules only in your base installation. If there are errors complaining about "couldn't resolve module/action" this is the most likely cause.
```yaml
- name: Playbook to configure ansible controller post installation
hosts: localhost
connection: local
vars:
controller_validate_certs: true
collections:
- awx.awx
```
Define following vars here, or in `controller_configs/controller_auth.yml`
`controller_hostname: ansible-controller-web-svc-test-project.example.com`
You can also specify authentication by a combination of either:
- `controller_hostname`, `controller_username`, `controller_password`
- `controller_hostname`, `controller_oauthtoken`
The OAuth2 token is the preferred method. You can obtain the token through the preferred `controller_token` module, or through the
AWX CLI [login](https://docs.ansible.com/automation-controller/latest/html/controllerapi/authentication.html)
command.
These can be specified via (from highest to lowest precedence):
- direct role variables as mentioned above
- environment variables (most useful when running against localhost)
- a config file path specified by the `controller_config_file` parameter
- a config file at `~/.controller_cli.cfg`
- a config file at `/etc/controller/controller_cli.cfg`
Config file syntax looks like this:
```ini
[general]
host = https://localhost:8043
verify_ssl = true
oauth_token = LEdCpKVKc4znzffcpQL5vLG8oyeku6
```
Controller token module would be invoked with this code:
```yaml
- name: Create a new token using controller username/password
awx.awx.token:
description: 'Creating token to test controller jobs'
scope: "write"
state: present
controller_host: "{{ controller_hostname }}"
controller_username: "{{ controller_username }}"
controller_password: "{{ controller_password }}"
```
### Automate the Automation
Every Ansible Controller instance has it's own particularities and needs. Every administrator team has it's own practices and customs. This collection allows adaptation to every need, from small to large scale, having the objects distributed across multiple environments and leveraging Automation Webhook that can be used to link a Git repository and Ansible automation natively.
A complete example of how to use all of the roles present in the collection is available at the following [README.md](roles/filetree_create/automatetheautomation.md), where all the phases to allow CI/CD for the Controller Configuration are provided.
#### Scale at your needs
The input data can be organized in a very flexible way, letting the user use anything from a single file to an entire file tree to store the controller objects definitions, which could be used as a logical segregation of different applications, as needed in real scenarios.
### Controller Export
The awx command line can export json that is compatible with this collection.
In addition there is an awx.awx/ansible.controller export module that use the awx command line to export.
More details can be found [here](EXPORT_README.md)
### Template Example
A Template to use in order to start using the collections can be found [here](https://github.com/redhat-cop/aap_configuration_template)
### See Also
- [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
## Release and Upgrade Notes
For details on changes between versions, please see [the changelog for this collection](CHANGELOG.rst).
## Releasing, Versioning and Deprecation
This collection follows [Semantic Versioning](https://semver.org/). More details on versioning can be found [in the Ansible docs](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html#collection-versions).
We plan to regularly release new minor or bugfix versions once new features or bugfixes have been implemented.
Releasing the current major version happens from the `devel` branch.
## Roadmap
Adding the ability to use direct output from the awx export command in the roles along with the current data model.
## Contributing to this collection
We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the [Controller Configuration collection repository](https://github.com/redhat-cop/controller_configuration).
More information about contributing can be found in our [Contribution Guidelines.](https://github.com/redhat-cop/controller_configuration/blob/devel/.github/CONTRIBUTING.md)
We have a community meeting every 4 weeks. Find the agenda in the [issues](https://github.com/redhat-cop/controller_configuration/issues) and the calendar invitation below:
## Code of Conduct
This collection follows the Ansible project's
[Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
Please read and familiarize yourself with this document.
## Licensing
GNU General Public License v3.0 or later.
See [LICENSE](LICENSE) to see the full text.