diff options
| author | Jimmy Tang <jcftang@gmail.com> | 2015-03-17 10:22:52 +0000 |
|---|---|---|
| committer | Jimmy Tang <jcftang@gmail.com> | 2015-03-17 10:22:52 +0000 |
| commit | ae6357ac178bf842eb583ce9dbd1f1101d06d70c (patch) | |
| tree | ed2edcb57ff80c6c825123bd6c0f79241099393c | |
| parent | 2f62404f3efd4e3ab5d54b33bf71908a0ecb7eaf (diff) | |
| download | bcfg2-ae6357ac178bf842eb583ce9dbd1f1101d06d70c.tar.gz bcfg2-ae6357ac178bf842eb583ce9dbd1f1101d06d70c.tar.bz2 bcfg2-ae6357ac178bf842eb583ce9dbd1f1101d06d70c.zip | |
Add small example for client tools vcs
| -rw-r--r-- | doc/client/tools/vcs.txt | 28 | ||||
| -rw-r--r-- | doc/server/plugins/generators/rules.txt | 5 |
2 files changed, 31 insertions, 2 deletions
diff --git a/doc/client/tools/vcs.txt b/doc/client/tools/vcs.txt index fb9c33684..f21d097ff 100644 --- a/doc/client/tools/vcs.txt +++ b/doc/client/tools/vcs.txt @@ -8,8 +8,34 @@ VCS Client Tool .. warning: This tool is currently under development. -.. note: Currently, the only supported VCS is git. +.. note: Currently, the only supported VCS is git and svn. The VCS tool allows you to checkout particular revisions from a VCS repository on the client to a specified path. The tool requires the appropriate python libraries for the VCS used to be installed. + +See :ref:`server-plugins-generators-rules-vcs` for possible options. + +Example usage: + +You may want to create a `Rules/paths.xml` with the following: + +.. code-block:: xml + + <Rules priority="1"> + <Path name="/srv/bcfg2" type="vcs" + sourceurl="https://github.com/Bcfg2/bcfg2.git" + vcstype="git" + revision="cf6dfd8ca28e941b1e638ff0fa7e7a0a1ebb6a6f"/> + </Rules> + +Once the rule is created a client can reference the path from a +bundle, this path will then be populated from the repository. To +continue the above example, a file `Bundle/bcfg2.xml` might contain +this: + +.. code-block:: xml + + <Bundle name="bcfg"> + <Path name="/srv/bcfg2"> + <Bundle/> diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt index 86478a5ae..e4f47c2bf 100644 --- a/doc/server/plugins/generators/rules.txt +++ b/doc/server/plugins/generators/rules.txt @@ -248,10 +248,13 @@ Manage symlinks. :onlyattrs: to :requiredattrs: to +.. _server-plugins-generators-rules-vcs: + vcs ^^^ -Check out the specified VCS repository to the given path. +Check out the specified VCS repository to the given path. See +:ref:`client-tools-vcs` for more details. .. xml:type:: PathType :nochildren: |