From 12336f7b7502da690194a58d6069a5790e65d5ed Mon Sep 17 00:00:00 2001 From: opsmill-bot Date: Mon, 29 Apr 2024 16:07:02 +0000 Subject: [PATCH 01/10] chore: update pyproject.toml & galaxy.yml --- galaxy.yml | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/galaxy.yml b/galaxy.yml index 69e0b1e..ab8ddb9 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -10,7 +10,7 @@ namespace: opsmill name: infrahub # The version of the collection. Must be compatible with semantic versioning -version: 1.0.4 +version: 1.0.5 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/pyproject.toml b/pyproject.toml index 693433b..b5f336c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "infrahub_ansible_modules" -version = "1.0.4" +version = "1.0.5" description = "Ansible collection to interact with Infrahub's API" authors = ["OpsMill "] license = "GPLv3" From e9b600c668f2080b7f783f78cc4d57dd5381c603 Mon Sep 17 00:00:00 2001 From: opsmill-bot Date: Mon, 29 Apr 2024 16:09:51 +0000 Subject: [PATCH 02/10] chore: update changelog & docs --- CHANGELOG.rst | 3 + changelogs/changelog.yaml | 2 + docs/plugins/artifact_fetch_module.rst | 88 ++++---- docs/plugins/environment_variables.rst | 13 +- docs/plugins/index.rst | 31 +-- docs/plugins/install_role.rst | 80 ++++---- docs/plugins/inventory_inventory.rst | 271 +++++++++++++++---------- docs/plugins/lookup_lookup.rst | 89 ++++---- docs/plugins/query_graphql_module.rst | 88 ++++---- 9 files changed, 357 insertions(+), 308 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index f5a45c4..3f470af 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,9 @@ Opmisll.Infrahub Release Notes .. contents:: Topics +v1.0.5 +====== + v1.0.4 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 4cd609b..5165855 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -41,3 +41,5 @@ releases: release_date: '2024-02-27' 1.0.4: release_date: '2024-04-24' + 1.0.5: + release_date: '2024-04-29' diff --git a/docs/plugins/artifact_fetch_module.rst b/docs/plugins/artifact_fetch_module.rst index ab6a894..5f098e7 100644 --- a/docs/plugins/artifact_fetch_module.rst +++ b/docs/plugins/artifact_fetch_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. 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 +.. meta:: + :antsibull-docs: 2.10.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title opsmill.infrahub.artifact_fetch module -- Fetch the content of an artifact from Infrahub @@ -42,7 +23,10 @@ opsmill.infrahub.artifact_fetch module -- Fetch the content of an artifact from .. Collection note .. note:: - This module is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This module is part of the `opsmill.infrahub collection `_ (version 1.0.4). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install opsmill.infrahub`. You need further requirements to be able to use this module, @@ -96,13 +80,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -122,9 +106,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -156,9 +140,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -190,9 +174,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -228,9 +212,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -262,9 +246,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html @@ -300,9 +284,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -334,9 +318,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html @@ -411,12 +395,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -436,9 +421,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -476,9 +461,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -519,13 +504,18 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. 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 -

- Issue Tracker - Homepage - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/environment_variables.rst b/docs/plugins/environment_variables.rst index 7c1a75a..050a04c 100644 --- a/docs/plugins/environment_variables.rst +++ b/docs/plugins/environment_variables.rst @@ -1,6 +1,9 @@ :orphan: +.. meta:: + :antsibull-docs: 2.10.0 + .. _list_of_collection_env_vars: Index of all Collection Environment Variables @@ -14,18 +17,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:* - :ref:`opsmill.infrahub.inventory inventory plugin ` + :ansplugin:`opsmill.infrahub.inventory inventory plugin ` .. envvar:: INFRAHUB_API Endpoint of the Infrahub API *Used by:* - :ref:`opsmill.infrahub.inventory inventory plugin `, - :ref:`opsmill.infrahub.lookup lookup plugin ` + :ansplugin:`opsmill.infrahub.inventory inventory plugin `, + :ansplugin:`opsmill.infrahub.lookup lookup plugin ` .. envvar:: INFRAHUB_TOKEN Infrahub API token to be able to read against Infrahub. *Used by:* - :ref:`opsmill.infrahub.inventory inventory plugin `, - :ref:`opsmill.infrahub.lookup lookup plugin ` + :ansplugin:`opsmill.infrahub.inventory inventory plugin `, + :ansplugin:`opsmill.infrahub.lookup lookup plugin ` diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 25fd86b..e71a6c5 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -1,5 +1,8 @@ +.. meta:: + :antsibull-docs: 2.10.0 + .. _plugins_in_opsmill.infrahub: @@ -25,20 +28,24 @@ This is a collection of Infrahub Ansible modules * 2.14.0 or newer -.. raw:: html +.. 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 -

- Issue Tracker - Homepage - Repository (Sources) -

.. toctree:: :maxdepth: 1 - Plugin Index ------------ @@ -48,8 +55,8 @@ These are the plugins in the opsmill.infrahub collection: Modules ~~~~~~~ -* :ref:`artifact_fetch module ` -- Fetch the content of an artifact from Infrahub -* :ref:`query_graphql module ` -- Queries and returns elements from Infrahub GraphQL API +* :ansplugin:`artifact_fetch module ` -- Fetch the content of an artifact from Infrahub +* :ansplugin:`query_graphql module ` -- Queries and returns elements from Infrahub GraphQL API .. toctree:: :maxdepth: 1 @@ -62,7 +69,7 @@ Modules Inventory Plugins ~~~~~~~~~~~~~~~~~ -* :ref:`inventory inventory ` -- Infrahub inventory source (using GraphQL) +* :ansplugin:`inventory inventory ` -- Infrahub inventory source (using GraphQL) .. toctree:: :maxdepth: 1 @@ -74,7 +81,7 @@ Inventory Plugins Lookup Plugins ~~~~~~~~~~~~~~ -* :ref:`lookup lookup ` -- Queries and returns elements from Infrahub (using GraphQL) +* :ansplugin:`lookup lookup ` -- Queries and returns elements from Infrahub (using GraphQL) .. toctree:: :maxdepth: 1 @@ -88,7 +95,7 @@ Role Index These are the roles in the opsmill.infrahub collection: -* :ref:`install role ` -- Install Infrahub +* :ansplugin:`install role ` -- Install Infrahub .. toctree:: :maxdepth: 1 diff --git a/docs/plugins/install_role.rst b/docs/plugins/install_role.rst index f47bda1..9c613a8 100644 --- a/docs/plugins/install_role.rst +++ b/docs/plugins/install_role.rst @@ -3,22 +3,16 @@ :orphan: -.. 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 +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.10.0 .. Anchors .. _ansible_collections.opsmill.infrahub.install_role: -.. Anchors: aliases - - .. Title opsmill.infrahub.install role -- Install Infrahub @@ -27,7 +21,10 @@ opsmill.infrahub.install role -- Install Infrahub .. Collection note .. note:: - This role is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This role is part of the `opsmill.infrahub collection `_ (version 1.0.4). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it use: :code:`ansible-galaxy collection install opsmill.infrahub`. @@ -65,12 +62,13 @@ Synopsis Parameters ^^^^^^^^^^ -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -90,9 +88,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` @@ -127,9 +125,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -168,9 +166,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -213,9 +211,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -254,9 +252,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -299,9 +297,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -340,9 +338,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -383,9 +381,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -424,9 +422,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -449,6 +447,9 @@ Parameters +.. Attributes + + .. Notes @@ -462,13 +463,18 @@ Parameters Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. 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 -

- Issue Tracker - Homepage - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/inventory_inventory.rst b/docs/plugins/inventory_inventory.rst index 1c0670c..d5b5ec4 100644 --- a/docs/plugins/inventory_inventory.rst +++ b/docs/plugins/inventory_inventory.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. 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 +.. meta:: + :antsibull-docs: 2.10.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title opsmill.infrahub.inventory inventory -- Infrahub inventory source (using GraphQL) @@ -42,7 +23,10 @@ opsmill.infrahub.inventory inventory -- Infrahub inventory source (using GraphQL .. Collection note .. note:: - This inventory plugin is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This inventory plugin is part of the `opsmill.infrahub collection `_ (version 1.0.4). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install opsmill.infrahub`. @@ -81,13 +65,13 @@ Synopsis Parameters ---------- - -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -107,9 +91,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -151,9 +135,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -192,9 +176,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -252,9 +236,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -313,9 +297,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -378,9 +362,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -406,21 +390,6 @@ Parameters - INI entries: - .. code-block:: - - [default] - fact_caching_prefix = ansible_inventory_ - - - Removed in: version 2.16 of ansible.builtin - - - Why: Fixes typing error in INI section name - - Alternative: Use the 'defaults' section instead - - - .. code-block:: [defaults] @@ -458,9 +427,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` @@ -523,9 +492,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` @@ -564,9 +533,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` @@ -605,9 +574,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` @@ -638,6 +607,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-keyed_groups/default_value: .. rst-class:: ansible-option-title @@ -648,9 +621,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` :ansible-option-versionadded:`added in ansible-core 2.12` @@ -662,13 +635,17 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
The default value when the host variable's value is an empty string. - This option is mutually exclusive with \ :literal:`trailing\_separator`\ . + This option is mutually exclusive with \ :ansopt:`opsmill.infrahub.inventory#inventory:keyed\_groups[].trailing\_separator`\ . .. raw:: html @@ -680,6 +657,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-keyed_groups/key: .. rst-class:: ansible-option-title @@ -690,9 +671,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -701,6 +682,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -717,6 +702,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-keyed_groups/parent_group: .. rst-class:: ansible-option-title @@ -727,9 +716,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -738,6 +727,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -754,6 +747,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-keyed_groups/prefix: .. rst-class:: ansible-option-title @@ -764,9 +761,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -775,6 +772,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -795,6 +796,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-keyed_groups/separator: .. rst-class:: ansible-option-title @@ -805,9 +810,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -816,6 +821,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -836,6 +845,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-keyed_groups/trailing_separator: .. rst-class:: ansible-option-title @@ -846,9 +859,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in ansible-core 2.12` @@ -860,13 +873,17 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
- Set this option to \ :emphasis:`False`\ to omit the \ :literal:`separator`\ after the host variable when the value is an empty string. + Set this option to \ :ansval:`False`\ to omit the \ :ansopt:`opsmill.infrahub.inventory#inventory:keyed\_groups[].separator`\ after the host variable when the value is an empty string. - This option is mutually exclusive with \ :literal:`default\_value`\ . + This option is mutually exclusive with \ :ansopt:`opsmill.infrahub.inventory#inventory:keyed\_groups[].default\_value`\ . .. rst-class:: ansible-option-line @@ -897,9 +914,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in ansible-core 2.11` @@ -955,9 +972,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` / :ansible-option-required:`required` + :ansible-option-type:`dictionary` / :ansible-option-required:`required` @@ -984,6 +1001,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-nodes/node_type: .. rst-class:: ansible-option-title @@ -994,9 +1015,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` @@ -1005,6 +1026,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1023,6 +1048,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-nodes/node_type/exclude: .. rst-class:: ansible-option-title @@ -1033,9 +1062,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` @@ -1044,6 +1073,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1064,6 +1097,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-nodes/node_type/filters: .. rst-class:: ansible-option-title @@ -1074,9 +1111,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` @@ -1085,6 +1122,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1105,6 +1146,10 @@ Parameters
+ .. raw:: latex + + \hspace{0.04\textwidth}\begin{minipage}[t]{0.28\textwidth} + .. _ansible_collections.opsmill.infrahub.inventory_inventory__parameter-nodes/node_type/include: .. rst-class:: ansible-option-title @@ -1115,9 +1160,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` @@ -1126,6 +1171,10 @@ Parameters
+ .. raw:: latex + + \end{minipage} + - .. raw:: html
@@ -1158,9 +1207,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -1202,9 +1251,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` @@ -1217,7 +1266,7 @@ Parameters
- If \ :literal:`yes`\ make invalid entries a fatal error, otherwise skip and continue. + If \ :ansval:`yes`\ make invalid entries a fatal error, otherwise skip and continue. Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. @@ -1249,9 +1298,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` @@ -1290,9 +1339,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -1334,9 +1383,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` :ansible-option-versionadded:`added in ansible-core 2.11` @@ -1397,9 +1446,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -1491,12 +1540,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this inventory: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -1516,9 +1566,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html @@ -1561,13 +1611,18 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. 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 -

- Issue Tracker - Homepage - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/lookup_lookup.rst b/docs/plugins/lookup_lookup.rst index 8e9dbde..0b28fec 100644 --- a/docs/plugins/lookup_lookup.rst +++ b/docs/plugins/lookup_lookup.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. 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 +.. meta:: + :antsibull-docs: 2.10.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title opsmill.infrahub.lookup lookup -- Queries and returns elements from Infrahub (using GraphQL) @@ -42,7 +23,10 @@ opsmill.infrahub.lookup lookup -- Queries and returns elements from Infrahub (us .. Collection note .. note:: - This lookup plugin is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This lookup plugin is part of the `opsmill.infrahub collection `_ (version 1.0.4). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install opsmill.infrahub`. @@ -78,16 +62,19 @@ Synopsis .. Options -Parameters ----------- +Keyword parameters +------------------ +This describes keyword parameters of the lookup. These are the values ``key1=value1``, ``key2=value2`` and so on in the following +examples: ``lookup('opsmill.infrahub.lookup', key1=value1, key2=value2, ...)`` and ``query('opsmill.infrahub.lookup', key1=value1, key2=value2, ...)`` -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -107,9 +94,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -151,9 +138,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -192,9 +179,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` @@ -233,9 +220,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -270,9 +257,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` @@ -311,9 +298,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` @@ -355,9 +342,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` @@ -438,12 +425,13 @@ Examples Return Value ------------ -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -463,9 +451,9 @@ Return Value - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -508,13 +496,18 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. 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 -

- Issue Tracker - Homepage - Repository (Sources) -

.. Parsing errors diff --git a/docs/plugins/query_graphql_module.rst b/docs/plugins/query_graphql_module.rst index a288178..a8f8ae8 100644 --- a/docs/plugins/query_graphql_module.rst +++ b/docs/plugins/query_graphql_module.rst @@ -6,23 +6,8 @@ .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: -.. 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 +.. meta:: + :antsibull-docs: 2.10.0 .. Anchors @@ -30,10 +15,6 @@ .. Anchors: short name for ansible.builtin -.. Anchors: aliases - - - .. Title opsmill.infrahub.query_graphql module -- Queries and returns elements from Infrahub GraphQL API @@ -42,7 +23,10 @@ opsmill.infrahub.query_graphql module -- Queries and returns elements from Infra .. Collection note .. note:: - This module is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This module is part of the `opsmill.infrahub collection `_ (version 1.0.4). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install opsmill.infrahub`. You need further requirements to be able to use this module, @@ -96,13 +80,13 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Parameter - Comments @@ -122,9 +106,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -156,9 +140,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -194,9 +178,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -232,9 +216,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` / :ansible-option-required:`required` + :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html @@ -266,9 +250,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`integer` + :ansible-option-type:`integer` .. raw:: html @@ -304,9 +288,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`string` .. raw:: html @@ -338,9 +322,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html @@ -380,9 +364,9 @@ Parameters - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`boolean` + :ansible-option-type:`boolean` .. raw:: html @@ -467,12 +451,13 @@ Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: -.. rst-class:: ansible-option-table +.. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 + :class: longtable ansible-option-table * - Key - Description @@ -492,9 +477,9 @@ Common return values are documented :ref:`here `, the foll - .. rst-class:: ansible-option-type-line + .. ansible-option-type-line:: - :ansible-option-type:`dictionary` + :ansible-option-type:`dictionary` .. raw:: html @@ -535,13 +520,18 @@ Authors Collection links ~~~~~~~~~~~~~~~~ -.. raw:: html +.. 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 -

- Issue Tracker - Homepage - Repository (Sources) -

.. Parsing errors From 676f68635f646d8da455b60f1f8609d634543388 Mon Sep 17 00:00:00 2001 From: opsmill-bot Date: Mon, 29 Apr 2024 19:47:00 +0000 Subject: [PATCH 03/10] chore: update pyproject.toml & galaxy.yml --- galaxy.yml | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/galaxy.yml b/galaxy.yml index ab8ddb9..754d472 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -10,7 +10,7 @@ namespace: opsmill name: infrahub # The version of the collection. Must be compatible with semantic versioning -version: 1.0.5 +version: 1.0.6 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/pyproject.toml b/pyproject.toml index b5f336c..4f54a0d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "infrahub_ansible_modules" -version = "1.0.5" +version = "1.0.6" description = "Ansible collection to interact with Infrahub's API" authors = ["OpsMill "] license = "GPLv3" From 32be65d50adbcdf618d762e5649fa76fae7d7d10 Mon Sep 17 00:00:00 2001 From: opsmill-bot Date: Mon, 29 Apr 2024 19:48:47 +0000 Subject: [PATCH 04/10] chore: update changelog & docs --- CHANGELOG.rst | 3 +++ changelogs/changelog.yaml | 2 ++ docs/plugins/artifact_fetch_module.rst | 2 +- docs/plugins/index.rst | 2 +- docs/plugins/install_role.rst | 2 +- docs/plugins/inventory_inventory.rst | 2 +- docs/plugins/lookup_lookup.rst | 2 +- docs/plugins/query_graphql_module.rst | 2 +- 8 files changed, 11 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3f470af..3a3c6f2 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,9 @@ Opmisll.Infrahub Release Notes .. contents:: Topics +v1.0.6 +====== + v1.0.5 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 5165855..893049d 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -43,3 +43,5 @@ releases: release_date: '2024-04-24' 1.0.5: release_date: '2024-04-29' + 1.0.6: + release_date: '2024-04-29' diff --git a/docs/plugins/artifact_fetch_module.rst b/docs/plugins/artifact_fetch_module.rst index 5f098e7..7f366df 100644 --- a/docs/plugins/artifact_fetch_module.rst +++ b/docs/plugins/artifact_fetch_module.rst @@ -23,7 +23,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 `_ (version 1.0.4). + This module is part of the `opsmill.infrahub collection `_ (version 1.0.5). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index e71a6c5..9733524 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -9,7 +9,7 @@ Opsmill.Infrahub ================ -Collection version 1.0.4 +Collection version 1.0.5 .. contents:: :local: diff --git a/docs/plugins/install_role.rst b/docs/plugins/install_role.rst index 9c613a8..40d694e 100644 --- a/docs/plugins/install_role.rst +++ b/docs/plugins/install_role.rst @@ -21,7 +21,7 @@ opsmill.infrahub.install role -- Install Infrahub .. Collection note .. note:: - This role is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This role is part of the `opsmill.infrahub collection `_ (version 1.0.5). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. diff --git a/docs/plugins/inventory_inventory.rst b/docs/plugins/inventory_inventory.rst index d5b5ec4..6c7e684 100644 --- a/docs/plugins/inventory_inventory.rst +++ b/docs/plugins/inventory_inventory.rst @@ -23,7 +23,7 @@ opsmill.infrahub.inventory inventory -- Infrahub inventory source (using GraphQL .. Collection note .. note:: - This inventory plugin is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This inventory plugin is part of the `opsmill.infrahub collection `_ (version 1.0.5). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. diff --git a/docs/plugins/lookup_lookup.rst b/docs/plugins/lookup_lookup.rst index 0b28fec..4b37587 100644 --- a/docs/plugins/lookup_lookup.rst +++ b/docs/plugins/lookup_lookup.rst @@ -23,7 +23,7 @@ opsmill.infrahub.lookup lookup -- Queries and returns elements from Infrahub (us .. Collection note .. note:: - This lookup plugin is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This lookup plugin is part of the `opsmill.infrahub collection `_ (version 1.0.5). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. diff --git a/docs/plugins/query_graphql_module.rst b/docs/plugins/query_graphql_module.rst index a8f8ae8..9d8bd23 100644 --- a/docs/plugins/query_graphql_module.rst +++ b/docs/plugins/query_graphql_module.rst @@ -23,7 +23,7 @@ opsmill.infrahub.query_graphql module -- Queries and returns elements from Infra .. Collection note .. note:: - This module is part of the `opsmill.infrahub collection `_ (version 1.0.4). + This module is part of the `opsmill.infrahub collection `_ (version 1.0.5). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. From 11f31e3738913b0fdf2f1368a8ca845f2dbff3b8 Mon Sep 17 00:00:00 2001 From: opsmill-bot Date: Tue, 30 Apr 2024 07:32:37 +0000 Subject: [PATCH 05/10] chore: update pyproject.toml & galaxy.yml --- galaxy.yml | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/galaxy.yml b/galaxy.yml index 754d472..1a0da03 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -10,7 +10,7 @@ namespace: opsmill name: infrahub # The version of the collection. Must be compatible with semantic versioning -version: 1.0.6 +version: 1.0.7 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/pyproject.toml b/pyproject.toml index 4f54a0d..a38dc95 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "infrahub_ansible_modules" -version = "1.0.6" +version = "1.0.7" description = "Ansible collection to interact with Infrahub's API" authors = ["OpsMill "] license = "GPLv3" From 756fa9705e74aee0edf568a3f9b5662187900918 Mon Sep 17 00:00:00 2001 From: opsmill-bot Date: Tue, 30 Apr 2024 07:35:47 +0000 Subject: [PATCH 06/10] chore: update changelog & docs --- CHANGELOG.rst | 3 +++ changelogs/changelog.yaml | 2 ++ docs/plugins/artifact_fetch_module.rst | 2 +- docs/plugins/index.rst | 2 +- docs/plugins/install_role.rst | 2 +- docs/plugins/inventory_inventory.rst | 2 +- docs/plugins/lookup_lookup.rst | 2 +- docs/plugins/query_graphql_module.rst | 2 +- 8 files changed, 11 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3a3c6f2..34efb6a 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,9 @@ Opmisll.Infrahub Release Notes .. contents:: Topics +v1.0.7 +====== + v1.0.6 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 893049d..c077848 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -45,3 +45,5 @@ releases: release_date: '2024-04-29' 1.0.6: release_date: '2024-04-29' + 1.0.7: + release_date: '2024-04-30' diff --git a/docs/plugins/artifact_fetch_module.rst b/docs/plugins/artifact_fetch_module.rst index 7f366df..bb0ca87 100644 --- a/docs/plugins/artifact_fetch_module.rst +++ b/docs/plugins/artifact_fetch_module.rst @@ -23,7 +23,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 `_ (version 1.0.5). + This module is part of the `opsmill.infrahub collection `_ (version 1.0.6). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 9733524..57e5fc9 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -9,7 +9,7 @@ Opsmill.Infrahub ================ -Collection version 1.0.5 +Collection version 1.0.6 .. contents:: :local: diff --git a/docs/plugins/install_role.rst b/docs/plugins/install_role.rst index 40d694e..2e40691 100644 --- a/docs/plugins/install_role.rst +++ b/docs/plugins/install_role.rst @@ -21,7 +21,7 @@ opsmill.infrahub.install role -- Install Infrahub .. Collection note .. note:: - This role is part of the `opsmill.infrahub collection `_ (version 1.0.5). + This role is part of the `opsmill.infrahub collection `_ (version 1.0.6). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. diff --git a/docs/plugins/inventory_inventory.rst b/docs/plugins/inventory_inventory.rst index 6c7e684..54db1ee 100644 --- a/docs/plugins/inventory_inventory.rst +++ b/docs/plugins/inventory_inventory.rst @@ -23,7 +23,7 @@ opsmill.infrahub.inventory inventory -- Infrahub inventory source (using GraphQL .. Collection note .. note:: - This inventory plugin is part of the `opsmill.infrahub collection `_ (version 1.0.5). + This inventory plugin is part of the `opsmill.infrahub collection `_ (version 1.0.6). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. diff --git a/docs/plugins/lookup_lookup.rst b/docs/plugins/lookup_lookup.rst index 4b37587..293379a 100644 --- a/docs/plugins/lookup_lookup.rst +++ b/docs/plugins/lookup_lookup.rst @@ -23,7 +23,7 @@ opsmill.infrahub.lookup lookup -- Queries and returns elements from Infrahub (us .. Collection note .. note:: - This lookup plugin is part of the `opsmill.infrahub collection `_ (version 1.0.5). + This lookup plugin is part of the `opsmill.infrahub collection `_ (version 1.0.6). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. diff --git a/docs/plugins/query_graphql_module.rst b/docs/plugins/query_graphql_module.rst index 9d8bd23..b26963a 100644 --- a/docs/plugins/query_graphql_module.rst +++ b/docs/plugins/query_graphql_module.rst @@ -23,7 +23,7 @@ opsmill.infrahub.query_graphql module -- Queries and returns elements from Infra .. Collection note .. note:: - This module is part of the `opsmill.infrahub collection `_ (version 1.0.5). + This module is part of the `opsmill.infrahub collection `_ (version 1.0.6). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. From 288ea30564c44a0e8878fe907ad0c978789fbe83 Mon Sep 17 00:00:00 2001 From: wvandeun Date: Wed, 8 May 2024 00:19:46 +0200 Subject: [PATCH 07/10] update to infrahub-sdk v0.10.1 --- poetry.lock | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/poetry.lock b/poetry.lock index 972f5ae..2965bcf 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. [[package]] name = "aiofiles" @@ -1191,25 +1191,25 @@ testing = ["pytest (>=3.5,!=3.7.3)", "pytest-black (>=0.3.7)", "pytest-checkdocs [[package]] name = "infrahub-sdk" -version = "0.9.1" +version = "0.10.1" description = "Python Client to interact with Infrahub" optional = false -python-versions = ">=3.8,<4.0" +python-versions = "<4.0,>=3.9" files = [ - {file = "infrahub_sdk-0.9.1-py3-none-any.whl", hash = "sha256:b2231d3889c6f593b512b00622ca92f7b00b4af160f32a088877a7a4f6668ee7"}, - {file = "infrahub_sdk-0.9.1.tar.gz", hash = "sha256:f2834d0d71f660e0af7d8a4644610ce15fa95e5d9227f12817e7400d230b04fb"}, + {file = "infrahub_sdk-0.10.1-py3-none-any.whl", hash = "sha256:eb85bfe249f5d7eeb73590f9ac8eae158e4c887aa389798161e2710fb889e259"}, + {file = "infrahub_sdk-0.10.1.tar.gz", hash = "sha256:7373001b5c7bf95cdab30fe2107db562f7d07718779bc7a3a927e78f872c3a6e"}, ] [package.dependencies] gitpython = ">=3,<4" graphql-core = ">=3.1,<3.3" httpx = [ - {version = ">=0.20", markers = "python_version >= \"3.8\" and python_version < \"3.11\""}, + {version = ">=0.20", markers = "python_version >= \"3.9\" and python_version < \"3.11\""}, {version = ">=0.23", markers = "python_version >= \"3.11\""}, ] Jinja2 = {version = ">=3,<4", optional = true, markers = "extra == \"ctl\" or extra == \"tests\" or extra == \"all\""} -numpy = {version = ">=1.24.2,<2.0.0", optional = true, markers = "python_version >= \"3.8\" and python_version < \"3.12\" and (extra == \"ctl\" or extra == \"all\")"} -pendulum = {version = ">=2", markers = "python_version >= \"3.8\" and python_version < \"3.12\""} +numpy = {version = ">=1.24.2,<2.0.0", optional = true, markers = "python_version >= \"3.9\" and python_version < \"3.12\" and (extra == \"ctl\" or extra == \"all\")"} +pendulum = {version = ">=2", markers = "python_version >= \"3.9\" and python_version < \"3.12\""} pyarrow = {version = ">=14,<15", optional = true, markers = "extra == \"ctl\" or extra == \"all\""} pydantic = ">=1.7.4,<1.8 || >1.8,<1.8.1 || >1.8.1,<2.0.0 || >2.0.0,<2.0.1 || >2.0.1,<2.1.0 || >2.1.0,<3.0.0" pytest = {version = "*", optional = true, markers = "extra == \"tests\" or extra == \"all\""} @@ -1217,11 +1217,11 @@ pyyaml = {version = ">=6,<7", optional = true, markers = "extra == \"ctl\" or ex rich = {version = ">=13,<14", optional = true, markers = "extra == \"ctl\" or extra == \"tests\" or extra == \"all\""} toml = {version = ">=0.10,<0.11", optional = true, markers = "extra == \"ctl\" or extra == \"all\""} typer = {version = ">=0,<1", optional = true, markers = "extra == \"ctl\" or extra == \"all\""} -ujson = {version = ">=5,<6", optional = true, markers = "extra == \"ctl\" or extra == \"all\""} +ujson = ">=5,<6" [package.extras] -all = ["Jinja2 (>=3,<4)", "numpy (>=1.24.2,<2.0.0)", "numpy (>=1.26.2,<2.0.0)", "pyarrow (>=14,<15)", "pytest", "pyyaml (>=6,<7)", "rich (>=13,<14)", "toml (>=0.10,<0.11)", "typer (>=0,<1)", "ujson (>=5,<6)"] -ctl = ["Jinja2 (>=3,<4)", "numpy (>=1.24.2,<2.0.0)", "numpy (>=1.26.2,<2.0.0)", "pyarrow (>=14,<15)", "pyyaml (>=6,<7)", "rich (>=13,<14)", "toml (>=0.10,<0.11)", "typer (>=0,<1)", "ujson (>=5,<6)"] +all = ["Jinja2 (>=3,<4)", "numpy (>=1.24.2,<2.0.0)", "numpy (>=1.26.2,<2.0.0)", "pyarrow (>=14,<15)", "pytest", "pyyaml (>=6,<7)", "rich (>=13,<14)", "toml (>=0.10,<0.11)", "typer (>=0,<1)"] +ctl = ["Jinja2 (>=3,<4)", "numpy (>=1.24.2,<2.0.0)", "numpy (>=1.26.2,<2.0.0)", "pyarrow (>=14,<15)", "pyyaml (>=6,<7)", "rich (>=13,<14)", "toml (>=0.10,<0.11)", "typer (>=0,<1)"] tests = ["Jinja2 (>=3,<4)", "pytest", "pyyaml (>=6,<7)", "rich (>=13,<14)"] [[package]] @@ -2059,7 +2059,6 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, From c295874d44286224a14aece2159f6a633999cbd7 Mon Sep 17 00:00:00 2001 From: opsmill-bot Date: Wed, 8 May 2024 09:09:08 +0000 Subject: [PATCH 08/10] chore: update pyproject.toml & galaxy.yml --- galaxy.yml | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/galaxy.yml b/galaxy.yml index 1a0da03..0e925f6 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -10,7 +10,7 @@ namespace: opsmill name: infrahub # The version of the collection. Must be compatible with semantic versioning -version: 1.0.7 +version: 1.0.8 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/pyproject.toml b/pyproject.toml index a38dc95..962cb1f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "infrahub_ansible_modules" -version = "1.0.7" +version = "1.0.8" description = "Ansible collection to interact with Infrahub's API" authors = ["OpsMill "] license = "GPLv3" From 67dda6ad35bc9f0153e06d15c23510fa5c0fe09b Mon Sep 17 00:00:00 2001 From: Pete Crocker Date: Wed, 15 May 2024 21:15:48 +0100 Subject: [PATCH 09/10] README consistency and cleanup --- README.md | 15 +++++++++++---- docs/index.rst | 10 ++++++++-- 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 70c8f9c..0e98342 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,17 @@ # Infrahub modules for Ansible using Ansible Collections +[Infrahub](https://github.com/opsmill/infrahub) by [OpsMill](https://opsmill.com) acts as a central hub to manage all of the information and code that powers your infrastructure. At its heart, Infrahub is built on 3 fundamental pillars: + +- **A Flexible Schema**: A model of the infrastructure and the relation between the objects in the model, that's easily extensible. +- **Version Control**: Natively integrated into the graph database which opens up some new capabilities like branching, diffing, and merging data directly in the database. +- **Unified Storage**: By combining a graph database and git, Infrahub stores data and code needed to manage the infrastructure. + +## Support + To keep the code simple, we only officially support the two latest releases of Infrahub and don't guarantee backwards compatibility beyond that. We do try and keep these breaking changes to a minimum, but sometimes changes to Infrahub's API cause us to have to make breaking changes. ## Requirements -Requirements - The two latest Infrahub releases - Python >=3.9, <3.13 @@ -14,9 +21,9 @@ Requirements - Ansible 2.12+ - Infrahub write-enabled token when using modules or read-only token for `lookup/inventory` -## Docs -Module documentation exists on [here](https://infrahub-ansible.readthedocs.io/en/latest/). +## Documentation +Please refer to the [opsmill.infrahub Ansible Collection](https://infrahub-ansible.readthedocs.io/en/latest/) documentation. ## Releasing, Versioning, and Deprecation @@ -28,4 +35,4 @@ Releasing the current major version happens from the `develop` branch with a rel If backward incompatible changes are possible, we plan to deprecate the old behavior as early as possible. We also plan to backport at least bug fixes for the old major version for some time after releasing a new major version. We will not block community members from backporting other bugfixes and features from the latest stable version to older release branches, under the condition that these backports are of reasonable quality. Some changes may not be able to be backported. -> Some changes that would require immediate patching that are breaking changes will fall to SemVer and constitute a breaking change. These will only be done when necessary, such as to support working with the most recent 3 versions of Ansible. Backporting these changes may not be possible. +Some changes that would require immediate patching that are breaking changes will fall to SemVer and constitute a breaking change. These will only be done when necessary, such as to support working with the most recent 3 versions of Ansible. Backporting these changes may not be possible. diff --git a/docs/index.rst b/docs/index.rst index 31540b5..8c99fc9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,17 @@ -opsmill.infrahub Ansible Collection's documentation! +opsmill.infrahub Ansible Collection documentation ================================================================ Overview ======== -This is the documentation home of the **opsmill.infrahub** Ansible Collection. We will provide some examples of using all the different plugins included with this collection. +`Infrahub ` by `OpsMill https://opsmill.com` acts as a central hub to manage all of the information and code that powers your infrastructure. At its heart, Infrahub is built on 3 fundamental pillars: + +* **A Flexible Schema**: A model of the infrastructure and the relation between the objects in the model, that's easily extensible. +* **Version Control**: Natively integrated into the graph database which opens up some new capabilities like branching, diffing, and merging data directly in the database. +* **Unified Storage**: By combining a graph database and git, Infrahub stores data and code needed to manage the infrastructure. + +This is the documentation home of the **opsmill.infrahub** Ansible Collection. Contents ======== From 699a3f2e70e4f3bc261c695b36c8045e7ad35f3e Mon Sep 17 00:00:00 2001 From: Pete Crocker Date: Fri, 17 May 2024 11:29:39 +0100 Subject: [PATCH 10/10] Consistency --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0e98342..00362d0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Infrahub modules for Ansible using Ansible Collections -[Infrahub](https://github.com/opsmill/infrahub) by [OpsMill](https://opsmill.com) acts as a central hub to manage all of the information and code that powers your infrastructure. At its heart, Infrahub is built on 3 fundamental pillars: +[Infrahub](https://github.com/opsmill/infrahub) by [OpsMill](https://opsmill.com) acts as a central hub to manage the data, templates and playbooks that powers your infrastructure. At its heart, Infrahub is built on 3 fundamental pillars: - **A Flexible Schema**: A model of the infrastructure and the relation between the objects in the model, that's easily extensible. - **Version Control**: Natively integrated into the graph database which opens up some new capabilities like branching, diffing, and merging data directly in the database.