mirror of
https://github.com/valitydev/salt.git
synced 2024-11-07 08:58:59 +00:00
Merge pull request #41045 from terminalmage/clarify-gitfs-docs
Clarify gitfs docs
This commit is contained in:
Nicole Thomas
GitHub
commit
2b47b7bec6
@ -1809,22 +1809,25 @@ compatible version installed will be the provider that is used.
|
||||
``gitfs_ssl_verify``
|
||||
********************
|
||||
|
||||
.. versionchanged:: 2016.11.0
|
||||
|
||||
Default: ``True``
|
||||
|
||||
Specifies whether or not to ignore SSL certificate errors when contacting the
|
||||
remote repository. The ``False`` setting is useful if you're using a
|
||||
git repo that uses a self-signed certificate. However, keep in mind that
|
||||
setting this to anything other ``True`` is a considered insecure, and using an
|
||||
SSH-based transport (if available) may be a better option.
|
||||
|
||||
In the 2016.11.0 release, the default config value changed from ``False`` to
|
||||
``True``.
|
||||
Specifies whether or not to ignore SSL certificate errors when fetching from
|
||||
the repositories configured in :conf_master:`gitfs_remotes`. The ``False``
|
||||
setting is useful if you're using a git repo that uses a self-signed
|
||||
certificate. However, keep in mind that setting this to anything other ``True``
|
||||
is a considered insecure, and using an SSH-based transport (if available) may
|
||||
be a better option.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_ssl_verify: True
|
||||
gitfs_ssl_verify: False
|
||||
|
||||
.. versionchanged:: 2015.8.0
|
||||
This option can now be configured on individual repositories as well. See
|
||||
:ref:`here <gitfs-per-remote-config>` for more info.
|
||||
|
||||
.. versionchanged:: 2016.11.0
|
||||
The default config value changed from ``False`` to ``True``.
|
||||
|
||||
.. conf_master:: gitfs_mountpoint
|
||||
|
||||
@ -1837,8 +1840,8 @@ Default: ``''``
|
||||
|
||||
Specifies a path on the salt fileserver which will be prepended to all files
|
||||
served by gitfs. This option can be used in conjunction with
|
||||
:conf_master:`gitfs_root`. It can also be configured on a per-remote basis, see
|
||||
:ref:`here <gitfs-per-remote-config>` for more info.
|
||||
:conf_master:`gitfs_root`. It can also be configured for an individual
|
||||
repository, see :ref:`here <gitfs-per-remote-config>` for more info.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
@ -1870,8 +1873,8 @@ directories above the one specified will be ignored and the relative path will
|
||||
gitfs_root: somefolder/otherfolder
|
||||
|
||||
.. versionchanged:: 2014.7.0
|
||||
Ability to specify gitfs roots on a per-remote basis was added. See
|
||||
:ref:`here <gitfs-per-remote-config>` for more info.
|
||||
This option can now be configured on individual repositories as well. See
|
||||
:ref:`here <gitfs-per-remote-config>` for more info.
|
||||
|
||||
.. conf_master:: gitfs_base
|
||||
|
||||
@ -1887,9 +1890,8 @@ Defines which branch/tag should be used as the ``base`` environment.
|
||||
gitfs_base: salt
|
||||
|
||||
.. versionchanged:: 2014.7.0
|
||||
|
||||
Ability to specify the base on a per-remote basis was added. See :ref:`here
|
||||
<gitfs-per-remote-config>` for more info.
|
||||
This option can now be configured on individual repositories as well. See
|
||||
:ref:`here <gitfs-per-remote-config>` for more info.
|
||||
|
||||
.. conf_master:: gitfs_saltenv
|
||||
|
||||
@ -2010,6 +2012,11 @@ remotes.
|
||||
|
||||
gitfs_user: git
|
||||
|
||||
.. note::
|
||||
This is is a global configuration option, see :ref:`here
|
||||
<gitfs-per-remote-config>` for examples of configuring it for individual
|
||||
repositories.
|
||||
|
||||
.. conf_master:: gitfs_password
|
||||
|
||||
``gitfs_password``
|
||||
@ -2026,6 +2033,11 @@ This parameter is not required if the repository does not use authentication.
|
||||
|
||||
gitfs_password: mypassword
|
||||
|
||||
.. note::
|
||||
This is is a global configuration option, see :ref:`here
|
||||
<gitfs-per-remote-config>` for examples of configuring it for individual
|
||||
repositories.
|
||||
|
||||
.. conf_master:: gitfs_insecure_auth
|
||||
|
||||
``gitfs_insecure_auth``
|
||||
@ -2042,6 +2054,11 @@ parameter enables authentication over HTTP. **Enable this at your own risk.**
|
||||
|
||||
gitfs_insecure_auth: True
|
||||
|
||||
.. note::
|
||||
This is is a global configuration option, see :ref:`here
|
||||
<gitfs-per-remote-config>` for examples of configuring it for individual
|
||||
repositories.
|
||||
|
||||
.. conf_master:: gitfs_pubkey
|
||||
|
||||
``gitfs_pubkey``
|
||||
@ -2052,14 +2069,18 @@ parameter enables authentication over HTTP. **Enable this at your own risk.**
|
||||
Default: ``''``
|
||||
|
||||
Along with :conf_master:`gitfs_privkey` (and optionally
|
||||
:conf_master:`gitfs_passphrase`), is used to authenticate to SSH remotes. This
|
||||
parameter (or its :ref:`per-remote counterpart <gitfs-per-remote-config>`) is
|
||||
required for SSH remotes.
|
||||
:conf_master:`gitfs_passphrase`), is used to authenticate to SSH remotes.
|
||||
Required for SSH remotes.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_pubkey: /path/to/key.pub
|
||||
|
||||
.. note::
|
||||
This is is a global configuration option, see :ref:`here
|
||||
<gitfs-per-remote-config>` for examples of configuring it for individual
|
||||
repositories.
|
||||
|
||||
.. conf_master:: gitfs_privkey
|
||||
|
||||
``gitfs_privkey``
|
||||
@ -2070,14 +2091,18 @@ required for SSH remotes.
|
||||
Default: ``''``
|
||||
|
||||
Along with :conf_master:`gitfs_pubkey` (and optionally
|
||||
:conf_master:`gitfs_passphrase`), is used to authenticate to SSH remotes. This
|
||||
parameter (or its :ref:`per-remote counterpart <gitfs-per-remote-config>`) is
|
||||
required for SSH remotes.
|
||||
:conf_master:`gitfs_passphrase`), is used to authenticate to SSH remotes.
|
||||
Required for SSH remotes.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
gitfs_privkey: /path/to/key
|
||||
|
||||
.. note::
|
||||
This is is a global configuration option, see :ref:`here
|
||||
<gitfs-per-remote-config>` for examples of configuring it for individual
|
||||
repositories.
|
||||
|
||||
.. conf_master:: gitfs_passphrase
|
||||
|
||||
``gitfs_passphrase``
|
||||
@ -2094,6 +2119,11 @@ authenticate is protected by a passphrase.
|
||||
|
||||
gitfs_passphrase: mypassphrase
|
||||
|
||||
.. note::
|
||||
This is is a global configuration option, see :ref:`here
|
||||
<gitfs-per-remote-config>` for examples of configuring it for individual
|
||||
repositories.
|
||||
|
||||
hg: Mercurial Remote File Server Backend
|
||||
----------------------------------------
|
||||
|
||||
|
||||
@ -373,6 +373,7 @@ configured gitfs remotes):
|
||||
|
||||
* :conf_master:`gitfs_base`
|
||||
* :conf_master:`gitfs_root`
|
||||
* :conf_master:`gitfs_ssl_verify`
|
||||
* :conf_master:`gitfs_mountpoint` (new in 2014.7.0)
|
||||
* :conf_master:`gitfs_user` (**pygit2 only**, new in 2014.7.0)
|
||||
* :conf_master:`gitfs_password` (**pygit2 only**, new in 2014.7.0)
|
||||
@ -395,6 +396,7 @@ tremendous amount of customization. Here's some example usage:
|
||||
- root: salt
|
||||
- mountpoint: salt://bar
|
||||
- base: salt-base
|
||||
- ssl_verify: False
|
||||
- https://foo.com/bar.git:
|
||||
- name: second_bar_repo
|
||||
- root: other/salt
|
||||
|
||||
Loading…
Reference in New Issue
Block a user