Skip to content

Commit

Permalink
Add ipc_write_buffer to master/minion config docs
Browse files Browse the repository at this point in the history
This option was introduced in 2016 [1] and typing enforced in 2022 [2].
However, documentation was not added in the master and minion
configuration docs. This change adds the mentioned documentation.

1. saltstack#34683
2. saltstack@ea35cb5
  • Loading branch information
auria committed Oct 10, 2022
1 parent 501e232 commit b24826a
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
17 changes: 17 additions & 0 deletions doc/ref/configuration/master.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1008,6 +1008,23 @@ is set to ``tcp`` by default on Windows.
ipc_mode: ipc
.. conf_master:: ipc_write_buffer

``ipc_write_buffer``
-----------------------

Default: ``0``

The maximum size of a message sent via the IPC transport module can be limited
dynamically or by sharing an integer value lower than the total memory size. When
the value ``dynamic`` is set, salt will use 2.5% of the total memory as
``ipc_write_buffer`` value (rounded to an integer). A value of ``0`` disables
this option.

.. code-block:: yaml
ipc_write_buffer: 10485760
.. conf_master:: tcp_master_pub_port

``tcp_master_pub_port``
Expand Down
19 changes: 18 additions & 1 deletion doc/ref/configuration/minion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ The type of the :conf_minion:`master` variable. Can be ``str``, ``failover``,
master_type: str
If this option is ``str`` (default), multiple hot masters are configured.
If this option is ``str`` (default), multiple hot masters are configured.
Minions can connect to multiple masters simultaneously (all master are "hot").

.. code-block:: yaml
Expand Down Expand Up @@ -1494,6 +1494,23 @@ process communications. ``ipc_mode`` is set to ``tcp`` on such systems.
ipc_mode: ipc
.. conf_minion:: ipc_write_buffer

``ipc_write_buffer``
-----------------------

Default: ``0``

The maximum size of a message sent via the IPC transport module can be limited
dynamically or by sharing an integer value lower than the total memory size. When
the value ``dynamic`` is set, salt will use 2.5% of the total memory as
``ipc_write_buffer`` value (rounded to an integer). A value of ``0`` disables
this option.

.. code-block:: yaml
ipc_write_buffer: 10485760
.. conf_minion:: tcp_pub_port

``tcp_pub_port``
Expand Down

0 comments on commit b24826a

Please sign in to comment.