Add doc and salt.config code for git_pillar_update_interval

saltstack · Dec 21, 2019 · a1844cf · a1844cf
1 parent 48e0dfa
commit a1844cf
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/doc/ref/configuration/master.rst b/doc/ref/configuration/master.rst
@@ -4255,6 +4255,21 @@ explanation <git-pillar-multiple-remotes>` from the git_pillar documentation.
 
     git_pillar_includes: False
 
+``git_pillar_update_interval``
+******************************
+
+.. versionadded:: neon
+
+Default: ``60``
+
+This option defines the default update interval (in seconds) for git_pillar
+remotes. The update is handled within the global loop, hence
+``git_pillar_update_interval`` should be a multiple of ``loop_interval``.
+
+.. code-block:: yaml
+
+    git_pillar_update_interval: 120
+
 .. _git-ext-pillar-auth-opts:
 
 Git External Pillar Authentication Options

diff --git a/salt/config/__init__.py b/salt/config/__init__.py
@@ -659,6 +659,7 @@ def _gather_buffer_space():
     'roots_update_interval': int,
     'azurefs_update_interval': int,
     'gitfs_update_interval': int,
+    'git_pillar_update_interval': int,
     'hgfs_update_interval': int,
     'minionfs_update_interval': int,
     's3fs_update_interval': int,
@@ -1289,6 +1290,7 @@ def _gather_buffer_space():
     'roots_update_interval': DEFAULT_INTERVAL,
     'azurefs_update_interval': DEFAULT_INTERVAL,
     'gitfs_update_interval': DEFAULT_INTERVAL,
+    'git_pillar_update_interval': DEFAULT_INTERVAL,
     'hgfs_update_interval': DEFAULT_INTERVAL,
     'minionfs_update_interval': DEFAULT_INTERVAL,
     's3fs_update_interval': DEFAULT_INTERVAL,
@@ -1533,6 +1535,7 @@ def _gather_buffer_space():
     'roots_update_interval': DEFAULT_INTERVAL,
     'azurefs_update_interval': DEFAULT_INTERVAL,
     'gitfs_update_interval': DEFAULT_INTERVAL,
+    'git_pillar_update_interval': DEFAULT_INTERVAL,
     'hgfs_update_interval': DEFAULT_INTERVAL,
     'minionfs_update_interval': DEFAULT_INTERVAL,
     's3fs_update_interval': DEFAULT_INTERVAL,

diff --git a/salt/pillar/git_pillar.py b/salt/pillar/git_pillar.py
@@ -350,6 +350,21 @@
         - __env__ https://mydomain.tld/pillar-appdata.git:
           - mountpoint: web/server/
 
+.. _git_pillar_update_interval:
+
+git_pillar_update_interval
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: neon
+
+This option defines the default update interval (in seconds) for git_pillar
+remotes. The update is handled within the global loop, hence
+``git_pillar_update_interval`` should be a multiple of ``loop_interval``.
+
+.. code-block:: yaml
+
+    git_pillar_update_interval: 120
+
 '''
 from __future__ import absolute_import, print_function, unicode_literals