mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 17:09:03 +00:00
Add gitfs configuration parameters to master config docs
This commit adds the new gitfs_provider parameter, as well as several other params for gitfs that were not documented.
This commit is contained in:
parent
d5440647d4
commit
5a8faf4810
@ -201,7 +201,7 @@ jobs dir
|
||||
``ext_job_cache``
|
||||
-----------------
|
||||
|
||||
Default: ''
|
||||
Default: ``''``
|
||||
|
||||
Used to specify a default returner for all minions, when this option is set
|
||||
the specified returner needs to be properly configured and the minions will
|
||||
@ -576,7 +576,7 @@ Example:
|
||||
|
||||
fileserver_backend:
|
||||
- roots
|
||||
- gitfs
|
||||
- git
|
||||
|
||||
.. conf_master:: file_roots
|
||||
|
||||
@ -640,6 +640,83 @@ The buffer size in the file server in bytes
|
||||
|
||||
file_buffer_size: 1048576
|
||||
|
||||
.. conf_master:: gitfs_provider
|
||||
|
||||
``gitfs_provider``
|
||||
------------------
|
||||
|
||||
.. versionadded:: Helium
|
||||
|
||||
Gitfs can be provided by one of two python modules: `GitPython`_ or `pygit2`_.
|
||||
If using pygit2, both libgit2 and git itself must also be installed. More
|
||||
information can be found in the :mod:`gitfs backend documentation
|
||||
<salt.fileserver.gitfs>`.
|
||||
|
||||
.. _GitPython: https://github.com/gitpython-developers/GitPython
|
||||
.. _pygit2: https://github.com/libgit2/pygit2
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_provider: pygit2
|
||||
|
||||
.. conf_master:: gitfs_remotes
|
||||
|
||||
``gitfs_remotes``
|
||||
-----------------
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
When using the git fileserver backend at least one git remote needs to be
|
||||
defined. The user running the salt master will need read access to the repo.
|
||||
|
||||
The repos will be searched in order to find the file requested by a client
|
||||
and the first repo to have the file will return it.
|
||||
When using the git backend branches and tags are translated into salt
|
||||
environments.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_remotes:
|
||||
- git://github.com/saltstack/salt-states.git
|
||||
- file:///var/git/saltmaster
|
||||
|
||||
.. note::
|
||||
``file://`` repos will be treated as a remote, so refs you want used must
|
||||
exist in that repo as *local* refs.
|
||||
|
||||
.. conf_master:: gitfs_ssl_verify
|
||||
|
||||
``gitfs_ssl_verify``
|
||||
--------------------
|
||||
|
||||
Default: ``[]``
|
||||
|
||||
The ``gitfs_ssl_verify`` option specifies whether to ignore ssl certificate
|
||||
errors when contacting the gitfs backend. You might want to set this to
|
||||
false if you're using a git backend that uses a self-signed certificate but
|
||||
keep in mind that setting this flag to anything other than the default of True
|
||||
is a security concern, you may want to try using the ssh transport.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_ssl_verify: True
|
||||
|
||||
.. conf_master:: gitfs_root
|
||||
|
||||
``gitfs_root``
|
||||
--------------
|
||||
|
||||
Default: ``''``
|
||||
|
||||
The ``gitfs_root`` option gives the ability to serve files from a subdirectory
|
||||
within the repository. The path is defined relative to the root of the
|
||||
repository and defaults to the repository root.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_root: somefolder/otherfolder
|
||||
|
||||
|
||||
.. _pillar-configuration:
|
||||
|
||||
Pillar Configuration
|
||||
|
Loading…
Reference in New Issue
Block a user