1
0
Fork 0
mirror of https://github.com/ansible-collections/hetzner.hcloud.git synced 2026-02-04 08:01:49 +00:00
No description
Find a file
Amirhossein Shaerpour 4fc2003f30
feat: allow recreating ssh key when public key in the API does not match (#634)
##### SUMMARY

- Log a warning when the provided public key does not match one in the
API.
- When the public key does not match the one in the API, allow
recreating the SSH Key in the API using the ``force=true`` argument.


Closes: #578 

##### ISSUE TYPE
- Feature Pull Request

##### COMPONENT NAME
<!--- Write the short name of the module, plugin, task or feature below
-->
`ssh_key`

##### ADDITIONAL INFORMATION
In Hetzner API, we do not have any public_key change endpoint and only
updating names and labels are allowed.
For public_key The only way is removing and re-creating. `force` option
allows users to do re-creation if needed.

---------

Co-authored-by: jo <ljonas@riseup.net>
2025-06-03 17:43:54 +02:00
.azure-pipelines ci: fix missing jobs in summary (#614) 2025-03-21 14:58:37 +01:00
.github chore(main): release 5.0.1 (#638) 2025-05-21 17:48:04 +02:00
changelogs feat: allow recreating ssh key when public key in the API does not match (#634) 2025-06-03 17:43:54 +02:00
docs/docsite chore: replace deprecated server type with cx22 (#510) 2024-06-11 15:30:47 +02:00
examples feat: add new created state for idempotent server creation (#606) 2025-03-21 14:05:03 +01:00
meta feat!: drop support for ansible-core 2.16 (#612) 2025-03-21 14:51:58 +01:00
plugins feat: allow recreating ssh key when public key in the API does not match (#634) 2025-06-03 17:43:54 +02:00
scripts chore(deps): update dependency hcloud to v2.5.2 (#639) 2025-05-23 11:32:39 +02:00
tests feat: allow recreating ssh key when public key in the API does not match (#634) 2025-06-03 17:43:54 +02:00
.ansible-lint test: enable unsupported-version lint rule (#595) 2025-01-29 10:30:16 +00:00
.flake8 refactor: use f-strings (#310) 2023-08-24 11:27:40 +02:00
.gitignore chore: ignore .ansible dir (#618) 2025-03-25 16:44:32 +01:00
.gitlab-ci.yml ci: update gitlab ci config (#529) 2024-07-09 12:30:49 +02:00
.pre-commit-config.yaml chore(deps): update pre-commit hook ansible/ansible-lint to v25.5.0 (#642) 2025-05-26 10:36:39 +02:00
CHANGELOG.rst chore(main): release 5.0.1 (#638) 2025-05-21 17:48:04 +02:00
COPYING refactor: prefer true/false over yes/no (#226) 2023-06-21 10:49:54 +02:00
galaxy.yml chore(main): release 5.0.1 (#638) 2025-05-21 17:48:04 +02:00
Makefile chore: add dev target helper (#457) 2024-02-06 14:04:18 +01:00
pyproject.toml feat: drop support for python 3.8 (#615) 2025-03-21 15:10:23 +01:00
README.md feat: drop support for python 3.8 (#615) 2025-03-21 15:10:23 +01:00
renovate.json chore(config): migrate renovate config (#640) 2025-05-23 11:32:59 +02:00
requirements.txt chore(deps): update dependency antsibull-docs to >=2.17,<2.18 (#644) 2025-06-03 13:17:36 +02:00

Galaxy version GitHub version Build Status Codecov

Ansible Collection: hetzner.hcloud

Ansible Hetzner Cloud Collection for controlling your Hetzner Cloud Resources.

Communication

For more information about communication, see the Ansible communication guide.

Python version compatibility

This collection depends on the hcloud library. Due to the hcloud Python Support Policy this collection requires Python 3.9 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.