Add pointer for Puppet SSH approach
authorBruce Williams <bruce@codefluency.com>
Sun, 14 Mar 2010 10:00:37 +0000 (03:00 -0700)
committerBruce Williams <bruce@codefluency.com>
Sun, 14 Mar 2010 10:00:37 +0000 (03:00 -0700)
README.BZR.markdown
README.CVS.markdown
README.GIT.markdown
README.HG.markdown
README.SVN.markdown

index a7494db..6672e79 100644 (file)
@@ -32,7 +32,16 @@ For a specific revision, use `revision` with a valid revisionspec
         revision => 'menesis@pov.lt-20100309191856-4wmfqzc803fj300x'
     }
 
+For sources that use SSH (eg, `bzr+ssh://...`, `sftp://...`)
+------------------------------------------------------------
+
+Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
+to ensure they are present.  For more information, see the `require`
+metaparameter documentation[1].
+
 More Examples
 -------------
 
 For examples you can run, see `examples/bzr/`
+
+[1]: http://docs.reductivelabs.com/references/stable/metaparameter.html#require
index 7f9647e..321c865 100644 (file)
@@ -40,3 +40,17 @@ For a specific tag, use `revision`:
         source => ":pserver:anonymous@example.com:/sources/myproj",
         revision => "SOMETAG"
     }
+
+For sources that use SSH
+------------------------
+
+Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
+to ensure they are present.  For more information, see the `require`
+metaparameter documentation[1].
+
+More Examples
+-------------
+
+For examples you can run, see `examples/cvs/`
+
+[1]: http://docs.reductivelabs.com/references/stable/metaparameter.html#require
index 4e3c095..04ac05b 100644 (file)
@@ -47,3 +47,17 @@ For a specific revision (can be a commit SHA or tag):
         revision => '1.1.2rc1'
     }
 
+For sources that use SSH (eg, `username@server:...`)
+----------------------------------------------------
+
+Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
+to ensure they are present.  For more information, see the `require`
+metaparameter documentation[1].
+
+More Examples
+-------------
+
+For examples you can run, see `examples/git/`
+
+[1]: http://docs.reductivelabs.com/references/stable/metaparameter.html#require
+
index e96db89..670d062 100644 (file)
@@ -39,3 +39,17 @@ You can also set `revision` to a tag:
         source   => "http://hg.example.com/myrepo"
         revision => '1.1.2'
     }
+
+For sources that use SSH (eg, `ssh://...`)
+------------------------------------------
+
+Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
+to ensure they are present.  For more information, see the `require`
+metaparameter documentation[1].
+
+More Examples
+-------------
+
+For examples you can run, see `examples/hg/`
+
+[1]: http://docs.reductivelabs.com/references/stable/metaparameter.html#require
index 30aaf54..3dc852f 100644 (file)
@@ -1,2 +1,47 @@
 Using vcsrepo with Subversion
 =============================
+
+To create a blank repository
+----------------------------
+
+To create a blank repository suitable for use as a central repository,
+define a `vcsrepo` without a `source` or `revision`:
+
+    vcsrepo { "/path/to/repo":
+      ensure   => present,
+      provider => svn
+    }
+
+To checkout from a repository
+-----------------------------
+
+Provide a `source` qualified to the branch/tag you want:
+
+    vcsrepo { "/path/to/repo":
+        ensure   => present,
+        provider => svn,
+        source   => "svn://svnrepo/hello/branches/foo"
+    }
+
+You can provide a specific `revision`:
+
+    vcsrepo { "/path/to/repo":
+        ensure   => present,
+        provider => svn,
+        source   => "svn://svnrepo/hello/branches/foo",
+        revision => '1234'
+    }
+
+For sources that use SSH (eg, `svn+ssh://...`)
+----------------------------------------------
+
+Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
+to ensure they are present.  For more information, see the `require`
+metaparameter documentation[1].
+
+More Examples
+-------------
+
+For examples you can run, see `examples/svn/`
+
+[1]: http://docs.reductivelabs.com/references/stable/metaparameter.html#require