diff --git a/docs/docsite/rst/common/images/credentials-create-hcloud-credential.png b/docs/docsite/rst/common/images/credentials-create-hcloud-credential.png new file mode 100644 index 000000000000..7fd4382a2540 Binary files /dev/null and b/docs/docsite/rst/common/images/credentials-create-hcloud-credential.png differ diff --git a/docs/docsite/rst/common/images/inventories-create-source-hcloud-example.png b/docs/docsite/rst/common/images/inventories-create-source-hcloud-example.png new file mode 100644 index 000000000000..ffe559f2ce61 Binary files /dev/null and b/docs/docsite/rst/common/images/inventories-create-source-hcloud-example.png differ diff --git a/docs/docsite/rst/userguide/credentials.rst b/docs/docsite/rst/userguide/credentials.rst index 38187fc2d495..04ac37fd3a59 100644 --- a/docs/docsite/rst/userguide/credentials.rst +++ b/docs/docsite/rst/userguide/credentials.rst @@ -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 ^^^^^^^^^^^ diff --git a/docs/docsite/rst/userguide/inventories.rst b/docs/docsite/rst/userguide/inventories.rst index a5a9e5df56e5..38725a528743 100644 --- a/docs/docsite/rst/userguide/inventories.rst +++ b/docs/docsite/rst/userguide/inventories.rst @@ -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 `. + +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 `__. + +|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 diff --git a/docs/docsite/rst/userguide/inventory_plugins_templates.rst b/docs/docsite/rst/userguide/inventory_plugins_templates.rst index 3fee4cd2529e..9923aab8ff1c 100644 --- a/docs/docsite/rst/userguide/inventory_plugins_templates.rst +++ b/docs/docsite/rst/userguide/inventory_plugins_templates.rst @@ -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: @@ -391,4 +405,4 @@ Red Hat Ansible Automation Platform include_metadata: true inventory_id: plugin: awx.awx.tower - validate_certs: \ No newline at end of file + validate_certs: diff --git a/docs/docsite/rst/userguide/overview.rst b/docs/docsite/rst/userguide/overview.rst index 3860be9eff6c..dcc6b6e0335e 100644 --- a/docs/docsite/rst/userguide/overview.rst +++ b/docs/docsite/rst/userguide/overview.rst @@ -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