Merge pull request saltstack#16666 from terminalmage/release-notes-helium

thatch45 · thatch45 · commit cce7dbd69ff3 · 2014-10-16T16:48:08.000-06:00
Add new fileserver features to helium release notes
diff --git a/doc/ref/configuration/master.rst b/doc/ref/configuration/master.rst
@@ -1584,9 +1584,9 @@ also be configured on a per-remote basis, see :conf_master:`here
 
 Default: ``tags``
 
-Path relative to the root of the repository where the tags is located. Can also
-be configured on a per-remote basis, see :conf_master:`here <svnfs_remotes>`
-for more info.
+Path relative to the root of the repository where the tags are located. Can
+also be configured on a per-remote basis, see :conf_master:`here
+<svnfs_remotes>` for more info.
 
 .. code-block:: yaml
 
diff --git a/doc/ref/configuration/minion.rst b/doc/ref/configuration/minion.rst
@@ -396,7 +396,7 @@ able to change these settings. If all minions have the same values and the setup
 quite large (several thousand minions), they will still flood the master. The desired
 behavior is to have time-frame within all minions try to reconnect.
 
-.. code-block:: ymal
+.. code-block:: yaml
 
     recon_randomize: True
 
diff --git a/doc/topics/releases/2014.7.0.rst b/doc/topics/releases/2014.7.0.rst
@@ -39,10 +39,10 @@ features like the ansible roster and fileserver backends to the new pypi
 salt-ssh installer to lowered deps and a swath of bugfixes, salt-ssh is
 basically reborn!
 
-Pip install salt-ssh
---------------------
+Install salt-ssh Using pip
+--------------------------
 
-Salt ssh is now pip installable!
+salt-ssh is now pip-installable!
 
 https://pypi.python.org/pypi/salt-ssh/
 
@@ -91,26 +91,28 @@ State System Enhancements
 New Imperative State Keyword "Listen"
 -------------------------------------
 
-The new listen keyword allows for completely imperative states by calling the
-mod_watch routine after all states have run instead of re-ordering the states.
+The new ``listen`` keyword allows for completely imperative states by calling
+the ``mod_watch()`` routine after all states have run instead of re-ordering
+the states.
 
 Mod Aggregate Runtime Manipulator
 ---------------------------------
 
-The new mod_aggregate system allows for the state system to rewrite the state
-data during execution. This allows for state definitions to be aggregated
+The new ``mod_aggregate`` system allows for the state system to rewrite the
+state data during execution. This allows for state definitions to be aggregated
 dynamically at runtime.
 
-The best example is found in the pkg state. If mod_aggregate is turned on,
-then when the first pkg state is reached the state system will scan all of the
-other running states for pkg states and take all other packages set for install
-and install them all at once in the first pkg state.
+The best example is found in the :mod:`pkg <salt.states.pkg>` state. If
+``mod_aggregate`` is turned on, then when the first pkg state is reached the
+state system will scan all of the other running states for pkg states and take
+all other packages set for install and install them all at once in the first
+pkg state.
 
-These runtime modifications make it easy groups of states together, in future
-versions we hope to fill out the mod_aggregate system to build in more and
-more optimizations.
+These runtime modifications make it easy to run groups of states together. In
+future versions, we hope to fill out the ``mod_aggregate`` system to build in
+more and more optimizations.
 
-For more documentation on mod_aggregate, see :doc:`the documentation
+For more documentation on ``mod_aggregate``, see :doc:`the documentation
 </ref/states/aggregate>`.
 
 New Requisites: onchanges and onfail
@@ -162,9 +164,10 @@ like CentOS and Scientific.
 Fileserver Backends in salt-call
 --------------------------------
 
-Standalone modes just got easier, now fileserver backends like gitfs can be
-used without a salt master! Just add the fileserver backend configuration to
-the minion config and execute salt-call.
+Fileserver backends like gitfs can now be used without a salt master! Just add
+the fileserver backend configuration to the minion config and execute
+salt-call. This has been a much-requested feature and we are heppy to finally
+bring it to our users.
 
 Amazon Execution Modules
 ------------------------
@@ -234,13 +237,146 @@ Managing Chef with Salt just got even easier!
 Fileserver Backend Enhancements
 -------------------------------
 
-All of the fileserver backends have been overhauled to be faster, lighter and more reliable
+All of the fileserver backends have been overhauled to be faster, lighter and
+more reliable. The VCS backends (:mod:`gitfs <salt.fileserver.gitfs>`,
+:mod:`hgfs <salt.fileserver.hgfs>`, and :mod:`svnfs <salt.fileserver.svnfs>`)
+have also received a **lot** of new features.
+
+Additionally, most config parameters for the VCS backends can now be configured
+on a per-remote basis, allowing for global config parameters to be overridden
+for a specific gitfs/hgfs/svnfs remote.
+
+
+New :mod:`gitfs <salt.fileserver.gitfs>` Features
+*************************************************
+
+Pygit2 and Dulwich
+~~~~~~~~~~~~~~~~~~
+
+In addition to supporting GitPython, support for pygit2_ (0.20.3 and newer) and
+dulwich_ have been added. Provided a compatible version of pygit2_ is
+installed, it will now be the default provider. The config parameter
+:conf_master:`gitfs_provider` has been added to allow one to choose a specific
+provider for gitfs.
+
+.. _pygit2: https://github.com/libgit2/pygit2
+.. _dulwich: https://www.samba.org/~jelmer/dulwich/
+
+.. _2014.7.0-gitfs-mountpoints:
+
+Mountpoints
+~~~~~~~~~~~
+
+Prior to this release, to serve a file from gitfs at a salt fileserver URL of
+``salt://foo/bar/baz.txt``, it was necessary to ensure that the parent
+directories existed in the repository. A new config parameter
+:conf_master:`gitfs_mountpoint` allows gitfs remotes to be exposed starting at
+a user-defined ``salt://`` URL.
+
+.. _2014.7.0-gitfs-whitelist-blacklist:
+
+Environment Whitelisting/Blacklisting
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, gitfs will expose all branches and tags as Salt fileserver
+environments. Two new config parameters, :conf_master:`gitfs_env_whitelist` and
+:conf_master:`gitfs_env_blacklist`, allow more control over which branches and
+tags are exposed. More detailed information on how these two options work can
+be found in the :ref:`Gitfs Walkthrough <gitfs-whitelist-blacklist>`.
+
+Expanded Authentication Support
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+As of pygit2_ 0.20.3, both http(s) and SSH key authentication are supported,
+and Salt now also supports both authentication methods when using pygit2_. Keep
+in mind that pygit2_ 0.20.3 is not yet available on many platforms, so those
+who had been using authenticated git repositories with a passphraseless key
+should stick to GitPython if a new enough pygit2_ is not yet available for the
+platform on which the master is running.
+
+A full explanation of how to use authentication can be found in the :ref:`Gitfs
+Walkthrough <gitfs-authentication>`.
+
+
+New :mod:`hgfs <salt.fileserver.hgfs>` Features
+***********************************************
+
+Mountpoints
+~~~~~~~~~~~
+
+This feature works exactly like its :ref:`gitfs counterpart
+<2014.7.0-gitfs-mountpoints>`. The new config parameter is called
+:conf_master:`hgfs_mountpoint`.
+
+Environment Whitelisting/Blacklisting
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This feature works exactly like its :ref:`gitfs counterpart
+<2014.7.0-gitfs-whitelist-blacklist>`. The new config parameters are called
+:conf_master:`hgfs_env_whitelist` and :conf_master:`hgfs_env_blacklist`.
+
+
+New :mod:`svnfs <salt.fileserver.svnfs>` Features
+*************************************************
+
+Mountpoints
+~~~~~~~~~~~
+
+This feature works exactly like its :ref:`gitfs counterpart
+<2014.7.0-gitfs-mountpoints>`. The new config parameter is called
+:conf_master:`svnfs_mountpoint`.
+
+Environment Whitelisting/Blacklisting
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This feature works exactly like its :ref:`gitfs counterpart
+<2014.7.0-gitfs-whitelist-blacklist>`. The new config parameters are called
+:conf_master:`svnfs_env_whitelist` and :conf_master:`svnfs_env_blacklist`.
+
+Configurable Trunk/Branches/Tags Paths
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Prior to this release, the paths where trunk, branches, and tags were located
+could only be in directores named "trunk", "branches", and "tags" directly
+under the root of the repository. Three new config parameters
+(:conf_master:`svnfs_trunk`, :conf_master:`svnfs_branches`, and
+:conf_master:`svnfs_tags`) allow SVN repositories which are laid out
+differently to be used with svnfs.
+
+New :mod:`minionfs <salt.fileserver.minionfs>` Features
+*******************************************************
+
+Mountpoint
+~~~~~~~~~~
+
+This feature works exactly like its :ref:`gitfs counterpart
+<2014.7.0-gitfs-mountpoints>`. The new config parameter is called
+:conf_master:`minionfs_mountpoint`. The one major difference is that, as
+minionfs doesn't use multiple remotes (it just serves up files pushed to the
+master using :mod:`cp.push <salt.modules.cp.push>`) there is no such thing as a
+per-remote configuration for :conf_master:`minionfs_mountpoint`.
+
+Changing the Saltenv from Which Files are Served
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A new config parameter (:conf_master:`minionfs_env`) allows minionfs files to
+be served from a Salt fileserver environment other than ``base``.
+
+Minion Whitelisting/Blacklisting
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default, minionfs will expose the pushed files from all minions. Two new
+config parameters, :conf_master:`minionfs_whitelist` and
+:conf_master:`minionfs_blacklist`, allow minionfs to be restricted to serve
+files from only the desired minions.
+
 
 Pyobjects Renderer
 ------------------
 
-Salt now ships with with the :mod:`Pyobjects Renderer <salt.renderers.pyobjects>` that
-allows for construction of States using pure Python with an idiomatic object interface.
+Salt now ships with with the :mod:`Pyobjects Renderer
+<salt.renderers.pyobjects>` that allows for construction of States using pure
+Python with an idiomatic object interface.
 
 New Modules
 ===========
diff --git a/doc/topics/tutorials/intro_scale.rst b/doc/topics/tutorials/intro_scale.rst
@@ -146,7 +146,7 @@ reconnect x: etc.
 
 With a thousand minions this will mean
 
-.. code-block:: math
+.. code-block:: text
 
     1000/60 = ~16
 
@@ -228,7 +228,7 @@ the retention time defined by
 
     keep_jobs: 24
 
-.. code-block:: math
+.. code-block:: text
 
     250 jobs/day * 2000 minions returns = 500.000 files a day
 
diff --git a/salt/fileserver/gitfs.py b/salt/fileserver/gitfs.py
@@ -17,6 +17,9 @@
 An optional master config parameter (:conf_master:`gitfs_provider`) can be used
 to specify which provider should be used.
 
+More detailed information on how to use gitfs can be found in the :ref:`Gitfs
+Walkthrough <tutorial-gitfs>`.
+
 .. note:: Minimum requirements
 
     To use GitPython_ for gitfs requires a minimum GitPython version of 0.3.0,
@@ -32,21 +35,10 @@
     To find stale refs, pygit2 additionally requires the git CLI utility to be
     installed.
 
-.. warning::
-
-    pygit2_ does not yet support supplying passing SSH credentials, so at
-    this time only ``http://``, ``https://``, and ``file://`` URLs are
-    supported as valid :conf_master:`gitfs_remotes` entries if pygit2 is being
-    used.
-
-    Additionally, pygit2_ does not yet support passing http/https credentials
-    via a `.netrc`_ file.
-
 .. _GitPython: https://github.com/gitpython-developers/GitPython
 .. _pygit2: https://github.com/libgit2/pygit2
 .. _libgit2: https://libgit2.github.com/
 .. _dulwich: https://www.samba.org/~jelmer/dulwich/
-.. _.netrc: https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-File.html
 '''
 
 # Import python libs
