Skip to content

Commit

Permalink
docs: Add Hetzner Cloud Inventory documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Tom Siewert <[email protected]>
  • Loading branch information
tomsiewert authored and dmzoneill committed Feb 20, 2024
1 parent dd54fab commit b4fc91a
Show file tree
Hide file tree
Showing 6 changed files with 67 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/docsite/rst/userguide/credentials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,35 @@ HashiCorp Vault Signed SSH
This is considered part of the secret management capability. See :ref:`ug_credentials_hashivaultssh` for more detail.


Hetzner Cloud
^^^^^^^^^^^^^^^^

.. index::
pair: credential types; hcloud

Selecting this credential type enables synchronization of inventory with Hetzner Cloud.

AWX uses the following environment variables for Hetzner Cloudcredentials and are fields prompted in the user interface:

::

HCLOUD_TOKEN


|Credentials - create Hetzner Cloud credential|

.. |Credentials - create Hetzner Cloud credential| image:: ../common/images/credentials-create-hcloud-credential.png
:alt: Credentials - create Hetzner Cloud credential form

Hetzner Cloud credentials have the following inputs that are required:

- **API Token**: The API token of the project.

.. note::

It is recommended to use a read-only API token.


Insights
^^^^^^^^^^^

Expand Down
22 changes: 22 additions & 0 deletions docs/docsite/rst/userguide/inventories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1084,6 +1084,28 @@ Red Hat Ansible Automation Platform

4. Use the **Source Variables** field to override variables used by the ``controller`` inventory plugin. Enter variables using either JSON or YAML syntax. Use the radio button to toggle between the two.


.. _ug_source_hcloud:

Hetzner Cloud
~~~~~~~~~~~~~~~~

.. index::
pair: inventories; Hetzner Cloud


1. To configure a HCloud-sourced inventory, select **Hetzner Cloud** from the Source field.

2. The Create Source window expands with the required **Credential** field. Choose from an existing Hetzner Cloud Credential. For more information, refer to :ref:`ug_credentials`.

3. You can optionally specify the verbosity, host filter, enabled variable/value, and update options as described in the main procedure for :ref:`adding a source <ug_add_inv_common_fields>`.

4. Use the **Source Variables** field to override variables used by the ``hcloud`` inventory plugin. Enter variables using either JSON or YAML syntax. Use the radio button to toggle between the two. For a detailed description of these variables, view the `hcloud inventory plugin <https://github.com/ansible-collections/hetzner.hcloud/blob/main/plugins/inventory/hcloud.py>`__.

|Inventories - create source - Hetzner Cloud example|

.. |Inventories - create source - Hetzner Cloud example| image:: ../common/images/inventories-create-source-hcloud-example.png

.. _ug_customscripts:

Export old inventory scripts
Expand Down
16 changes: 15 additions & 1 deletion docs/docsite/rst/userguide/inventory_plugins_templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,20 @@ VMware vCenter
strict: false
with_nested_properties: true

Hetzner Cloud
--------------

.. index::
pair: inventories; Hetzner Cloud
pair: inventories; hcloud
pair: inventory plugins; hcloud

::

plugin: hetzner.hcloud.hcloud
locations:
- nbg1


.. _ir_plugin_satellite:

Expand Down Expand Up @@ -391,4 +405,4 @@ Red Hat Ansible Automation Platform
include_metadata: true
inventory_id: <inventory_id or url_quoted_named_url>
plugin: awx.awx.tower
validate_certs: <true or false>
validate_certs: <true or false>
1 change: 1 addition & 0 deletions docs/docsite/rst/userguide/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ Updated AWX to use the following inventory plugins from upstream collections if
- openstack.cloud.openstack
- ovirt.ovirt.ovirt
- awx.awx.tower
- hetzner.hcloud.hcloud


Secret Management System
Expand Down

0 comments on commit b4fc91a

Please sign in to comment.