From 9d9c28f1a18b532f519e5de9c5b31c2935bad45e Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Fri, 16 Aug 2024 16:18:29 -0700 Subject: [PATCH] Add docs for the modules * Added antsibull-docs config * Updated tox.ini to handle antsibull-docs * Updated antsibull-docs requirement in test_requirements.txt Signed-off-by: Abhijeet Kasurde --- .config/dictionary.txt | 6 + docs/ansible.eda.activation_info_module.rst | 220 ++++++++ docs/ansible.eda.activation_module.rst | 488 ++++++++++++++++++ docs/ansible.eda.controller_token_module.rst | 283 ++++++++++ docs/ansible.eda.credential_info_module.rst | 220 ++++++++ docs/ansible.eda.credential_module.rst | 313 +++++++++++ ...nsible.eda.credential_type_info_module.rst | 220 ++++++++ docs/ansible.eda.credential_type_module.rst | 303 +++++++++++ ...e.eda.decision_environment_info_module.rst | 226 ++++++++ ...nsible.eda.decision_environment_module.rst | 313 +++++++++++ docs/ansible.eda.project_info_module.rst | 229 ++++++++ docs/ansible.eda.project_module.rst | 281 ++++++++++ test_requirements.txt | 1 + tox.ini | 5 + 14 files changed, 3108 insertions(+) create mode 100644 docs/ansible.eda.activation_info_module.rst create mode 100644 docs/ansible.eda.activation_module.rst create mode 100644 docs/ansible.eda.controller_token_module.rst create mode 100644 docs/ansible.eda.credential_info_module.rst create mode 100644 docs/ansible.eda.credential_module.rst create mode 100644 docs/ansible.eda.credential_type_info_module.rst create mode 100644 docs/ansible.eda.credential_type_module.rst create mode 100644 docs/ansible.eda.decision_environment_info_module.rst create mode 100644 docs/ansible.eda.decision_environment_module.rst create mode 100644 docs/ansible.eda.project_info_module.rst create mode 100644 docs/ansible.eda.project_module.rst diff --git a/.config/dictionary.txt b/.config/dictionary.txt index ce6203b0..2154fc74 100644 --- a/.config/dictionary.txt +++ b/.config/dictionary.txt @@ -63,3 +63,9 @@ hdrs testuser testsecret keygen +antsibull +thead +tbody +darkgreen +notranslate +fqcn diff --git a/docs/ansible.eda.activation_info_module.rst b/docs/ansible.eda.activation_info_module.rst new file mode 100644 index 00000000..07b35bbb --- /dev/null +++ b/docs/ansible.eda.activation_info_module.rst @@ -0,0 +1,220 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.activation_info module -- List rulebook activations in the EDA Controller ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.activation_info``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- List rulebook activations in the EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

name

+ +

+ string +

+ 		+

The name of the rulebook activation.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: Get information about a rulebook activation + ansible.eda.activation_info: + name: "Example Rulebook Activation" + + - name: List all rulebook activations + ansible.eda.activation_info: + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

activations

+ +

+ list + / elements=dictionary +

+ 		+

Information about rulebook activations.

+

Returned: always

+

Sample: [{"awx_token_id": 1, "created_at": "2024-08-10T14:22:30.123Z", "current_job_id": "2", "decision_environment_id": 1, "description": "A test activation", "eda_credentials": [], "event_streams": [], "extra_var": "", "id": 1, "is_enabled": true, "k8s_service_name": "", "log_level": "info", "modified_at": "2024-08-15T11:45:00.987Z", "name": "Test activation", "organization_id": 1, "project_id": 2, "restart_count": 2, "restart_policy": "on-failure", "rulebook_id": 1, "rulebook_name": "Test rulebook", "rules_count": 2, "rules_fired_count": 2, "status": "running", "status_message": "Activation is running successfully.", "swap_single_source": false, "webhooks": []}]

+
+ + + + +Authors +~~~~~~~ + +- Alina Buzachis (@alinabuzachis) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.activation_module.rst b/docs/ansible.eda.activation_module.rst new file mode 100644 index 00000000..6059a1e3 --- /dev/null +++ b/docs/ansible.eda.activation_module.rst @@ -0,0 +1,488 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.activation module -- Manage rulebook activations in the EDA Controller +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.activation``. + + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- This module allows the user to create or delete rulebook activations in the EDA Controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+
+
+

awx_token_name

+ +

aliases: awx_token, token

+

+ string +

+ 		+

The token ID of the AWX controller.

+
+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+
+

decision_environment_name

+ +

aliases: decision_environment

+

+ string +

+ 		+

The name of the decision environment associated with the rulebook activation.

+
+
+

description

+ +

+ string +

+ 		+

The description of the rulebook activation.

+
+
+
+

eda_credentials

+ +

aliases: credentials

+

+ list + / elements=string +

+ 		+

A list of IDs for EDA credentials used by the rulebook activation.

+
+
+

enabled

+ +

+ boolean +

+ 		+

Whether the rulebook activation is enabled or not.

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+
+

event_streams

+ +

+ list + / elements=integer +

+ 		+

A list of IDs representing the event streams that this rulebook activation listens to.

+
+
+

extra_vars

+ +

+ string +

+ 		+

The extra variables for the rulebook activation.

+
+
+

k8s_service_name

+ +

+ string +

+ 		+

The name of the Kubernetes service associated with this rulebook activation.

+
+
+

log_level

+ +

+ string +

+ 		+

Allow setting the desired log level.

+

Choices:

+
    +

  • "debug" ← (default)

    • +

  • "info"

    • +

  • "error"

    • +
+ +
+
+

name

+ +

+ string + / required +

+ 		+

The name of the rulebook activation.

+
+
+
+

organization_name

+ +

aliases: organization

+

+ string +

+ 		+

The name of the organization.

+
+
+
+

project_name

+ +

aliases: project

+

+ string +

+ 		+

The name of the project associated with the rulebook activation.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

restart_policy

+ +

+ string +

+ 		+

The restart policy for the rulebook activation.

+

Choices:

+
    +

  • "on-failure"

    • +

  • "always" ← (default)

    • +

  • "never"

    • +
+ +
+
+
+

rulebook_name

+ +

aliases: rulebook

+

+ string +

+ 		+

The name of the rulebook associated with the rulebook activation.

+
+
+

state

+ +

+ string +

+ 		+

Desired state of the resource.

+

Choices:

+
    +

  • "present" ← (default)

    • +

  • "absent"

    • +
+ +
+
+

swap_single_source

+ +

+ boolean +

+ 		+

Allow swapping of single sources in a rulebook without name match.

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+
+

webhooks

+ +

+ list + / elements=string +

+ 		+

A list of webhook IDs associated with the rulebook activation.

+
+ + + + +Notes +----- + +- Rulebook Activation API does not support PATCH method, due to this reason the module will not perform any modification when an existing rulebook activation is found. + + +Examples +-------- + +.. code-block:: yaml + + + - name: Create a rulebook activation + ansible.eda.activation: + name: "Example Rulebook Activation" + description: "Example Rulebook Activation description" + project_name: "Example Project" + rulebook_name: "hello_controller.yml" + decision_environment_name: "Example Decision Environment" + enabled: False + awx_token_name: "Example Token" + + - name: Delete a rulebook activation + ansible.eda.activation: + name: "Example Rulebook Activation" + state: absent + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

id

+ +

+ integer +

+ 		+

ID of the rulebook activation.

+

Returned: when exists

+

Sample: 37

+
+ + + + +Authors +~~~~~~~ + +- Nikhil Jain (@jainnikhil30) +- Alina Buzachis (@alinabuzachis) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.controller_token_module.rst b/docs/ansible.eda.controller_token_module.rst new file mode 100644 index 00000000..6f85caca --- /dev/null +++ b/docs/ansible.eda.controller_token_module.rst @@ -0,0 +1,283 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.controller_token module -- Manage AWX tokens in EDA controller +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.controller_token``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- This module allows the user to manage AWX tokens in a EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

description

+ +

+ string +

+ 		+

The description of the project.

+

Required when state=present.

+
+
+

name

+ +

+ string + / required +

+ 		+

The name of the AWX token.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

state

+ +

+ string +

+ 		+

Desired state of the resource.

+

Choices:

+
    +

  • "present" ← (default)

    • +

  • "absent"

    • +
+ +
+
+

token

+ +

+ string +

+ 		+

The AWX token value.

+

Required when state=present.

+
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + +Notes +----- + +- Controller Token API does not support PATCH method, due to this reason the module deletes and re-creates the token when existing controller token is found. This will cause module to report changed, every time update is called. + + +Examples +-------- + +.. code-block:: yaml + + + - name: Create AWX token + ansible.eda.controller_token: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example AWX token" + description: "Example AWX token description" + token: "" + state: present + no_log: true + + - name: Delete AWX token + ansible.eda.controller_token: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example AWX token" + state: absent + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

id

+ +

+ string +

+ 		+

ID of the managed AWX token.

+

Returned: when state is 'present' and successful

+

Sample: "123"

+
+ + + + +Authors +~~~~~~~ + +- Abhijeet Kasurde (@akasurde) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.credential_info_module.rst b/docs/ansible.eda.credential_info_module.rst new file mode 100644 index 00000000..66a6439b --- /dev/null +++ b/docs/ansible.eda.credential_info_module.rst @@ -0,0 +1,220 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.credential_info module -- List credentials in the EDA Controller +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.credential_info``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- List credentials in the EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

name

+ +

+ string +

+ 		+

The name of the credential.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: Get information about a credential + ansible.eda.credential_info: + name: "Test" + + - name: List all credentials + ansible.eda.credential_info: + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

credentials

+ +

+ list + / elements=dictionary +

+ 		+

Information about credentials.

+

Returned: always

+

Sample: [{"created_at": "2024-08-14T08:57:55.151787Z", "credential_type": {"id": 1, "kind": "scm", "name": "Source Control", "namespace": "scm"}, "description": "This is a test credential", "id": 24, "inputs": {"password": "$encrypted$", "username": "testuser"}, "managed": false, "modified_at": "2024-08-14T08:57:56.324925Z", "name": "New Test Credential", "organization": {"description": "The default organization", "id": 1, "name": "Default"}, "references": null}]

+
+ + + + +Authors +~~~~~~~ + +- Alina Buzachis (@alinabuzachis) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.credential_module.rst b/docs/ansible.eda.credential_module.rst new file mode 100644 index 00000000..0c9f3df5 --- /dev/null +++ b/docs/ansible.eda.credential_module.rst @@ -0,0 +1,313 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.credential module -- Manage credentials in EDA Controller ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.credential``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- This module allows the user to create, update or delete a credential in EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

credential_type_name

+ +

+ string +

+ 		+

The name of the credential type.

+
+
+

description

+ +

+ string +

+ 		+

Description of the credential.

+
+
+

inputs

+ +

+ dictionary +

+ 		+

Credential inputs where the keys are var names used in templating.

+
+
+

name

+ +

+ string + / required +

+ 		+

Name of the credential.

+
+
+

new_name

+ +

+ string +

+ 		+

Setting this option will change the existing name (lookup via name).

+
+
+
+

organization_name

+ +

aliases: org_name

+

+ integer +

+ 		+

The name of the organization.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

state

+ +

+ string +

+ 		+

Desired state of the resource.

+

Choices:

+
    +

  • "present" ← (default)

    • +

  • "absent"

    • +
+ +
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: Create an EDA Credential + ansible.eda.credential: + name: "Example Credential" + description: "Example credential description" + inputs: + field1: "field1" + credential_type_name: "GitLab Personal Access Token" + + - name: Delete an EDA Credential + ansible.eda.credential: + name: "Example Credential" + state: absent + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

id

+ +

+ integer +

+ 		+

ID of the credential.

+

Returned: when exists

+

Sample: 24

+
+ + + + +Authors +~~~~~~~ + +- Nikhil Jain (@jainnikhil30) +- Alina Buzachis (@alinabuzachis) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.credential_type_info_module.rst b/docs/ansible.eda.credential_type_info_module.rst new file mode 100644 index 00000000..d3256e79 --- /dev/null +++ b/docs/ansible.eda.credential_type_info_module.rst @@ -0,0 +1,220 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.credential_type_info module -- List credential types in EDA Controller +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.credential_type_info``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- List credential types in EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

name

+ +

+ string +

+ 		+

The name of the credential type.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: Get information about a credential type + ansible.eda.credential_type_info: + name: "Test" + + - name: List all credential types + ansible.eda.credential_type_info: + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

credential_types

+ +

+ list + / elements=dictionary +

+ 		+

Information about the credential types.

+

Returned: always

+

Sample: [{"created_at": "2024-08-14T08:30:14.806638Z", "description": "A test credential type", "id": 37, "injectors": {"extra_vars": {"field1": "field1"}}, "inputs": {"fields": [{"id": "field1", "label": "Field 5", "type": "string"}]}, "kind": "cloud", "managed": false, "modified_at": "2024-08-14T08:30:14.807549Z", "name": "Example", "namespace": null}]

+
+ + + + +Authors +~~~~~~~ + +- Alina Buzachis (@alinabuzachis) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.credential_type_module.rst b/docs/ansible.eda.credential_type_module.rst new file mode 100644 index 00000000..68c18083 --- /dev/null +++ b/docs/ansible.eda.credential_type_module.rst @@ -0,0 +1,303 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.credential_type module -- Manage credential types in EDA Controller ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.credential_type``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- This module allows the user to create, update or delete a credential type in EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

description

+ +

+ string +

+ 		+

The description of the credential type to give more detail about it.

+
+
+

injectors

+ +

+ dictionary +

+ 		+

Injectors of the credential type.

+
+
+

inputs

+ +

+ dictionary +

+ 		+

Inputs of the credential type.

+
+
+

name

+ +

+ string + / required +

+ 		+

The name of the credential type.

+
+
+

new_name

+ +

+ string +

+ 		+

Setting this option will change the existing name.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

state

+ +

+ string +

+ 		+

Desired state of the resource.

+

Choices:

+
    +

  • "present" ← (default)

    • +

  • "absent"

    • +
+ +
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: Create a credential type + ansible.eda.credential_type: + name: "Test" + state: present + description: "A test credential type" + inputs: + fields: + - id: "Field1" + type: "string" + label: "Label1" + injectors: + extra_vars: + field1: "field1" + + - name: Delete a credential type + ansible.eda.credential_type: + name: "Test" + state: absent + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

id

+ +

+ integer +

+ 		+

ID of the credential type.

+

Returned: when exists

+

Sample: 37

+
+ + + + +Authors +~~~~~~~ + +- Alina Buzachis (@alinabuzachis) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.decision_environment_info_module.rst b/docs/ansible.eda.decision_environment_info_module.rst new file mode 100644 index 00000000..0f276e24 --- /dev/null +++ b/docs/ansible.eda.decision_environment_info_module.rst @@ -0,0 +1,226 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.decision_environment_info module -- List a decision environment in EDA Controller ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.decision_environment_info``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- This module allows user to list a decision environment in a EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

name

+ +

+ string +

+ 		+

The name of the decision environment.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: List all EDA Decision Environments + ansible.eda.decision_environment_info: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + + - name: List a particular EDA Decision Environments + ansible.eda.decision_environment_info: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: Example + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

decision_environments

+ +

+ list + / elements=string +

+ 		+

List of dict containing information about decision environments

+

Returned: when exists

+

Sample: [{"created_at": "2024-08-15T21:12:52.218969Z", "description": "Example decision environment description", "eda_credential_id": null, "id": 35, "image_url": "https://quay.io/repository/ansible/eda-server", "modified_at": "2024-08-15T21:12:52.218994Z", "name": "Example Decision environment", "organization_id": 1}]

+
+ + + + +Authors +~~~~~~~ + +- Abhijeet Kasurde (@akasurde) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.decision_environment_module.rst b/docs/ansible.eda.decision_environment_module.rst new file mode 100644 index 00000000..deea929b --- /dev/null +++ b/docs/ansible.eda.decision_environment_module.rst @@ -0,0 +1,313 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.decision_environment module -- Create, update or delete decision environment in EDA Controller +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.decision_environment``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- This module allows user to create, update or delete decision environment in a EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

credential

+ +

+ string +

+ 		+

Name of the credential to associate with the decision environment.

+
+
+

description

+ +

+ string +

+ 		+

The description of the decision environment.

+
+
+

image_url

+ +

+ string +

+ 		+

Image URL of the decision environment.

+
+
+

name

+ +

+ string + / required +

+ 		+

The name of the decision environment.

+
+
+

new_name

+ +

+ string +

+ 		+

Setting this option will change the existing name.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

state

+ +

+ string +

+ 		+

Desired state of the resource.

+

Choices:

+
    +

  • "present" ← (default)

    • +

  • "absent"

    • +
+ +
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: Create EDA Decision Environment + ansible.eda.decision_environment: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example Decision Environment" + description: "Example Decision Environment description" + image_url: "quay.io/test" + credential: "Example Credential" + state: present + + - name: Update the name of the Decision Environment + ansible.eda.decision_environment: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example Decision Environment" + new_name: "Latest Example Decision Environment" + state: present + + - name: Delete the the Decision Environment + ansible.eda.decision_environment: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example Decision Environment" + state: absent + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

id

+ +

+ integer +

+ 		+

ID of the decision environment

+

Returned: when exists

+

Sample: 37

+
+ + + + +Authors +~~~~~~~ + +- Nikhil Jain (@jainnikhil30) +- Abhijeet Kasurde (@akasurde) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.project_info_module.rst b/docs/ansible.eda.project_info_module.rst new file mode 100644 index 00000000..ecc28292 --- /dev/null +++ b/docs/ansible.eda.project_info_module.rst @@ -0,0 +1,229 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.project_info module -- List projects in EDA Controller +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.project_info``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- This module allows user to list project in a EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

name

+ +

+ string +

+ 		+

The name of the project.

+

Return information about particular project available on EDA Controller.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: List a particular project + ansible.eda.project_info: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example" + register: r + + - name: List all projects + ansible.eda.project_info: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + register: r + + + + + +Return Values +------------- +The following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + +

Key

Description

+
+

projects

+ +

+ list + / elements=string +

+ 		+

List of dicts containing information about projects

+

Returned: success

+

Sample: [{"created_at": "2024-08-12T20:35:28.367702Z", "description": "", "eda_credential_id": null, "git_hash": "417b4dbe9b3472fd64212ef8233b865585e5ade3", "id": 17, "import_error": null, "import_state": "completed", "modified_at": "2024-08-12T20:35:28.367724Z", "name": "Sample Example Project", "organization_id": 1, "proxy": "", "scm_branch": "", "scm_refspec": "", "scm_type": "git", "signature_validation_credential_id": null, "url": "https://github.com/ansible/ansible-ui", "verify_ssl": true}]

+
+ + + + +Authors +~~~~~~~ + +- Abhijeet Kasurde (@akasurde) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/docs/ansible.eda.project_module.rst b/docs/ansible.eda.project_module.rst new file mode 100644 index 00000000..b320a6f0 --- /dev/null +++ b/docs/ansible.eda.project_module.rst @@ -0,0 +1,281 @@ + +.. Created with antsibull-docs 2.12.0 + +ansible.eda.project module -- Create, update or delete project in EDA Controller +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +This module is part of the `ansible.eda collection `_ (version 1.4.7). + +It is not included in ``ansible-core``. +To check whether it is installed, run ``ansible-galaxy collection list``. + +To install it, use: :code:`ansible-galaxy collection install ansible.eda`. + +To use it in a playbook, specify: ``ansible.eda.project``. + +New in ansible.eda 2.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- + +- This module allows user to create, update or delete project in a EDA controller. + + + + + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

Comments

+
+

controller_host

+ +

+ string + / required +

+

added in ansible.eda 2.0.0

+ 		+

The URL of the EDA controller.

+

If not set, the value of the CONTROLLER_URL environment variable will be used.

+
+
+

controller_password

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Password used for authentication.

+

If not set, the value of the CONTROLLER_PASSWORD environment variable will be used.

+
+
+

controller_username

+ +

+ string +

+

added in ansible.eda 2.0.0

+ 		+

Username used for authentication.

+

If not set, the value of the CONTROLLER_USERNAME environment variable will be used.

+
+
+

credential

+ +

+ string +

+ 		+

The name of the credential to associate with the project.

+
+
+

description

+ +

+ string +

+ 		+

The description of the project.

+
+
+

name

+ +

+ string + / required +

+ 		+

The name of the project.

+
+
+

new_name

+ +

+ string +

+ 		+

Setting this option will change the existing name.

+
+
+

request_timeout

+ +

+ float +

+

added in ansible.eda 2.0.0

+ 		+

Timeout in seconds for the connection with the EDA controller.

+

If not set, the value of the CONTROLLER_TIMEOUT environment variable will be used.

+

Default: 10.0

+
+
+

state

+ +

+ string +

+ 		+

Desired state of the resource.

+

Choices:

+
    +

  • "present" ← (default)

    • +

  • "absent"

    • +
+ +
+
+

url

+ +

+ string +

+ 		+

The git URL of the project.

+
+
+

validate_certs

+ +

+ boolean +

+

added in ansible.eda 2.0.0

+ 		+

Whether to allow insecure connections to Ansible Automation Platform EDA Controller instance.

+

If no, SSL certificates will not be validated.

+

This should only be used on personally controlled sites using self-signed certificates.

+

If value not set, will try environment variable CONTROLLER_VERIFY_SSL

+

Choices:

+
    +

  • false

    • +

  • true ← (default)

    • +
+ +
+ + + + + + +Examples +-------- + +.. code-block:: yaml + + + - name: Create EDA Projects + ansible.eda.project: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example Project" + description: "Example project description" + url: "https://example.com/project1" + state: present + + - name: Update the name of the project + ansible.eda.project: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example Project" + new_name: "Latest Example Project" + description: "Example project description" + url: "https://example.com/project1" + state: present + + - name: Delete the project + ansible.eda.project: + controller_host: https://my_eda_host/ + controller_username: admin + controller_password: MySuperSecretPassw0rd + name: "Example Project" + state: absent + + + + + + + +Authors +~~~~~~~ + +- Nikhil Jain (@jainnikhil30) +- Abhijeet Kasurde (@akasurde) + + + +Collection links +~~~~~~~~~~~~~~~~ + +* `Issue Tracker `__ +* `Homepage `__ +* `Repository (Sources) `__ + diff --git a/test_requirements.txt b/test_requirements.txt index e2ced797..5840c562 100644 --- a/test_requirements.txt +++ b/test_requirements.txt @@ -10,3 +10,4 @@ requests>=2.31.0 ansible-rulebook>=1.0.0 tox>=4.15.1 podman-compose +antsibull-docs==2.12.0 diff --git a/tox.ini b/tox.ini index e899acc6..356f9a9e 100644 --- a/tox.ini +++ b/tox.ini @@ -113,3 +113,8 @@ commands = ansible-test coverage combine --export={envdir} # produces tests/output/reports/coverage.xml ansible-test coverage xml --requirements + +[testenv:docs] +description = Generate plugins documentation under /docs directory using antsibull-docs +commands = + antsibull-docs collection-plugins ansible.eda --dest-dir docs --use-current --output-format simplified-rst --fqcn-plugin-names