-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update readme based on latest template for certified collections #79
Merged
+58
−9
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,83 @@ | ||
# Red Hat Satellite Ansible Collection | ||
|
||
## Description | ||
|
||
Ansible modules for interacting with the Satellite API. | ||
|
||
## Support | ||
## Requirements | ||
|
||
For support questions around this collection, please open a ticket on the [Red Hat Customer Portal](https://access.redhat.com). | ||
* [`PyYAML`](https://pypi.org/project/PyYAML/) | ||
* [`requests`](https://pypi.org/project/requests/) | ||
* The Python `rpm` bindings for the RPM support in the `content_upload` module | ||
|
||
## Installation | ||
|
||
You can install this collection directly from Automation Hub or via RPMs provided by Red Hat. | ||
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`. | ||
To install it with the Ansible Galaxy command-line tool: | ||
|
||
``` | ||
ansible-galaxy collection install redhat.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 | ||
``` | ||
|
||
See the Ansible documentation how to configure `ansible-galaxy` to be able to [download a collection from Automation Hub](https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#downloading-a-collection-from-automation-hub). | ||
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: | ||
|
||
You will need to install the Python `requests` library manually, e.g. from the RPM provided by Red Hat (`python-requests` on Red Hat Enterprise Linux 7, `python3-requests` on Red Hat Enterprise Linux 8). | ||
``` | ||
ansible-galaxy collection install redhat.satellite --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:==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` in the Satellite repository. | ||
|
||
## Satellite Documentation | ||
|
||
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/). | ||
## Testing | ||
|
||
## Upstream | ||
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). | ||
|
||
## Contributing | ||
|
||
This collection is based on the [`theforeman.foreman`](https://github.com/theforeman/foreman-ansible-modules) community collection for Foreman and Katello. | ||
If possible, any contributions should go directly to `theforeman.foreman` 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). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should it also mention
requirements.yml
can have version requirements?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just following the template 😢