Added additional docs on gitfs mountpoints and per-remote params

This commit is contained in:
Erik Johnson 2014-02-15 01:19:02 -06:00
parent e24554e188
commit bccd82aacf

View File

@ -832,9 +832,27 @@ translated into salt environments.
- 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.
.. note::
As of the upcoming **Helium** release (and right now in the development
branch), it is possible to have per-repo versions of the
:conf_master:`gitfs_root` and :conf_master:`gitfs_mountpoint` parameters.
For example:
.. code-block:: yaml
gitfs_remotes:
- https://foo.com/foo.git
- https://foo.com/bar.git:
- root: salt
- mountpoint: salt://foo/bar/baz
- https://foo.com/baz.git:
- root: salt
.. conf_master:: gitfs_ssl_verify
``gitfs_ssl_verify``
@ -862,12 +880,19 @@ is a security concern, you may want to try using the ssh transport.
Default: ``''``
Specifies a path on the salt fileserver from which gitfs remotes are served.
Can be used in conjunction with :conf_master:`gitfs_root`.
Can be used in conjunction with :conf_master:`gitfs_root`. Can also be
configured on a per-remote basis, see :conf_master:`here <gitfs_remotes>` for
more info.
.. code-block:: yaml
gitfs_mountpoint: salt://foo/bar
.. note::
The ``salt://`` protocol designation can be left off (i.e. ``foo/bar`` and
``salt://foo/bar`` are equivalent).
.. conf_master:: gitfs_root
``gitfs_root``
@ -877,12 +902,18 @@ Default: ``''``
Serve files from a subdirectory within the repository, instead of the root.
This is useful when there are files in the repository that should not be
available to the Salt fileserver.
available to the Salt fileserver. Can be used in conjunction with
:conf_master:`gitfs_mountpoint`.
.. code-block:: yaml
gitfs_root: somefolder/otherfolder
.. versionchanged:: Helium
Ability to specify gitfs roots on a per-remote basis was added. See
:conf_master:`here <gitfs_remotes>` for more info.
.. conf_master:: gitfs_base
``gitfs_base``