Skip to content

Commit

Permalink
docs: add a note for EDA_CONTROLLER_CONNECTION_LIMIT (#607)
Browse files Browse the repository at this point in the history
Co-authored-by: Tom Tuffin <[email protected]>
  • Loading branch information
Alex-Izquierdo and ttuffin authored Oct 30, 2023
1 parent 5dec0d7 commit f2ae5cf
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/actions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,12 @@ Run a job template.

.. note::
``--controller-url`` and ``--controller-token`` cmd options must be provided to use this action

In order to access event information under the ``ansible_eda`` namespace, be sure to check the box for "Prompt on launch" for the Variables field within the job template. Alternatively, a survey can be created that includes the variable ``ansible_eda``. Similarly, if you plan to limit host execution based on event information, enable "Prompt on launch" for the Limit field within the job template.

.. note::
You can define the environment variable ``EDA_CONTROLLER_CONNECTION_LIMIT`` to limit the number of concurrent connections to the controller. The default is 30.


.. list-table::
:widths: 25 150 10
Expand Down Expand Up @@ -172,6 +175,10 @@ Run a workflow template.
.. note::
``--controller-url`` and ``--controller-token`` cmd options must be provided to use this action

.. note::
You can define the environment variable ``EDA_CONTROLLER_CONNECTION_LIMIT`` to limit the number of concurrent connections to the controller. The default is 30.


.. list-table::
:widths: 25 150 10
:header-rows: 1
Expand Down Expand Up @@ -331,7 +338,7 @@ retract_fact
- The name of the rule set to retract the fact, default is the current rule set name
- No
* - partial
- The fact being requested to retracted is partial and doesn't have all the keys. Default is true
- The fact being requested to retracted is partial and doesn't have all the keys. Default is true
- No

Example:
Expand Down Expand Up @@ -398,7 +405,7 @@ shutdown
- A numeric value about how long to wait in seconds before shutting down, default 60.0
- No
* - message
- A message to be associated with this shutdown
- A message to be associated with this shutdown
- No
* - kind
- Kind of shutdown can be either **graceful** or **now**. default is graceful.
Expand Down Expand Up @@ -471,7 +478,7 @@ Example:
condition: event.i >= 5
action:
debug:
msg:
msg:
- "Message 1 {{ event }}"
- Second Message
Expand Down

0 comments on commit f2ae5cf

Please sign in to comment.