valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 17:09:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add clarification docs on a common git_pillar misconfiguration

Browse Source
This commit is contained in:
Erik Johnson 2016-08-01 18:54:50 -05:00
parent 88a9fb1b31
commit 5951554e9f
1 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
salt/pillar/git_pillar.py
View File

@ -39,6 +39,17 @@ the repo's URL. Configuration details can be found below.
'dev-*': 'dev-*':
- bar - bar
Additionally, while git_pillar allows for the branch/tag to be overridden
(see :ref:`here <git-pillar-env-remap>`, or :ref:`here
<git-pillar-env-remap-legacy>` for Salt releases before 2015.8.0), keep in
mind that the top file must reference the actual environment name. It is
common practice to make the environment in a git_pillar top file match the
branch/tag name, but when remapping, the environment of course no longer
matches the branch/tag, and the top file needs to be adjusted accordingly.
When expected Pillar values configured in git_pillar are missing, this is a
common misconfiguration that may be to blame, and is a good first step in
troubleshooting.
.. _git-pillar-pre-2015-8-0: .. _git-pillar-pre-2015-8-0:
Configuring git_pillar for Salt releases before 2015.8.0 Configuring git_pillar for Salt releases before 2015.8.0
@ -68,6 +79,8 @@ specified under :conf_master:`ext_pillar`:
- git: master https://gitserver/git-pillar.git - git: master https://gitserver/git-pillar.git
- git: dev https://gitserver/git-pillar.git - git: dev https://gitserver/git-pillar.git
.. _git-pillar-env-remap-legacy:
To remap a specific branch to a specific Pillar environment, use the format To remap a specific branch to a specific Pillar environment, use the format
``<branch>:<env>``: ``<branch>:<env>``:
@ -178,6 +191,18 @@ Per-remote configuration parameters are supported (similar to :ref:`gitfs
<gitfs-per-remote-config>`), and global versions of the git_pillar <gitfs-per-remote-config>`), and global versions of the git_pillar
configuration parameters can also be set. configuration parameters can also be set.
.. _git-pillar-env-remap:
To remap a specific branch to a specific Pillar environment, use the ``env``
per-remote parameter:
.. code-block:: yaml
ext_pillar:
- git:
- production https://gitserver/git-pillar.git:
- env: prod
With the addition of pygit2_ support, git_pillar can now interact with With the addition of pygit2_ support, git_pillar can now interact with
authenticated remotes. Authentication works just like in gitfs (as outlined in authenticated remotes. Authentication works just like in gitfs (as outlined in
the :ref:`Git Fileserver Backend Walkthrough <gitfs-authentication>`), only the :ref:`Git Fileserver Backend Walkthrough <gitfs-authentication>`), only
@ -186,10 +211,9 @@ instead of ``gitfs`` (e.g. :conf_master:`git_pillar_pubkey`,
:conf_master:`git_pillar_privkey`, :conf_master:`git_pillar_passphrase`, etc.). :conf_master:`git_pillar_privkey`, :conf_master:`git_pillar_passphrase`, etc.).
.. note:: .. note::
The ``name`` parameter can be used to further differentiate between two The ``name`` parameter can be used to further differentiate between two
remotes with the same URL. If you're using two remotes with the same URL, remotes with the same URL and branch. When using two remotes with the same
the ``name`` option is required. URL, the ``name`` option is required.
.. _GitPython: https://github.com/gitpython-developers/GitPython .. _GitPython: https://github.com/gitpython-developers/GitPython
.. _pygit2: https://github.com/libgit2/pygit2 .. _pygit2: https://github.com/libgit2/pygit2