Skip to content

Commit

Permalink
update readme based on latest template for certified collections
Browse files Browse the repository at this point in the history
  • Loading branch information
evgeni committed Jun 19, 2024
1 parent 0ef05c2 commit ba52049
Showing 1 changed file with 62 additions and 9 deletions.
71 changes: 62 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,87 @@
# 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
```
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:
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).
```
ansible-galaxy collection install redhat.satellite --upgrade
```

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).
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
## Use Cases

FIXME: This section should outline in detail 3-5 common use cases for the collection. These should be informative examples of how the collection has been used, or how you’d like to see it be used.


## Testing

FIXME: This section should include information on how the collection was tested and how it performed. Include information on what environments it’s been tested against, and any known exceptions or workarounds necessary for its use.

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/).

## Upstream
## 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).

0 comments on commit ba52049

Please sign in to comment.