68 lines
3.5 KiB
Markdown
68 lines
3.5 KiB
Markdown
# Community Hetzner Robot Collection
|
|
[](https://github.com/ansible-collections/community.hrobot/actions) [](https://codecov.io/gh/ansible-collections/community.hrobot)
|
|
|
|
This repository contains the `community.hrobot` Ansible Collection. The collection includes modules to work with [Hetzner's Robot](https://docs.hetzner.com/robot/).
|
|
|
|
You can find [documentation for the modules and plugins in this collection here](https://docs.ansible.com/ansible/devel/collections/community/hrobot/).
|
|
|
|
Please note that this collection does **not** support Windows targets.
|
|
|
|
## Tested with Ansible
|
|
|
|
Tested with the current Ansible 2.9, ansible-base 2.10, ansible-core 2.11, ansible-core 2.12 and ansible-core 2.13 releases and the current development version of ansible-core. Ansible versions before 2.9.10 are not supported.
|
|
|
|
## External requirements
|
|
|
|
A Hetzner Robot account.
|
|
|
|
## Included content
|
|
|
|
- `community.hrobot.failover_ip` module
|
|
- `community.hrobot.failover_ip_info` module
|
|
- `community.hrobot.firewall` module
|
|
- `community.hrobot.firewall_info` module
|
|
- `community.hrobot.hrobot` inventory plugin
|
|
|
|
You can find [documentation for the modules and plugins in this collection here](https://docs.ansible.com/ansible/devel/collections/community/hrobot/).
|
|
|
|
## Using this collection
|
|
|
|
Before using the General community collection, you need to install the collection with the `ansible-galaxy` CLI:
|
|
|
|
ansible-galaxy collection install community.hrobot
|
|
|
|
You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format:
|
|
|
|
```yaml
|
|
collections:
|
|
- name: community.hrobot
|
|
```
|
|
|
|
See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
|
|
|
|
## Contributing to this collection
|
|
|
|
If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATH`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
|
|
|
|
You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html).
|
|
|
|
## Release notes
|
|
|
|
See the [changelog](https://github.com/ansible-collections/community.hrobot/tree/main/CHANGELOG.rst).
|
|
|
|
## More information
|
|
|
|
- [Ansible Collection overview](https://github.com/ansible-collections/overview)
|
|
- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
|
|
- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
|
|
- [Ansible Collections Checklist](https://github.com/ansible-collections/overview/blob/master/collection_requirements.rst)
|
|
- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
|
|
- [The Bullhorn (the Ansible Contributor newsletter)](https://us19.campaign-archive.com/home/?u=56d874e027110e35dea0e03c1&id=d6635f5420)
|
|
- [Changes impacting Contributors](https://github.com/ansible-collections/overview/issues/45)
|
|
|
|
## Licensing
|
|
|
|
GNU General Public License v3.0 or later.
|
|
|
|
See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.
|