Including name per-remote config option in example

This commit is contained in:
Robert James Hernandez 2016-04-22 09:06:54 -07:00
parent 35c8af3ece
commit b69d406ada

View file

@ -313,7 +313,12 @@ tremendous amount of customization. Here's some example usage:
- https://foo.com/foo.git
- https://foo.com/bar.git:
- root: salt
- mountpoint: salt://foo/bar/baz
- mountpoint: salt://bar
- base: salt-base
- https://foo.com/bar.git:
- name: second_bar_repo
- root: other/salt
- mountpoint: salt://other/bar
- base: salt-base
- http://foo.com/baz.git:
- root: salt/states
@ -330,26 +335,32 @@ tremendous amount of customization. Here's some example usage:
with a colon.
2. Per-remote configuration parameters are named like the global versions,
with the ``gitfs_`` removed from the beginning.
with the ``gitfs_`` removed from the beginning. The exception being the
``name`` parameter which is only available to Per-remote configurations.
In the example configuration above, the following is true:
1. The first and third gitfs remotes will use the ``develop`` branch/tag as the
``base`` environment, while the second one will use the ``salt-base``
1. The first and fourth gitfs remotes will use the ``develop`` branch/tag as the
``base`` environment, while the second and third will use the ``salt-base``
branch/tag as the ``base`` environment.
2. The first remote will serve all files in the repository. The second
remote will only serve files from the ``salt`` directory (and its
subdirectories), while the third remote will only serve files from the
``salt/states`` directory (and its subdirectories).
subdirectories). The third remote will only server files from the
``other/salt`` directory (and its subdirectorys), while the fourth remote
will only serve files from the ``salt/states`` directory (and its
subdirectories).
3. The files from the second remote will be located under
``salt://foo/bar/baz``, while the files from the first and third remotes
will be located under the root of the Salt fileserver namespace
(``salt://``).
3. The first and fourth remotes will have files located under the root of the
Salt fileserver namespace (``salt://``). The files from the second remote
will be located under ``salt://bar``, while the files from the third remote
will be located under ``salt://other/bar``.
4. The third remote overrides the default behavior of :ref:`not authenticating to
insecure (non-HTTPS) remotes <gitfs-insecure-auth>`.
4. The second and third remotes reference the same repository and unique names
need to be declared for duplicate gitfs remotes.
5. The fourth remote overrides the default behavior of :ref:`not authenticating
to insecure (non-HTTPS) remotes <gitfs-insecure-auth>`.
Serving from a Subdirectory
===========================