Skip to content

Commit

Permalink
Merge pull request #55 from opsmill/develop
Browse files Browse the repository at this point in the history
Release
  • Loading branch information
fatih-acar authored Apr 29, 2024
2 parents ae28dd3 + 66c8ea5 commit 06c42a6
Show file tree
Hide file tree
Showing 18 changed files with 2,069 additions and 1,363 deletions.
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,5 @@ docs/_build/*
.python-version
.DS_Store

# Until present in a package
infrahub

# https://github.com/ansible/ansible/issues/68499
# ansible_collections/
# ansible_collections/
88 changes: 49 additions & 39 deletions docs/plugins/artifact_fetch_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,34 @@
.. |antsibull-internal-nbsp| unicode:: 0xA0
:trim:

.. meta::
:antsibull-docs: 2.10.0
.. role:: ansible-attribute-support-label
.. role:: ansible-attribute-support-property
.. role:: ansible-attribute-support-full
.. role:: ansible-attribute-support-partial
.. role:: ansible-attribute-support-none
.. role:: ansible-attribute-support-na
.. role:: ansible-option-type
.. role:: ansible-option-elements
.. role:: ansible-option-required
.. role:: ansible-option-versionadded
.. role:: ansible-option-aliases
.. role:: ansible-option-choices
.. role:: ansible-option-choices-default-mark
.. role:: ansible-option-default-bold
.. role:: ansible-option-configuration
.. role:: ansible-option-returned-bold
.. role:: ansible-option-sample-bold

.. Anchors
.. _ansible_collections.opsmill.infrahub.artifact_fetch_module:

.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
opsmill.infrahub.artifact_fetch module -- Fetch the content of an artifact from Infrahub
Expand All @@ -23,10 +42,7 @@ opsmill.infrahub.artifact_fetch module -- Fetch the content of an artifact from
.. Collection note
.. note::
This module is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.0.4).

It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
This module is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/opsmill/infrahub>`_ (version 1.0.4).

To install it, use: :code:`ansible-galaxy collection install opsmill.infrahub`.
You need further requirements to be able to use this module,
Expand Down Expand Up @@ -80,13 +96,13 @@ The below requirements are needed on the host that executes this module.
Parameters
----------

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. rst-class:: ansible-option-table

.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
:class: longtable ansible-option-table

* - Parameter
- Comments
Expand All @@ -106,9 +122,9 @@ Parameters

<a class="ansibleOptionLink" href="#parameter-api_endpoint" title="Permalink to this option"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`string`
:ansible-option-type:`string`

.. raw:: html

Expand Down Expand Up @@ -140,9 +156,9 @@ Parameters

<a class="ansibleOptionLink" href="#parameter-artifact_name" title="Permalink to this option"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`string` / :ansible-option-required:`required`
:ansible-option-type:`string` / :ansible-option-required:`required`

.. raw:: html

Expand Down Expand Up @@ -174,9 +190,9 @@ Parameters

<a class="ansibleOptionLink" href="#parameter-branch" title="Permalink to this option"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`string`
:ansible-option-type:`string`

.. raw:: html

Expand Down Expand Up @@ -212,9 +228,9 @@ Parameters

<a class="ansibleOptionLink" href="#parameter-target_id" title="Permalink to this option"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`string` / :ansible-option-required:`required`
:ansible-option-type:`string` / :ansible-option-required:`required`

.. raw:: html

Expand Down Expand Up @@ -246,9 +262,9 @@ Parameters

<a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`integer`
:ansible-option-type:`integer`

.. raw:: html

Expand Down Expand Up @@ -284,9 +300,9 @@ Parameters

<a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`string`
:ansible-option-type:`string`

.. raw:: html

Expand Down Expand Up @@ -318,9 +334,9 @@ Parameters

<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`boolean`
:ansible-option-type:`boolean`

.. raw:: html

Expand Down Expand Up @@ -395,13 +411,12 @@ Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}
.. rst-class:: ansible-option-table

.. list-table::
:width: 100%
:widths: auto
:header-rows: 1
:class: longtable ansible-option-table

* - Key
- Description
Expand All @@ -421,9 +436,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll

<a class="ansibleOptionLink" href="#return-json" title="Permalink to this return value"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`dictionary`
:ansible-option-type:`dictionary`

.. raw:: html

Expand Down Expand Up @@ -461,9 +476,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll

<a class="ansibleOptionLink" href="#return-text" title="Permalink to this return value"></a>

.. ansible-option-type-line::
.. rst-class:: ansible-option-type-line

:ansible-option-type:`string`
:ansible-option-type:`string`

.. raw:: html

Expand Down Expand Up @@ -504,18 +519,13 @@ Authors
Collection links
~~~~~~~~~~~~~~~~

.. ansible-links::

- title: "Issue Tracker"
url: "https://github.com/opsmill/infrahub-ansible/issues"
external: true
- title: "Homepage"
url: "https://www.opsmill.com/"
external: true
- title: "Repository (Sources)"
url: "https://github.com/opsmill/infrahub-ansible"
external: true
.. raw:: html

<p class="ansible-links">
<a href="https://github.com/opsmill/infrahub-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://www.opsmill.com/" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
<a href="https://github.com/opsmill/infrahub-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
</p>

.. Parsing errors
13 changes: 5 additions & 8 deletions docs/plugins/environment_variables.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@

:orphan:

.. meta::
:antsibull-docs: 2.10.0

.. _list_of_collection_env_vars:

Index of all Collection Environment Variables
Expand All @@ -17,18 +14,18 @@ Environment variables used by the ansible-core configuration are documented in :
Merge extra vars into the available variables for composition (highest precedence).

*Used by:*
:ansplugin:`opsmill.infrahub.inventory inventory plugin <opsmill.infrahub.inventory#inventory>`
:ref:`opsmill.infrahub.inventory inventory plugin <ansible_collections.opsmill.infrahub.inventory_inventory>`
.. envvar:: INFRAHUB_API

Endpoint of the Infrahub API

*Used by:*
:ansplugin:`opsmill.infrahub.inventory inventory plugin <opsmill.infrahub.inventory#inventory>`,
:ansplugin:`opsmill.infrahub.lookup lookup plugin <opsmill.infrahub.lookup#lookup>`
:ref:`opsmill.infrahub.inventory inventory plugin <ansible_collections.opsmill.infrahub.inventory_inventory>`,
:ref:`opsmill.infrahub.lookup lookup plugin <ansible_collections.opsmill.infrahub.lookup_lookup>`
.. envvar:: INFRAHUB_TOKEN

Infrahub API token to be able to read against Infrahub.

*Used by:*
:ansplugin:`opsmill.infrahub.inventory inventory plugin <opsmill.infrahub.inventory#inventory>`,
:ansplugin:`opsmill.infrahub.lookup lookup plugin <opsmill.infrahub.lookup#lookup>`
:ref:`opsmill.infrahub.inventory inventory plugin <ansible_collections.opsmill.infrahub.inventory_inventory>`,
:ref:`opsmill.infrahub.lookup lookup plugin <ansible_collections.opsmill.infrahub.lookup_lookup>`
42 changes: 24 additions & 18 deletions docs/plugins/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@


.. meta::
:antsibull-docs: 2.10.0


.. _plugins_in_opsmill.infrahub:

Expand All @@ -28,24 +25,20 @@ This is a collection of Infrahub Ansible modules

* 2.14.0 or newer

.. ansible-links::

- title: "Issue Tracker"
url: "https://github.com/opsmill/infrahub-ansible/issues"
external: true
- title: "Homepage"
url: "https://www.opsmill.com/"
external: true
- title: "Repository (Sources)"
url: "https://github.com/opsmill/infrahub-ansible"
external: true
.. raw:: html

<p class="ansible-links">
<a href="https://github.com/opsmill/infrahub-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
<a href="https://www.opsmill.com/" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
<a href="https://github.com/opsmill/infrahub-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
</p>



.. toctree::
:maxdepth: 1


Plugin Index
------------

Expand All @@ -55,8 +48,8 @@ These are the plugins in the opsmill.infrahub collection:
Modules
~~~~~~~

* :ansplugin:`artifact_fetch module <opsmill.infrahub.artifact_fetch#module>` -- Fetch the content of an artifact from Infrahub
* :ansplugin:`query_graphql module <opsmill.infrahub.query_graphql#module>` -- Queries and returns elements from Infrahub GraphQL API
* :ref:`artifact_fetch module <ansible_collections.opsmill.infrahub.artifact_fetch_module>` -- Fetch the content of an artifact from Infrahub
* :ref:`query_graphql module <ansible_collections.opsmill.infrahub.query_graphql_module>` -- Queries and returns elements from Infrahub GraphQL API

.. toctree::
:maxdepth: 1
Expand All @@ -69,7 +62,7 @@ Modules
Inventory Plugins
~~~~~~~~~~~~~~~~~

* :ansplugin:`inventory inventory <opsmill.infrahub.inventory#inventory>` -- Infrahub inventory source (using GraphQL)
* :ref:`inventory inventory <ansible_collections.opsmill.infrahub.inventory_inventory>` -- Infrahub inventory source (using GraphQL)

.. toctree::
:maxdepth: 1
Expand All @@ -81,7 +74,7 @@ Inventory Plugins
Lookup Plugins
~~~~~~~~~~~~~~

* :ansplugin:`lookup lookup <opsmill.infrahub.lookup#lookup>` -- Queries and returns elements from Infrahub (using GraphQL)
* :ref:`lookup lookup <ansible_collections.opsmill.infrahub.lookup_lookup>` -- Queries and returns elements from Infrahub (using GraphQL)

.. toctree::
:maxdepth: 1
Expand All @@ -90,3 +83,16 @@ Lookup Plugins
lookup_lookup


Role Index
----------

These are the roles in the opsmill.infrahub collection:

* :ref:`install role <ansible_collections.opsmill.infrahub.install_role>` -- Install Infrahub

.. toctree::
:maxdepth: 1
:hidden:

install_role

Loading

0 comments on commit 06c42a6

Please sign in to comment.