No description
Find a file
Jonas L d0c82aec86
feat!: remove inventory api_token_env option (#454)
##### SUMMARY

Remove the previously deprecated `api_token_env` to fully leverage the
ansible inventory options loader.

##### ISSUE TYPE

- Feature Pull Request


##### COMPONENT NAME

inventory
2024-02-05 12:18:39 +01:00
.azure-pipelines ci: use latest python version for ansible devel jobs (#436) 2023-12-21 18:28:32 +01:00
.github chore(main): release 2.5.0 (#419) 2024-02-02 10:45:50 +01:00
changelogs feat!: remove inventory api_token_env option (#454) 2024-02-05 12:18:39 +01:00
docs/docsite docs: restructure guides documentation (#422) 2023-12-14 18:17:22 +01:00
examples feat: improve firewall resources management (#324) 2024-02-01 16:50:13 +01:00
meta feat: improve firewall resources management (#324) 2024-02-01 16:50:13 +01:00
plugins feat!: remove inventory api_token_env option (#454) 2024-02-05 12:18:39 +01:00
scripts deps: update dependency hcloud to v1.33.2 (#439) 2024-01-03 12:00:33 +01:00
tests test: use testing framework for network integration tests (#448) 2024-02-02 13:42:18 +01:00
.ansible-lint test: use testing framework for network integration tests (#448) 2024-02-02 13:42:18 +01:00
.flake8 refactor: use f-strings (#310) 2023-08-24 11:27:40 +02:00
.gitignore feat: vendor hcloud python dependency (#244) 2023-07-11 11:15:08 +02:00
.gitlab-ci.yml ci: explicitly declare pre-commit job (#313) 2023-08-25 16:12:47 +02:00
.pre-commit-config.yaml deps: update pre-commit hook ansible/ansible-lint to v6.22.2 (#441) 2024-01-29 20:04:20 +01:00
CHANGELOG.rst chore(main): release 2.5.0 (#419) 2024-02-02 10:45:50 +01:00
COPYING refactor: prefer true/false over yes/no (#226) 2023-06-21 10:49:54 +02:00
galaxy.yml chore(main): release 2.5.0 (#419) 2024-02-02 10:45:50 +01:00
Makefile chore: enable docs rstcheck (#432) 2023-12-21 17:44:59 +01:00
pyproject.toml refactor: add future annotations imports (#398) 2023-11-23 14:53:10 +01:00
README.md refactor: start using new modules names (#393) 2023-11-21 09:40:11 +01:00
renovate.json chore: update renovate bot config (#355) 2023-10-12 10:16:48 +02:00
requirements.txt deps: update dependency antsibull-docs to >=2.7,<2.8 (#446) 2024-02-01 16:30:26 +01:00

Galaxy version GitHub version Build Status Codecov

Ansible Collection: hetzner.hcloud

Ansible Hetzner Cloud Collection for controlling your Hetzner Cloud Resources.

Python version compatibility

This collection depends on the hcloud library. Due to the hcloud Python Support Policy this collection requires Python 3.8 or greater.

Release notes

See here.

Release policy

The main branch is used for the development of the latest versions of the collections, and may contain breaking changes. The stable-* branches (e.g. stable-1 for the 1.x.y releases) are used to cut additional minor or patch releases if needed, but we do not provide official support for multiple versions of the collection.

Documentation

The documentation for all modules are available through ansible-doc.

Sample: ansible-doc hetzner.hcloud.server shows the documentation for the server module.

For all modules that were part of Ansible directly (before Ansible 2.11) we also have the documentation published in the Ansible documentation: https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/

Development

Requirements

You should place the collection (clone the repository) into the Ansible collection path. Normally this is ~/.ansible/collections/ansible_collections/<namespace>/<collection, so for our collection it would be: ~/.ansible/collections/ansible_collections/hetzner/hcloud.

git clone git@github.com:ansible-collections/hetzner.hcloud.git ~/.ansible/collections/ansible_collections/hetzner/hcloud

After this you just need ansible installed.

Testing

Testing is done via ansible-test. Make sure to have a cloud-config-hcloud.ini file in tests/integration which contains the hcloud API token:

[default]
hcloud_api_token=<token>

After this you should be able to use ansible-test integration to perform the integration tests for a specific module. Sample:

ansible-test integration --color --local  -vvv hetzner.hcloud.server // Executed all integration tests for server module

Releasing a new version

If there are releasable changes, release-please will open a PR on GitHub with the proposed version. When this PR is merged, release-please will tag the release.