diff --git a/README.md b/README.md index 5979829..b0c4412 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,81 @@ -# Satellite Operations Collection +# Red Hat Satellite Operations Collection + +## Description Ansible assets for managing Satellite operations such as install, upgrade or maintenance tasks. -## Support +## Requirements -For support questions around this collection, please open a ticket on the [Red Hat Customer Portal](https://access.redhat.com). +* None ## Installation -You can install this collection directly from Automation Hub. +Before using this collection, you need to install it, either directly from Automation Hub or via RPMs provided by Red Hat. The GitHub repository serves as the source for the release and should not be used for direct installation and consumption of the collection. ### Installation from Automation Hub -You can install the collection with `ansible-galaxy collection install redhat.satellite_operations` (Ansible 2.9 and later). +To install it with the Ansible Galaxy command-line tool: -## Satellite Documentation +``` +ansible-galaxy collection install redhat.satellite_operations +``` -The official Satellite documentation can be found in the [Product Documentation section of the Red Hat Customer Portal](https://access.redhat.com/documentation/en-us/red_hat_satellite/). +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: redhat.satellite_operations +``` + +Note that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package. +To upgrade the collection to the latest available version, run the following command: + +``` +ansible-galaxy collection install redhat.satellite_operations --upgrade +``` + +You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 1.0.0: + +``` +ansible-galaxy collection install redhat.satellite_operations:==1.0.0 +``` + +See [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details. + +### Installation via RPM + +The collection is also available as `ansible-collection-redhat-satellite_operations` in the Satellite repository. + + +## Testing + +This collection is tested against all currently maintained Ansible versions and with all currently supported (by Ansible on the target node) Python versions. +You can find the list of maintained Ansible versions and their respective Python versions on [docs.ansible.com](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html). -## Upstream +## Contributing This collection is based on the [`theforeman.operations`](https://github.com/theforeman/foreman-operations-collection) community collection for Foreman and Katello. If possible, any contributions should go directly to `theforeman.operations` from where they will flow back into this collection. + + +## Support + +For support questions around this collection, please open a ticket on the [Red Hat Customer Portal](https://access.redhat.com). + + +## Release Notes and Roadmap + +Please see the [changelog](CHANGELOG.rst). + + +## Related Information + +The official Satellite documentation can be found in the [Product Documentation section of the Red Hat Customer Portal](https://access.redhat.com/documentation/en-us/red_hat_satellite/). + + +## License Information + +This collection is licensed under the [GNU GPL v3](LICENSE).