saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add ipc_write_buffer to master/minion config docs

Browse source 
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. https://github.com/saltstack/salt/pull/34683
2. ea35cb527e
This commit is contained in:
Alvaro Uria 2022-10-10 15:14:08 +03:00 • committed by Megan Wilhite
parent 43b8502508
commit 50dd3ffd3e
2 changed files with 35 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/ref/configuration/master.rst
View file

@ -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``

19
doc/ref/configuration/minion.rst
View file

@ -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
@ -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``