Merge remote-tracking branch 'puppetlabs/master'
[puppet_vcsrepo.git] / README.markdown
index 575950c..ee4fedd 100644 (file)
-#vcsrepo
+# vcsrepo
 
-[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-vcsrepo.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-vcsrepo)
-
-####Table of Contents
+#### Table of contents
 
 1. [Overview](#overview)
 2. [Module Description - What the module does and why it is useful](#module-description)
 3. [Setup - The basics of getting started with vcsrepo](#setup)
+    * [Setup requirements](#setup-requirements)
     * [Beginning with vcsrepo](#beginning-with-vcsrepo)
 4. [Usage - Configuration options and additional functionality](#usage)
+    * [Git](#git)
     * [Bazaar](#bazaar)
     * [CVS](#cvs)
-    * [Git](#git)
     * [Mercurial](#mercurial)
     * [Perforce](#perforce)
-    * [Subversion](#subversion)  
+    * [Subversion](#subversion)
 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
     * [Type: vcsrepo](#type-vcsrepo)
         * [Providers](#providers)
         * [Features](#features)
         * [Parameters](#parameters)
-        * [Features and Parameters by Provider](#features-and-parameters-by-provider)
 5. [Limitations - OS compatibility, etc.](#limitations)
 6. [Development - Guide for contributing to the module](#development)
 
-##Overview
-
-The vcsrepo module allows you to use Puppet to easily deploy content from your version control system (VCS).
-
-##Module Description
-
-This module provides a single type with providers for each VCS, which can be used to describe: 
-
-* A working copy checked out from a (remote or local) source, at an
-  arbitrary revision
-* A blank working copy not associated with a source (when it makes
-  sense for the VCS being used)
-* A blank central repository (when the distinction makes sense for the VCS
-  being used)   
-
-##Setup
-
-###Beginning with vcsrepo      
+## Overview
 
-To get started with the vcsrepo module, you must simply define the type `vcsrepo` with a path to your repository and the [type of VCS](#Usage) you're using in `provider` (in the below example, Git). 
+The vcsrepo module lets you use Puppet to easily deploy content from your version control system (VCS).
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => git,
-    }
+## Module description
 
-##Usage
+The vcsrepo module provides a single type with providers to support the following version control systems:
 
-The vcsrepo module works with the following VCSs:
+* [Git](#git)
+* [Bazaar](#bazaar)
+* [CVS](#cvs)
+* [Mercurial](#mercurial)
+* [Perforce](#perforce)
+* [Subversion](#subversion)
 
-* [Bazaar (bzr)](#bazaar)
-* [CVS (cvs)](#cvs)
-* [Git (git)](#git)
-* [Mercurial (hg)](#mercurial)
-* [Perforce (p4)](#perforce)
-* [Subversion (svn)](#subversion)
+**Note:** `git` is the only vcs provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
 
-###Bazaar
+## Setup
 
-#####Create a blank repository
+### Setup requirements
 
-To create a blank repository suitable for use as a central repository,
-define `vcsrepo` without `source` or `revision`.
+The vcsrepo module does not install any VCS software for you. You must install a VCS before you can use this module.
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => bzr,
-    }
+Like Puppet in general, the vcsrepo module does not automatically create parent directories for the files it manages. Set up any needed directory structures before you start.
 
-#####Branch from an existing repository
+### Beginning with vcsrepo
 
-Provide the `source` location to branch from an existing repository.
+To create and manage a blank repository, define the type `vcsrepo` with a path to your repository and supply the `provider` parameter based on the [VCS you're using](#usage).
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => bzr,
-      source   => 'lp:myproj',
-    }
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => git,
+}
+~~~
 
-For a specific revision, use `revision` with a valid revisionspec
-(see `bzr help revisionspec` for more information on formatting a revision).
+## Usage
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => bzr,
-      source   => 'lp:myproj',
-      revision => 'menesis@pov.lt-20100309191856-4wmfqzc803fj300x',
-    }
+**Note:** `git` is the only vcsrepo provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
 
-#####Sources that use SSH
+### Git
 
-When your source uses SSH, for instance 'bzr+ssh://...' or 'sftp://...,'
-you can manage your SSH keys with Puppet using the [require](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) metaparameter in `vcsrepo` to ensure they are present.
-  
-#####Further examples
+#### Create a blank repository
 
-For more examples using Bazaar, see `examples/bzr/`.
+To create a blank repository suitable for use as a central repository, define `vcsrepo` without `source` or `revision`:
 
-###CVS
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => git,
+}
+~~~
 
-#####To create a blank repository
+If you're managing a central or official repository, you might want to make it a bare repository. To do this, set `ensure` to 'bare':
 
-To create a blank repository suitable for use as a central repository,
-define `vcsrepo` without `source` or `revision`.
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => bare,
+  provider => git,
+}
+~~~
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => cvs,
-    }
+#### Clone/pull a repository
 
-#####To checkout/update from a repository
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => git,
+  source   => 'git://example.com/repo.git',
+}
+~~~
 
-To get the current mainline,
+To clone your repository as bare or mirror, you can set `ensure` to 'bare' or 'mirror':
 
-    vcsrepo { "/path/to/workspace":
-      ensure   => present,
-      provider => cvs,
-      source   => ":pserver:anonymous@example.com:/sources/myproj",
-    }
-    
-To get a specific module on the current mainline,
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => mirror,
+  provider => git,
+  source   => 'git://example.com/repo.git',
+}
+~~~
 
-    vcsrepo {"/vagrant/lockss-daemon-source":
-      ensure   => present,
-      provider => cvs,
-      source   => ":pserver:anonymous@lockss.cvs.sourceforge.net:/cvsroot/lockss",
-      module   => "lockss-daemon",
-    }
+By default, `vcsrepo` will use the HEAD of the source repository's master branch. To use another branch or a specific commit, set `revision` to either a branch name or a commit SHA or tag.
 
+Branch name:
 
-You can use the `compression` parameter to set the GZIP compression levels for your repository history.
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => git,
+  source   => 'git://example.com/repo.git',
+  revision => 'development',
+}
+~~~
 
-    vcsrepo { "/path/to/workspace":
-      ensure      => present,
-      provider    => cvs,
-      compression => 3,
-      source      => ":pserver:anonymous@example.com:/sources/myproj",
-    }
+SHA:
 
-For a specific tag, use `revision`.
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => git,
+  source   => 'git://example.com/repo.git',
+  revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
+}
+~~~
 
-    vcsrepo { "/path/to/workspace":
-      ensure      => present,
-      provider    => cvs,
-      compression => 3,
-      source      => ":pserver:anonymous@example.com:/sources/myproj",
-      revision    => "SOMETAG",
-    }
+Tag:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => git,
+  source   => 'git://example.com/repo.git',
+  revision => '1.1.2rc1',
+}
+~~~
+
+To check out a branch as a specific user, supply the `user` parameter:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => git,
+  source   => 'git://example.com/repo.git',
+  revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
+  user     => 'someUser',
+}
+~~~
+
+To keep the repository at the latest revision, set `ensure` to 'latest'.
+
+**WARNING:** This overwrites any local changes to the repository.
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => latest,
+  provider => git,
+  source   => 'git://example.com/repo.git',
+  revision => 'master',
+}
+~~~
+
+To clone the repository but skip initializing submodules, set `submodules` to 'false':
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure     => latest,
+  provider   => git,
+  source     => 'git://example.com/repo.git',
+  submodules => false,
+}
+~~~
+
+#### Use multiple remotes with a repository
+
+In place of a single string, you can set `source` to a hash of one or more name => URL pairs:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => git,
+  remote   => 'origin'
+  source   => {
+    'origin'       => 'https://github.com/puppetlabs/puppetlabs-vcsrepo.git',
+    'other_remote' => 'https://github.com/other_user/puppetlabs-vcsrepo.git'
+  },
+}
+~~~
+
+**Note:** If you set `source` to a hash, one of the names you specify must match the value of the `remote` parameter. That remote serves as the upstream of your managed repository.
+
+#### Connect via SSH
+
+To connect to your source repository via SSH (such as 'username@server:…'), we recommend managing your SSH keys with Puppet and using the [`require`](http://docs.puppet.com/references/stable/metaparameter.html#require) metaparameter to make sure they are present before the `vcsrepo` resource is applied.
+
+To use SSH keys associated with a user, specify the username in the `user` parameter:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => latest,
+  provider => git,
+  source   => 'git://username@example.com/repo.git',
+  user     => 'toto', #uses toto's $HOME/.ssh setup
+  require  => File['/home/toto/.ssh/id_rsa'],
+}
+~~~
+
+### Bazaar
+
+#### Create a blank repository
+
+To create a blank repository, suitable for use as a central repository, define `vcsrepo` without `source` or `revision`:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => bzr,
+}
+~~~
+
+#### Branch from an existing repository
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => bzr,
+  source   => '/some/path',
+}
+~~~
+
+To branch from a specific revision, set `revision` to a valid [Bazaar revision spec](http://wiki.bazaar.canonical.com/BzrRevisionSpec):
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => bzr,
+  source   => '/some/path',
+  revision => 'menesis@pov.lt-20100309191856-4wmfqzc803fj300x',
+}
+~~~
+
+#### Connect via SSH
+
+To connect to your source repository via SSH (such as `'bzr+ssh://...'` or `'sftp://...,'`), we recommend using the [`require`](http://docs.puppet.com/references/stable/metaparameter.html#require) metaparameter to make sure your SSH keys are present before the `vcsrepo` resource is applied:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => latest,
+  provider => bzr,
+  source   => 'bzr+ssh://bzr.example.com/some/path',
+  user     => 'toto', #uses toto's $HOME/.ssh setup
+  require  => File['/home/toto/.ssh/id_rsa'],
+}
+~~~
+
+### CVS
+
+#### Create a blank repository
+
+To create a blank repository suitable for use as a central repository, define `vcsrepo` without `source` or `revision`:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => cvs,
+}
+~~~
+
+#### Checkout/update from a repository
+
+~~~ puppet
+vcsrepo { '/path/to/workspace':
+  ensure   => present,
+  provider => cvs,
+  source   => ':pserver:anonymous@example.com:/sources/myproj',
+}
+~~~
+
+To get a specific module on the current mainline, supply the `module` parameter:
+
+~~~ puppet
+vcsrepo { '/vagrant/lockss-daemon-source':
+  ensure   => present,
+  provider => cvs,
+  source   => ':pserver:anonymous@lockss.cvs.sourceforge.net:/cvsroot/lockss',
+  module   => 'lockss-daemon',
+}
+~~~
+
+To set the GZIP compression levels for your repository history, use the `compression` parameter:
+
+~~~ puppet
+vcsrepo { '/path/to/workspace':
+  ensure      => present,
+  provider    => cvs,
+  compression => 3,
+  source      => ':pserver:anonymous@example.com:/sources/myproj',
+}
+~~~
+
+To get a specific revision, set `revision` to the revision number.
+
+~~~ puppet
+vcsrepo { '/path/to/workspace':
+  ensure      => present,
+  provider    => cvs,
+  compression => 3,
+  source      => ':pserver:anonymous@example.com:/sources/myproj',
+  revision    => '1.2',
+}
+~~~
+
+You can also set `revision` to a tag:
+
+~~~ puppet
+vcsrepo { '/path/to/workspace':
+  ensure      => present,
+  provider    => cvs,
+  compression => 3,
+  source      => ':pserver:anonymous@example.com:/sources/myproj',
+  revision    => 'SOMETAG',
+}
+~~~
+
+#### Connect via SSH
+
+To connect to your source repository via SSH, we recommend using the [`require`](http://docs.puppet.com/references/stable/metaparameter.html#require) metaparameter to make sure your SSH keys are present before the `vcsrepo` resource is applied:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => latest,
+  provider => cvs,
+  source   => ':pserver:anonymous@example.com:/sources/myproj',
+  user     => 'toto', #uses toto's $HOME/.ssh setup
+  require  => File['/home/toto/.ssh/id_rsa'],
+}
+~~~
+
+### Mercurial
+
+#### Create a blank repository
+
+To create a blank repository suitable for use as a central repository, define `vcsrepo` without `source` or `revision`:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => hg,
+}
+~~~
+
+#### Clone/pull and update a repository
+
+To get the default branch tip:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => hg,
+  source   => 'http://hg.example.com/myrepo',
+}
+~~~
+
+For a specific changeset, use `revision`:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => hg,
+  source   => 'http://hg.example.com/myrepo',
+  revision => '21ea4598c962',
+}
+~~~
+
+You can also set `revision` to a tag:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => hg,
+  source   => 'http://hg.example.com/myrepo',
+  revision => '1.1.2',
+}
+~~~
+
+To check out as a specific user:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => hg,
+  source   => 'http://hg.example.com/myrepo',
+  user     => 'user',
+}
+~~~
+
+To specify an SSH identity key:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => hg,
+  source   => 'ssh://hg@hg.example.com/myrepo',
+  identity => '/home/user/.ssh/id_dsa1,
+}
+~~~
+
+To specify a username and password for HTTP Basic authentication:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure              => latest,
+  provider            => hg,
+  source              => 'http://hg.example.com/myrepo',
+  basic_auth_username => 'hgusername',
+  basic_auth_password => 'hgpassword',
+}
+~~~
+
+#### Connect via SSH
+
+To connect to your source repository via SSH (such as `'ssh://...'`), we recommend using the [`require` metaparameter](http://docs.puppet.com/references/stable/metaparameter.html#require) to make sure your SSH keys are present before the `vcsrepo` resource is applied:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => latest,
+  provider => hg,
+  source   => 'ssh://hg.example.com//path/to/myrepo',
+  user     => 'toto', #uses toto's $HOME/.ssh setup
+  require  => File['/home/toto/.ssh/id_rsa'],
+}
+~~~
+
+### Perforce
+
+#### Create an empty workspace
+
+To set up the connection to your Perforce service, set `p4config` to the location of a valid Perforce [config file](http://www.perforce.com/perforce/doc.current/manuals/p4guide/chapter.configuration.html#configuration.process.configfiles) stored on the node:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => p4,
+  p4config => '/root/.p4config'
+}
+~~~
+
+**Note:** If you don't include the `P4CLIENT` setting in your config file, the provider generates a workspace name based on the digest of `path` and the node's hostname (such as `puppet-91bc00640c4e5a17787286acbe2c021c`).
+
+#### Create/update and sync a Perforce workspace
+
+To sync a depot path to head, set `ensure` to 'latest':
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => latest,
+  provider => p4,
+  source   => '//depot/branch/...'
+}
+~~~
+
+To sync to a specific changelist, specify its revision number with the `revision` parameter:
+
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => p4,
+  source   => '//depot/branch/...',
+  revision => '2341'
+}
+~~~
 
-#####Sources that use SSH
-
-When your source uses SSH, you can manage your SSH keys with Puppet using the [require](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) metaparameter in `vcsrepo` to ensure they are present.
-
-#####Further examples
-
-For for more examples using CVS, see `examples/cvs/`.
-
-###Git
-
-#####To create a blank repository
-
-To create a blank repository suitable for use as a central repository,
-define `vcsrepo` without `source` or `revision`.
+You can also set `revision` to a label:
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => git,
-    }
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => p4,
+  source   => '//depot/branch/...',
+  revision => 'my_label'
+}
+~~~
 
-If you're defining `vcsrepo` for a central or official repository, you may want to make it a bare repository.  You do this by setting `ensure` to 'bare' rather than 'present'.
+### Subversion
 
-    vcsrepo { "/path/to/repo":
-      ensure   => bare,
-      provider => git,
-    }
+#### Create a blank repository
 
-#####To clone/pull a repository
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => svn,
+}
+~~~
 
-To get the current HEAD on the master branch,
+#### Check out from an existing repository
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => git,
-      source   => "git://example.com/repo.git",
-    }
+Provide a `source` pointing to the branch or tag you want to check out:
 
-To get a specific revision or branch (can be a commit SHA, tag, or branch name),
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => svn,
+  source   => 'svn://svnrepo/hello/branches/foo',
+}
+~~~
 
- **SHA**
+You can also designate a specific revision:
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => git,
-      source   => 'git://example.com/repo.git',
-      revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
-    }
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => present,
+  provider => svn,
+  source   => 'svn://svnrepo/hello/branches/foo',
+  revision => '1234',
+}
+~~~
 
-**Tag**
+#### Use a specific Subversion configuration directory
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => git,
-      source   => 'git://example.com/repo.git',
-      revision => '1.1.2rc1',
-    }
+Use the `configuration` parameter to designate the directory that contains your Subversion configuration files (typically, '/path/to/.subversion'):
 
-**Branch name**
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure        => present,
+  provider      => svn,
+  source        => 'svn://svnrepo/hello/branches/foo',
+  configuration => '/path/to/.subversion',
+}
+~~~
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => git,
-      source   => 'git://example.com/repo.git',
-      revision => 'development',
-    }
+#### Connect via SSH
 
-To check out a branch as a specific user,
+To connect to your source repository via SSH (such as `'svn+ssh://...'`), we recommend using the [`require` metaparameter](http://docs.puppet.com/references/stable/metaparameter.html#require) to make sure your SSH keys are present before the `vcsrepo` resource is applied:
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => git,
-      source   => 'git://example.com/repo.git',
-      revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
-      user     => 'someUser',
-    }
+~~~ puppet
+vcsrepo { '/path/to/repo':
+  ensure   => latest,
+  provider => svn,
+  source   => 'svn+ssh://svnrepo/hello/branches/foo',
+  user     => 'toto', #uses toto's $HOME/.ssh setup
+  require  => File['/home/toto/.ssh/id_rsa'],
+}
+~~~
 
-To keep the repository at the latest revision (**WARNING:** this will always overwrite local changes to the repository),
+## Reference
 
-    vcsrepo { "/path/to/repo":
-      ensure   => latest,
-      provider => git,
-      source   => 'git://example.com/repo.git',
-      revision => 'master',
-    }
+### Type: vcsrepo
 
-#####Sources that use SSH
+The vcsrepo module adds only one type with several providers. Each provider abstracts a different VCS, and each provider includes a set of features according to its needs.
 
-When your source uses SSH, such as 'username@server:…', you can manage your SSH keys with Puppet using the [require](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) metaparameter in `vcsrepo` to ensure they are present.
+#### Providers
 
-For SSH keys associated with a user, enter the username in the `user` parameter. Doing so will use that user's keys.
+**Note:** Not all features are available with all providers.
 
-    user => 'toto'  # will use toto's $HOME/.ssh setup
+##### `git` - Supports the Git VCS.
 
-#####Further Examples
+Features: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `submodules`, `user`
 
-For more examples using Git, see `examples/git/`.
+Parameters: `depth`, `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `remote`, `revision`, `source`, `user`
 
-###Mercurial
+##### `bzr` - Supports the Bazaar VCS.
 
-#####To create a blank repository
+Features: `reference_tracking`
 
-To create a blank repository suitable for use as a central repository,
-define `vcsrepo` without `source` or `revision`.
+Parameters: `ensure`, `excludes`, `force`, `group`, `owner`, `path`, `provider`, `revision`, `source`
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => hg,
-    }
+##### `cvs` - Supports the CVS VCS.
 
-#####To clone/pull & update a repository
+Features: `cvs_rsh`, `gzip_compression`, `modules`, `reference_tracking`, `user`
 
-To get the default branch tip,
+Parameters: `compression`, `cvs_rsh`, `ensure`, `excludes`, `force`, `group`, `module`, `owner`, `path`, `provider`
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => hg,
-      source   => "http://hg.example.com/myrepo",
-    }
+##### `hg` - Supports the Mercurial VCS.
 
-For a specific changeset, use `revision`.
+Features: `reference_tracking`, `ssh_identity`, `user`
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => hg,
-      source   => "http://hg.example.com/myrepo",
-      revision => '21ea4598c962',
-    }
+Parameters: `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `revision`, `source`, `user`
 
-You can also set `revision` to a tag.
+##### `p4` - Supports the Perforce VCS.
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => hg,
-      source   => "http://hg.example.com/myrepo",
-      revision => '1.1.2',
-    }
+Features: `p4config`, `reference_tracking`
 
-To check out as a specific user,
+Parameters: `ensure`, `excludes`, `force`, `group`, `owner`, `p4config`, `path`, `provider`, `revision`, `source`
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => hg,
-      source   => "http://hg.example.com/myrepo",
-      user     => 'user',
-    }
+##### `svn` - Supports the Subversion VCS.
 
-To specify an SSH identity key,
+Features: `basic_auth`, `configuration`, `conflict`, `depth`, `filesystem_types`, `reference_tracking`
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => hg,
-      source   => "ssh://hg@hg.example.com/myrepo",
-      identity => "/home/user/.ssh/id_dsa,
-    }
+Parameters: `basic_auth_password`, `basic_auth_username`, `configuration`, `conflict`, `ensure`, `excludes`, `force`, `fstype`, `group`, `owner`, `path`, `provider`, `revision`, `source`, `trust_server_cert`
 
-#####Sources that use SSH 
+#### Features
 
-When your source uses SSH, such as 'ssh://...', you can manage your SSH keys with Puppet using the [require](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) metaparameter in `vcsrepo` to ensure they are present.
+**Note:** Not all features are available with all providers.
 
-#####Further Examples
+* `bare_repositories` - Differentiates between bare repositories and those with working copies. (Available with `git`.)
+* `basic_auth` - Supports HTTP Basic authentication. (Available with `svn`.)
+* `conflict` - Lets you decide how to resolve any conflicts between the source repository and your working copy. (Available with `svn`.)
+* `configuration` - Lets you specify the location of your configuration files. (Available with `svn`.)
+* `cvs_rsh` - Understands the `CVS_RSH` environment variable. (Available with `cvs`.)
+* `depth` - Supports shallow clones in `git` or sets the scope limit in `svn`. (Available with `git` and `svn`.)
+* `filesystem_types` - Supports multiple types of filesystem. (Available with `svn`.)
+* `gzip_compression` - Supports explicit GZip compression levels. (Available with `cvs`.)
+* `modules` - Lets you choose a specific repository module. (Available with `cvs`.)
+* `multiple_remotes` - Tracks multiple remote repositories. (Available with `git`.)
+* `reference_tracking` - Lets you track revision references that can change over time (e.g., some VCS tags and branch names). (Available with all providers)
+* `ssh_identity` - Lets you specify an SSH identity file. (Available with `git` and `hg`.)
+* `user` - Can run as a different user. (Available with `git`, `hg` and `cvs`.)
+* `p4config` - Supports setting the `P4CONFIG` environment. (Available with `p4`.)
+* `submodules` - Supports repository submodules which can be optionally initialized. (Available with `git`.)
 
-For more examples using Mercurial, see `examples/hg/`.
+#### Parameters
 
-###Perforce
+All parameters are optional, except where specified otherwise.
 
-#####To create an empty Workspace
+##### `basic_auth_password`
 
-To create an empty Workspace, define a `vcsrepo` without a `source` or `revision`.  The 
-Environment variables P4PORT, P4USER, etc... are used to define the Perforce server
-connection settings.
+Specifies the password for HTTP Basic authentication. (Requires the `basic_auth` feature.) Valid options: a string. Default: none.
 
-    vcsrepo { "/path/to/repo":
-      ensure     => present,
-      provider   => p4
-    }
+##### `basic_auth_username`
 
-If no `P4CLIENT` environment name is provided a workspace generated name is calculated
-based on the Digest of path and hostname.  For example:
+Specifies the username for HTTP Basic authentication. (Requires the `basic_auth` feature.) Valid options: a string. Default: none.
 
-    puppet-91bc00640c4e5a17787286acbe2c021c
+##### `compression`
 
-A Perforce configuration file can be used by setting the `P4CONFIG` environment or
-defining `p4config`.  If a configuration is defined, then the environment variable for 
-`P4CLIENT` is replaced.
-    vcsrepo { "/path/to/repo":
-      ensure     => present,
-      provider   => p4,
-      p4config   => '.p4config'
-    }
+Sets the GZIP compression level for the repository history. (Requires the `gzip_compression` feature.) Valid options: an integer between 0 and 6. Default: none.
 
-#####To create/update and sync a Perforce workspace
+##### `configuration`
 
-To sync a depot path to head (latest):
+Sets the configuration directory to use. (Requires the `configuration` feature.) Valid options: a string containing an absolute path. Default: none.
 
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => p4,
-        source   => '//depot/branch/...'
-    }
+##### `conflict`
 
-For a specific changelist, use `revision`:
+Tells Subversion how to resolve any conflicts between the source repository and your working copy. (Requires the `conflict` feature.) Valid options: 'base', 'mine-full', 'theirs-full', and 'working'. Default: none.
 
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => p4,
-        source   => '//depot/branch/...',
-        revision => '2341'
-    }
+##### `cvs_rsh`
 
-You can also set `revision` to a label:
+Provides a value for the `CVS_RSH` environment variable. (Requires the `cvs_rsh` feature.) Valid options: a string. Default: none.
 
-    vcsrepo { "/path/to/repo":
-        ensure   => present,
-        provider => p4,
-        source   => '//depot/branch/...',
-        revision => 'my_label'
-    }
+##### `depth`
 
-#####To authenticate against the Perforce server
+In `git`, `depth` sets the number of commits to include when creating a shallow clone. (Requires the `depth` feature.) Valid options: an integer. Default: none.
 
-Either set the environment variables `P4USER` and `P4PASSWD` or use a configuration file.
-For secure servers set the `P4PASSWD` with a valid ticket generated using `p4 login -p`.
+In `svn`, `depth` limits the scope of an operation to the specified tree depth. (Requires the `depth` feature.) Valid options: 'empty', 'files', 'immediates', 'infinity'. Default: none.
 
-#####Further Examples
+##### `ensure`
 
-For examples you can run, see `examples/p4/`
+Specifies whether the repository should exist. Valid options: 'present', 'bare', 'absent', and 'latest'. Default: 'present'.
 
-###Subversion
+##### `excludes`
 
-#####To create a blank repository
+Lists any files the repository shouldn't track (similar to .gitignore). Valid options: a string (separate multiple values with the newline character). Default: none.
 
-To create a blank repository suitable for use as a central repository,
-define `vcsrepo` without `source` or `revision`.
+##### `force`
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => svn,
-    }
+Specifies whether to delete any existing files in the repository path if creating a new repository. **Use with care.** Valid options: 'true' and 'false'. Default: 'false'.
 
-#####To check out from a repository
+##### `fstype`
 
-Provide a `source` pointing to the branch/tag you want to check out from a repository.
+Sets the filesystem type. (Requires the `filesystem_types` feature.) Valid options: 'fsfs' or 'bdb'. Default: none.
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => svn,
-      source   => "svn://svnrepo/hello/branches/foo",
-    }
+##### `group`
 
-You can also provide a specific revision.
+Specifies a group to own the repository files. Valid options: a string containing a group name or GID. Default: none.
 
-    vcsrepo { "/path/to/repo":
-      ensure   => present,
-      provider => svn,
-      source   => "svn://svnrepo/hello/branches/foo",
-      revision => '1234',
-    }
+##### `identity`
 
-#####Using a specific Subversion configuration directory 
+Specifies an identity file to use for SSH authentication. (Requires the `ssh_identity` feature.) Valid options: a string containing an absolute path. Default: none.
 
-To use a specific configuration directory, provide a `configuration` parameter which should be a directory path on the local system where your svn configuration files are.  Typically, it is '/path/to/.subversion'.
+##### `module`
 
-    vcsrepo { "/path/to/repo":
-        ensure        => present,
-        provider      => svn,
-        source        => "svn://svnrepo/hello/branches/foo",
-        configuration => "/path/to/.subversion",
-    }
+Specifies the repository module to manage. (Requires the `modules` feature.) Valid options: a string containing the name of a CVS module. Default: none.
 
-#####Sources that use SSH 
+##### `owner`
 
-When your source uses SSH, such as 'svn+ssh://...', you can manage your SSH keys with Puppet using the [require](http://docs.puppetlabs.com/references/stable/metaparameter.html#require) metaparameter in `vcsrepo` to ensure they are present.
+Specifies a user to own the repository files. Valid options: a string containing a username or UID. Default: none.
 
-####Further examples
+##### `p4config`
 
-For more examples using Subversion, see `examples/svn/`.
+Specifies a config file that contains settings for connecting to the Perforce service. (Requires the `p4config` feature.) Valid options: a string containing the absolute path to a valid [Perforce config file](http://www.perforce.com/perforce/doc.current/manuals/p4guide/chapter.configuration.html#configuration.process.configfiles). Default: none.
 
-##Reference
+##### `path`
 
-###Type: vcsrepo
+Specifies a location for the managed repository. Valid options: a string containing an absolute path. Default: the title of your declared resource.
 
-The vcsrepo module is slightly unusual in that it is simply a type and providers. Each provider abstracts a different VCS, and a series of features are available to each provider based on its specific needs. 
+##### `provider`
 
-####Providers
+*Required.* Specifies the backend to use for this vcsrepo resource. Valid options: 'bzr', 'cvs', 'git', 'hg', 'p4', and 'svn'.
 
-**Note**: Not all features are available with all providers.
+##### `remote`
 
-* `bar`   - Supports the Bazaar VCS. (Contains features: `reference_tracking`.)
-* `cvs`   - Supports the CVS VCS. (Contains features: `cvs_rsh`, `gzip_compression`, `modules`,`reference_tracking`.)
-* `dummy` - 
-* `git`   - Supports the Git VCS. (Contains features: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `user`.)
-* `hg`    - Supports the Mercurial VCS. (Contains features: `reference_tracking`, `ssh_identity`, `user`.)
-* `svn`   - Supports the Subversion VCS. (Contains features: `basic_auth`, `configuration`, `filesystem_types`, `reference_tracking`.)
+Specifies the remote repository to track. (Requires the `multiple_remotes` feature.) Valid options: a string containing one of the remote names specified in `source`. Default: 'origin'.
 
-####Features
+##### `revision`
 
-**Note**: Not all features are available with all providers.
+Sets the revision of the repository. Valid options vary by provider:
 
-* `bare_repositories` - The provider differentiates between bare repositories and those with working copies. (Available with `git`.)
-* `basic_auth` -  The provider supports HTTP Basic Authentication. (Available with `svn`.)
-* `configuration` - The provider supports setting the configuration path.(Available with `svn`.)
-* `cvs_rsh` - The provider understands the CVS_RSH environment variable. (Available with `cvs`.)
-* `depth` - The provider can do shallow clones. (Available with `git`.)
-* `filesystem_types` - The provider supports different filesystem types. (Available with `svn`.)
-* `gzip_compression` - The provider supports explicit GZip compression levels. (Available with `cvs`.)
-* `modules` - The provider allows specific repository modules to be chosen. (Available with `cvs`.)
-* `multiple_remotes` - The repository tracks multiple remote repositories. (Available with `git`.)
-* `reference_tracking` - The provider supports tracking revision references that can change over time (e.g. some VCS tags and branch names). (Available with `bar`, `cvs`, `git`, `hg`, `svn`.)
-* `ssh_identity` - The provider supports a configurable SSH identity file. (Available with `git` and `hg`.)
-* `user` - The provider can run as a different user. (Available with `git` and `hg`.)
+* `git` - A string containing a Git branch name, or a commit SHA or tag.
+* `bzr` - A string containing a Bazaar [revision spec](http://wiki.bazaar.canonical.com/BzrRevisionSpec).
+* `cvs` - A string containing a CVS [tag or revision number](http://www.thathost.com/wincvs-howto/cvsdoc/cvs_4.html).
+* `hg` - A string containing a Mercurial [changeset ID](https://www.mercurial-scm.org/wiki/ChangeSetID) or [tag](https://www.mercurial-scm.org/wiki/Tag).
+* `p4` - A string containing a Perforce [change number, label name, client name, or date spec](http://www.perforce.com/perforce/r12.1/manuals/cmdref/o.fspecs.html).
+* `svn` - A string containing a Subversion [revision number](http://svnbook.red-bean.com/en/1.7/svn.basic.in-action.html#svn.basic.in-action.revs), [revision keyword, or revision date](http://svnbook.red-bean.com/en/1.7/svn.tour.revs.specifiers.html).
 
-####Parameters
+Default: none.
 
-* `basic_auth_password` - Specifies the HTTP Basic Authentication password. (Requires the `basic_auth` feature.)
-* `basic_auth_username` - Specifies the HTTP Basic Authentication username. (Requires the `basic_auth` feature.)
-* `compression` - Set the GZIP compression levels for your repository history. (Requires the `gzip_compression` feature.)
-* `configuration` - Sets the configuration directory to use. (Requires the `configuration` feature.)
-* `cvs_rsh` -  The value to be used for the CVS_RSH environment variable. (Requires the `cvs_rsh` feature.)
-* `depth` - The value to be used to do a shallow clone. (Requires the `depth` feature.)
-* `ensure` - Determines the state of the repository. Valid values are 'present', 'bare', 'absent', 'latest'.
-* `excludes` - Lists any files to be excluded from the repository.
-* `force` - Forces repository creation. Valid values are 'true' and 'false'. **WARNING** Forcing will destroy any files in the path.
-* `fstype` - Sets the filesystem type. (Requires the `filesystem_types` feature.)
-* `group` - Determines the group/gid that owns the repository files.
-* `identity` - Specifies the SSH identity file. (Requires the `ssh_identity` feature.)
-* `module` - Specifies the repository module to manage. (Requires the `modules` feature.)
-* `owner` - Specifies the user/uid that owns the repository files.
-*  `path` - Specifies the absolute path to the repository. If omitted, the value defaults to the resource's title.
-* `provider` - Specifies the backend to use for this vcsrepo resource. 
-* `remote` - Specifies the remote repository to track. (Requires the `multiple_remotes` feature.)
-* `revision` - Sets the revision of the repository. Values can match /^\S+$/.
-* `source` - Specifies the source URI for the repository.
-* `user` - Specifies the user to run as for repository operations.
+##### `source`
 
-####Features and Parameters by Provider
+Specifies a source repository to serve as the upstream for your managed repository. Default: none. Valid options vary by provider:
 
-#####`bzr`
-**Features**: `reference_tracking`
+* `git` - A string containing a [Git repository URL](https://www.kernel.org/pub/software/scm/git/docs/git-clone.html#_git_urls_a_id_urls_a) or a hash of `name => URL` mappings. See also [`remote`](#remote).
+* `bzr` - A string containing a Bazaar branch location.
+* `cvs` - A string containing a CVS root.
+* `hg` - A string containing the local path or URL of a Mercurial repository.
+* `p4` - A string containing a Perforce depot path.
+* `svn` - A string containing a Subversion repository URL.
 
-**Parameters**: `ensure`, `excludes`, `force`, `group`, `owner`, `path`, `provider`, `revision`, `source`, `user`
+Default: none.
 
-#####`cvs`
-**Features**: `cvs_rsh`, `gzip_compression`, `modules`, `reference_tracking`, `revision`
+##### `submodules`
 
-**Parameters**: `compression`, `cvs_rsh`, `ensure`, `excludes`, `force`, `group`, `module`, `owner`, `path`, `provider`, `revision`, `source`, `user`
+Specifies whether to initialize and update each submodule in the repository. (Requires the `submodules` feature.) Valid options: 'true' and 'false'. Default: 'true'.
 
-#####`git`
-**Features**: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `user`
+##### `trust_server_cert`
 
-**Parameters**: `depth`, `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `remote`, `revision`, `source`, `user`
+Instructs Subversion to accept SSL server certificates issued by unknown certificate authorities. Valid options: 'true' and 'false'. Default: 'false'.
 
-#####`hg`
-**Features**: `reference_tracking`, `ssh_identity`, `user`
+##### `user`
 
-**Parameters**: `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `revision`, `source`, `user`
+Specifies the user to run as for repository operations. (Requires the `user` feature.) Valid options: a string containing a username or UID. Default: none.
 
-#####`svn`
-**Features**: `basic_auth`, `configuration`, `filesystem_types`, `reference_tracking`
+## Limitations
 
-**Parameters**: `basic_auth_password`, `basic_auth_username`, `configuration`, `ensure`, `excludes`, `force`, `fstype`, `group`, `owner`, `path`, `provider`, `revision`, `source`, `user`
-        
-##Limitations
+Git is the only VCS provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
 
-This module has been built on and tested against Puppet 2.7 and higher.
+This module has been tested with Puppet 2.7 and higher.
 
 The module has been tested on:
 
-RedHat Enterprise Linux 5/6
-Debian 6/7
-CentOS 5/6
-Ubuntu 12.04
-Gentoo
-Arch Linux
-FreeBSD
+* CentOS 5/6/7
+* Debian 6/7/8
+* Oracle 5/6/7
+* Red Hat Enterprise Linux 5/6/7
+* Scientific Linux 5/6/7
+* SLES 10/11/12
+* Ubuntu 10.04/12.04/14.04/16.04
 
 Testing on other platforms has been light and cannot be guaranteed.
 
-##Development
+## Development
 
-Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
+Puppet Inc. modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
 
 We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
 
-You can read the complete module contribution guide on the Puppet Labs wiki.
\ No newline at end of file
+You can read the complete module contribution guide [on the Puppet documentation site.](https://docs.puppet.com/guides/module_guides/bgtm.html)