Add docs and changelog for #63747

This commit is contained in:
Daniel A. Wozniak 2023-03-24 18:07:07 -07:00 committed by Pedro Algarvio
parent 82f5655487
commit 58b02266de
3 changed files with 38 additions and 1 deletions

1
changelog/63747.fixed.md Normal file
View file

@ -0,0 +1 @@
Add `fileserver_interval` and `maintenance_interval` master configuration options. These options control how often to restart the FileServerUpdate and Maintenance processes. Some file server and pillar configurations are known to cause memory leaks over time. A notable example of this are configurations that use pygit2. Salt can not guarantee dependency libraries like pygit2 won't leak memory. Restarting any long running processes that use pygit2 guarantees we can keep the master's memory usage in check.

View file

@ -371,10 +371,24 @@ Set the default timeout for the salt command and api.
Default: ``60``
The loop_interval option controls the seconds for the master's maintenance
The loop_interval option controls the seconds for the master's Maintenance
process check cycle. This process updates file server backends, cleans the
job cache and executes the scheduler.
``maintenance_interval``
------------------------
.. versionadded:: 3006.0
Default: ``3600``
Defines how often to restart the master's Maintenance process.
.. code-block:: yaml
maintenance_interval: 9600
.. conf_master:: output
``output``
@ -4077,6 +4091,19 @@ This option defines the update interval (in seconds) for s3fs.
s3fs_update_interval: 120
``fileserver_interval``
***********************
.. versionadded:: 3006.0
Default: ``3600``
Defines how often to restart the master's FilesServerUpdate process.
.. code-block:: yaml
fileserver_interval: 9600
.. _pillar-configuration-master:

View file

@ -13,6 +13,15 @@ individual environments can span across multiple directory roots
to create overlays and to allow for files to be organized in many flexible
ways.
Periodic Restarts
=================
The file server will restart periodically. The reason for this is to prevent any
files erver backends which may not properly handle resources from endlessly
consuming memory. A notable example of this is using a git backend with the
pygit2 library. How often the file server restarts can be controlled with the
``fileserver_interval`` in your master's config file.
Environments
============