Merge remote-tracking branch 'puppetlabs/master'
[puppet_vcsrepo.git] / README.markdown
1 # vcsrepo
2
3 #### Table of contents
4
5 1. [Overview](#overview)
6 2. [Module Description - What the module does and why it is useful](#module-description)
7 3. [Setup - The basics of getting started with vcsrepo](#setup)
8     * [Setup requirements](#setup-requirements)
9     * [Beginning with vcsrepo](#beginning-with-vcsrepo)
10 4. [Usage - Configuration options and additional functionality](#usage)
11     * [Git](#git)
12     * [Bazaar](#bazaar)
13     * [CVS](#cvs)
14     * [Mercurial](#mercurial)
15     * [Perforce](#perforce)
16     * [Subversion](#subversion)
17 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
18     * [Type: vcsrepo](#type-vcsrepo)
19         * [Providers](#providers)
20         * [Features](#features)
21         * [Parameters](#parameters)
22 5. [Limitations - OS compatibility, etc.](#limitations)
23 6. [Development - Guide for contributing to the module](#development)
24
25 ## Overview
26
27 The vcsrepo module lets you use Puppet to easily deploy content from your version control system (VCS).
28
29 ## Module description
30
31 The vcsrepo module provides a single type with providers to support the following version control systems:
32
33 * [Git](#git)
34 * [Bazaar](#bazaar)
35 * [CVS](#cvs)
36 * [Mercurial](#mercurial)
37 * [Perforce](#perforce)
38 * [Subversion](#subversion)
39
40 **Note:** `git` is the only vcs provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
41
42 ## Setup
43
44 ### Setup requirements
45
46 The vcsrepo module does not install any VCS software for you. You must install a VCS before you can use this module.
47
48 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.
49
50 ### Beginning with vcsrepo
51
52 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).
53
54 ~~~ puppet
55 vcsrepo { '/path/to/repo':
56   ensure   => present,
57   provider => git,
58 }
59 ~~~
60
61 ## Usage
62
63 **Note:** `git` is the only vcsrepo provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
64
65 ### Git
66
67 #### Create a blank repository
68
69 To create a blank repository suitable for use as a central repository, define `vcsrepo` without `source` or `revision`:
70
71 ~~~ puppet
72 vcsrepo { '/path/to/repo':
73   ensure   => present,
74   provider => git,
75 }
76 ~~~
77
78 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':
79
80 ~~~ puppet
81 vcsrepo { '/path/to/repo':
82   ensure   => bare,
83   provider => git,
84 }
85 ~~~
86
87 #### Clone/pull a repository
88
89 ~~~ puppet
90 vcsrepo { '/path/to/repo':
91   ensure   => present,
92   provider => git,
93   source   => 'git://example.com/repo.git',
94 }
95 ~~~
96
97 To clone your repository as bare or mirror, you can set `ensure` to 'bare' or 'mirror':
98
99 ~~~ puppet
100 vcsrepo { '/path/to/repo':
101   ensure   => mirror,
102   provider => git,
103   source   => 'git://example.com/repo.git',
104 }
105 ~~~
106
107 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.
108
109 Branch name:
110
111 ~~~ puppet
112 vcsrepo { '/path/to/repo':
113   ensure   => present,
114   provider => git,
115   source   => 'git://example.com/repo.git',
116   revision => 'development',
117 }
118 ~~~
119
120 SHA:
121
122 ~~~ puppet
123 vcsrepo { '/path/to/repo':
124   ensure   => present,
125   provider => git,
126   source   => 'git://example.com/repo.git',
127   revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
128 }
129 ~~~
130
131 Tag:
132
133 ~~~ puppet
134 vcsrepo { '/path/to/repo':
135   ensure   => present,
136   provider => git,
137   source   => 'git://example.com/repo.git',
138   revision => '1.1.2rc1',
139 }
140 ~~~
141
142 To check out a branch as a specific user, supply the `user` parameter:
143
144 ~~~ puppet
145 vcsrepo { '/path/to/repo':
146   ensure   => present,
147   provider => git,
148   source   => 'git://example.com/repo.git',
149   revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
150   user     => 'someUser',
151 }
152 ~~~
153
154 To keep the repository at the latest revision, set `ensure` to 'latest'.
155
156 **WARNING:** This overwrites any local changes to the repository.
157
158 ~~~ puppet
159 vcsrepo { '/path/to/repo':
160   ensure   => latest,
161   provider => git,
162   source   => 'git://example.com/repo.git',
163   revision => 'master',
164 }
165 ~~~
166
167 To clone the repository but skip initializing submodules, set `submodules` to 'false':
168
169 ~~~ puppet
170 vcsrepo { '/path/to/repo':
171   ensure     => latest,
172   provider   => git,
173   source     => 'git://example.com/repo.git',
174   submodules => false,
175 }
176 ~~~
177
178 #### Use multiple remotes with a repository
179
180 In place of a single string, you can set `source` to a hash of one or more name => URL pairs:
181
182 ~~~ puppet
183 vcsrepo { '/path/to/repo':
184   ensure   => present,
185   provider => git,
186   remote   => 'origin'
187   source   => {
188     'origin'       => 'https://github.com/puppetlabs/puppetlabs-vcsrepo.git',
189     'other_remote' => 'https://github.com/other_user/puppetlabs-vcsrepo.git'
190   },
191 }
192 ~~~
193
194 **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.
195
196 #### Connect via SSH
197
198 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.
199
200 To use SSH keys associated with a user, specify the username in the `user` parameter:
201
202 ~~~ puppet
203 vcsrepo { '/path/to/repo':
204   ensure   => latest,
205   provider => git,
206   source   => 'git://username@example.com/repo.git',
207   user     => 'toto', #uses toto's $HOME/.ssh setup
208   require  => File['/home/toto/.ssh/id_rsa'],
209 }
210 ~~~
211
212 ### Bazaar
213
214 #### Create a blank repository
215
216 To create a blank repository, suitable for use as a central repository, define `vcsrepo` without `source` or `revision`:
217
218 ~~~ puppet
219 vcsrepo { '/path/to/repo':
220   ensure   => present,
221   provider => bzr,
222 }
223 ~~~
224
225 #### Branch from an existing repository
226
227 ~~~ puppet
228 vcsrepo { '/path/to/repo':
229   ensure   => present,
230   provider => bzr,
231   source   => '/some/path',
232 }
233 ~~~
234
235 To branch from a specific revision, set `revision` to a valid [Bazaar revision spec](http://wiki.bazaar.canonical.com/BzrRevisionSpec):
236
237 ~~~ puppet
238 vcsrepo { '/path/to/repo':
239   ensure   => present,
240   provider => bzr,
241   source   => '/some/path',
242   revision => 'menesis@pov.lt-20100309191856-4wmfqzc803fj300x',
243 }
244 ~~~
245
246 #### Connect via SSH
247
248 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:
249
250 ~~~ puppet
251 vcsrepo { '/path/to/repo':
252   ensure   => latest,
253   provider => bzr,
254   source   => 'bzr+ssh://bzr.example.com/some/path',
255   user     => 'toto', #uses toto's $HOME/.ssh setup
256   require  => File['/home/toto/.ssh/id_rsa'],
257 }
258 ~~~
259
260 ### CVS
261
262 #### Create a blank repository
263
264 To create a blank repository suitable for use as a central repository, define `vcsrepo` without `source` or `revision`:
265
266 ~~~ puppet
267 vcsrepo { '/path/to/repo':
268   ensure   => present,
269   provider => cvs,
270 }
271 ~~~
272
273 #### Checkout/update from a repository
274
275 ~~~ puppet
276 vcsrepo { '/path/to/workspace':
277   ensure   => present,
278   provider => cvs,
279   source   => ':pserver:anonymous@example.com:/sources/myproj',
280 }
281 ~~~
282
283 To get a specific module on the current mainline, supply the `module` parameter:
284
285 ~~~ puppet
286 vcsrepo { '/vagrant/lockss-daemon-source':
287   ensure   => present,
288   provider => cvs,
289   source   => ':pserver:anonymous@lockss.cvs.sourceforge.net:/cvsroot/lockss',
290   module   => 'lockss-daemon',
291 }
292 ~~~
293
294 To set the GZIP compression levels for your repository history, use the `compression` parameter:
295
296 ~~~ puppet
297 vcsrepo { '/path/to/workspace':
298   ensure      => present,
299   provider    => cvs,
300   compression => 3,
301   source      => ':pserver:anonymous@example.com:/sources/myproj',
302 }
303 ~~~
304
305 To get a specific revision, set `revision` to the revision number.
306
307 ~~~ puppet
308 vcsrepo { '/path/to/workspace':
309   ensure      => present,
310   provider    => cvs,
311   compression => 3,
312   source      => ':pserver:anonymous@example.com:/sources/myproj',
313   revision    => '1.2',
314 }
315 ~~~
316
317 You can also set `revision` to a tag:
318
319 ~~~ puppet
320 vcsrepo { '/path/to/workspace':
321   ensure      => present,
322   provider    => cvs,
323   compression => 3,
324   source      => ':pserver:anonymous@example.com:/sources/myproj',
325   revision    => 'SOMETAG',
326 }
327 ~~~
328
329 #### Connect via SSH
330
331 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:
332
333 ~~~ puppet
334 vcsrepo { '/path/to/repo':
335   ensure   => latest,
336   provider => cvs,
337   source   => ':pserver:anonymous@example.com:/sources/myproj',
338   user     => 'toto', #uses toto's $HOME/.ssh setup
339   require  => File['/home/toto/.ssh/id_rsa'],
340 }
341 ~~~
342
343 ### Mercurial
344
345 #### Create a blank repository
346
347 To create a blank repository suitable for use as a central repository, define `vcsrepo` without `source` or `revision`:
348
349 ~~~ puppet
350 vcsrepo { '/path/to/repo':
351   ensure   => present,
352   provider => hg,
353 }
354 ~~~
355
356 #### Clone/pull and update a repository
357
358 To get the default branch tip:
359
360 ~~~ puppet
361 vcsrepo { '/path/to/repo':
362   ensure   => present,
363   provider => hg,
364   source   => 'http://hg.example.com/myrepo',
365 }
366 ~~~
367
368 For a specific changeset, use `revision`:
369
370 ~~~ puppet
371 vcsrepo { '/path/to/repo':
372   ensure   => present,
373   provider => hg,
374   source   => 'http://hg.example.com/myrepo',
375   revision => '21ea4598c962',
376 }
377 ~~~
378
379 You can also set `revision` to a tag:
380
381 ~~~ puppet
382 vcsrepo { '/path/to/repo':
383   ensure   => present,
384   provider => hg,
385   source   => 'http://hg.example.com/myrepo',
386   revision => '1.1.2',
387 }
388 ~~~
389
390 To check out as a specific user:
391
392 ~~~ puppet
393 vcsrepo { '/path/to/repo':
394   ensure   => present,
395   provider => hg,
396   source   => 'http://hg.example.com/myrepo',
397   user     => 'user',
398 }
399 ~~~
400
401 To specify an SSH identity key:
402
403 ~~~ puppet
404 vcsrepo { '/path/to/repo':
405   ensure   => present,
406   provider => hg,
407   source   => 'ssh://hg@hg.example.com/myrepo',
408   identity => '/home/user/.ssh/id_dsa1,
409 }
410 ~~~
411
412 To specify a username and password for HTTP Basic authentication:
413
414 ~~~ puppet
415 vcsrepo { '/path/to/repo':
416   ensure              => latest,
417   provider            => hg,
418   source              => 'http://hg.example.com/myrepo',
419   basic_auth_username => 'hgusername',
420   basic_auth_password => 'hgpassword',
421 }
422 ~~~
423
424 #### Connect via SSH
425
426 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:
427
428 ~~~ puppet
429 vcsrepo { '/path/to/repo':
430   ensure   => latest,
431   provider => hg,
432   source   => 'ssh://hg.example.com//path/to/myrepo',
433   user     => 'toto', #uses toto's $HOME/.ssh setup
434   require  => File['/home/toto/.ssh/id_rsa'],
435 }
436 ~~~
437
438 ### Perforce
439
440 #### Create an empty workspace
441
442 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:
443
444 ~~~ puppet
445 vcsrepo { '/path/to/repo':
446   ensure   => present,
447   provider => p4,
448   p4config => '/root/.p4config'
449 }
450 ~~~
451
452 **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`).
453
454 #### Create/update and sync a Perforce workspace
455
456 To sync a depot path to head, set `ensure` to 'latest':
457
458 ~~~ puppet
459 vcsrepo { '/path/to/repo':
460   ensure   => latest,
461   provider => p4,
462   source   => '//depot/branch/...'
463 }
464 ~~~
465
466 To sync to a specific changelist, specify its revision number with the `revision` parameter:
467
468 ~~~ puppet
469 vcsrepo { '/path/to/repo':
470   ensure   => present,
471   provider => p4,
472   source   => '//depot/branch/...',
473   revision => '2341'
474 }
475 ~~~
476
477 You can also set `revision` to a label:
478
479 ~~~ puppet
480 vcsrepo { '/path/to/repo':
481   ensure   => present,
482   provider => p4,
483   source   => '//depot/branch/...',
484   revision => 'my_label'
485 }
486 ~~~
487
488 ### Subversion
489
490 #### Create a blank repository
491
492 ~~~ puppet
493 vcsrepo { '/path/to/repo':
494   ensure   => present,
495   provider => svn,
496 }
497 ~~~
498
499 #### Check out from an existing repository
500
501 Provide a `source` pointing to the branch or tag you want to check out:
502
503 ~~~ puppet
504 vcsrepo { '/path/to/repo':
505   ensure   => present,
506   provider => svn,
507   source   => 'svn://svnrepo/hello/branches/foo',
508 }
509 ~~~
510
511 You can also designate a specific revision:
512
513 ~~~ puppet
514 vcsrepo { '/path/to/repo':
515   ensure   => present,
516   provider => svn,
517   source   => 'svn://svnrepo/hello/branches/foo',
518   revision => '1234',
519 }
520 ~~~
521
522 #### Use a specific Subversion configuration directory
523
524 Use the `configuration` parameter to designate the directory that contains your Subversion configuration files (typically, '/path/to/.subversion'):
525
526 ~~~ puppet
527 vcsrepo { '/path/to/repo':
528   ensure        => present,
529   provider      => svn,
530   source        => 'svn://svnrepo/hello/branches/foo',
531   configuration => '/path/to/.subversion',
532 }
533 ~~~
534
535 #### Connect via SSH
536
537 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:
538
539 ~~~ puppet
540 vcsrepo { '/path/to/repo':
541   ensure   => latest,
542   provider => svn,
543   source   => 'svn+ssh://svnrepo/hello/branches/foo',
544   user     => 'toto', #uses toto's $HOME/.ssh setup
545   require  => File['/home/toto/.ssh/id_rsa'],
546 }
547 ~~~
548
549 ## Reference
550
551 ### Type: vcsrepo
552
553 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.
554
555 #### Providers
556
557 **Note:** Not all features are available with all providers.
558
559 ##### `git` - Supports the Git VCS.
560
561 Features: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `submodules`, `user`
562
563 Parameters: `depth`, `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `remote`, `revision`, `source`, `user`
564
565 ##### `bzr` - Supports the Bazaar VCS.
566
567 Features: `reference_tracking`
568
569 Parameters: `ensure`, `excludes`, `force`, `group`, `owner`, `path`, `provider`, `revision`, `source`
570
571 ##### `cvs` - Supports the CVS VCS.
572
573 Features: `cvs_rsh`, `gzip_compression`, `modules`, `reference_tracking`, `user`
574
575 Parameters: `compression`, `cvs_rsh`, `ensure`, `excludes`, `force`, `group`, `module`, `owner`, `path`, `provider`
576
577 ##### `hg` - Supports the Mercurial VCS.
578
579 Features: `reference_tracking`, `ssh_identity`, `user`
580
581 Parameters: `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `revision`, `source`, `user`
582
583 ##### `p4` - Supports the Perforce VCS.
584
585 Features: `p4config`, `reference_tracking`
586
587 Parameters: `ensure`, `excludes`, `force`, `group`, `owner`, `p4config`, `path`, `provider`, `revision`, `source`
588
589 ##### `svn` - Supports the Subversion VCS.
590
591 Features: `basic_auth`, `configuration`, `conflict`, `depth`, `filesystem_types`, `reference_tracking`
592
593 Parameters: `basic_auth_password`, `basic_auth_username`, `configuration`, `conflict`, `ensure`, `excludes`, `force`, `fstype`, `group`, `owner`, `path`, `provider`, `revision`, `source`, `trust_server_cert`
594
595 #### Features
596
597 **Note:** Not all features are available with all providers.
598
599 * `bare_repositories` - Differentiates between bare repositories and those with working copies. (Available with `git`.)
600 * `basic_auth` - Supports HTTP Basic authentication. (Available with `svn`.)
601 * `conflict` - Lets you decide how to resolve any conflicts between the source repository and your working copy. (Available with `svn`.)
602 * `configuration` - Lets you specify the location of your configuration files. (Available with `svn`.)
603 * `cvs_rsh` - Understands the `CVS_RSH` environment variable. (Available with `cvs`.)
604 * `depth` - Supports shallow clones in `git` or sets the scope limit in `svn`. (Available with `git` and `svn`.)
605 * `filesystem_types` - Supports multiple types of filesystem. (Available with `svn`.)
606 * `gzip_compression` - Supports explicit GZip compression levels. (Available with `cvs`.)
607 * `modules` - Lets you choose a specific repository module. (Available with `cvs`.)
608 * `multiple_remotes` - Tracks multiple remote repositories. (Available with `git`.)
609 * `reference_tracking` - Lets you track revision references that can change over time (e.g., some VCS tags and branch names). (Available with all providers)
610 * `ssh_identity` - Lets you specify an SSH identity file. (Available with `git` and `hg`.)
611 * `user` - Can run as a different user. (Available with `git`, `hg` and `cvs`.)
612 * `p4config` - Supports setting the `P4CONFIG` environment. (Available with `p4`.)
613 * `submodules` - Supports repository submodules which can be optionally initialized. (Available with `git`.)
614
615 #### Parameters
616
617 All parameters are optional, except where specified otherwise.
618
619 ##### `basic_auth_password`
620
621 Specifies the password for HTTP Basic authentication. (Requires the `basic_auth` feature.) Valid options: a string. Default: none.
622
623 ##### `basic_auth_username`
624
625 Specifies the username for HTTP Basic authentication. (Requires the `basic_auth` feature.) Valid options: a string. Default: none.
626
627 ##### `compression`
628
629 Sets the GZIP compression level for the repository history. (Requires the `gzip_compression` feature.) Valid options: an integer between 0 and 6. Default: none.
630
631 ##### `configuration`
632
633 Sets the configuration directory to use. (Requires the `configuration` feature.) Valid options: a string containing an absolute path. Default: none.
634
635 ##### `conflict`
636
637 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.
638
639 ##### `cvs_rsh`
640
641 Provides a value for the `CVS_RSH` environment variable. (Requires the `cvs_rsh` feature.) Valid options: a string. Default: none.
642
643 ##### `depth`
644
645 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.
646
647 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.
648
649 ##### `ensure`
650
651 Specifies whether the repository should exist. Valid options: 'present', 'bare', 'absent', and 'latest'. Default: 'present'.
652
653 ##### `excludes`
654
655 Lists any files the repository shouldn't track (similar to .gitignore). Valid options: a string (separate multiple values with the newline character). Default: none.
656
657 ##### `force`
658
659 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'.
660
661 ##### `fstype`
662
663 Sets the filesystem type. (Requires the `filesystem_types` feature.) Valid options: 'fsfs' or 'bdb'. Default: none.
664
665 ##### `group`
666
667 Specifies a group to own the repository files. Valid options: a string containing a group name or GID. Default: none.
668
669 ##### `identity`
670
671 Specifies an identity file to use for SSH authentication. (Requires the `ssh_identity` feature.) Valid options: a string containing an absolute path. Default: none.
672
673 ##### `module`
674
675 Specifies the repository module to manage. (Requires the `modules` feature.) Valid options: a string containing the name of a CVS module. Default: none.
676
677 ##### `owner`
678
679 Specifies a user to own the repository files. Valid options: a string containing a username or UID. Default: none.
680
681 ##### `p4config`
682
683 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.
684
685 ##### `path`
686
687 Specifies a location for the managed repository. Valid options: a string containing an absolute path. Default: the title of your declared resource.
688
689 ##### `provider`
690
691 *Required.* Specifies the backend to use for this vcsrepo resource. Valid options: 'bzr', 'cvs', 'git', 'hg', 'p4', and 'svn'.
692
693 ##### `remote`
694
695 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'.
696
697 ##### `revision`
698
699 Sets the revision of the repository. Valid options vary by provider:
700
701 * `git` - A string containing a Git branch name, or a commit SHA or tag.
702 * `bzr` - A string containing a Bazaar [revision spec](http://wiki.bazaar.canonical.com/BzrRevisionSpec).
703 * `cvs` - A string containing a CVS [tag or revision number](http://www.thathost.com/wincvs-howto/cvsdoc/cvs_4.html).
704 * `hg` - A string containing a Mercurial [changeset ID](https://www.mercurial-scm.org/wiki/ChangeSetID) or [tag](https://www.mercurial-scm.org/wiki/Tag).
705 * `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).
706 * `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).
707
708 Default: none.
709
710 ##### `source`
711
712 Specifies a source repository to serve as the upstream for your managed repository. Default: none. Valid options vary by provider:
713
714 * `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).
715 * `bzr` - A string containing a Bazaar branch location.
716 * `cvs` - A string containing a CVS root.
717 * `hg` - A string containing the local path or URL of a Mercurial repository.
718 * `p4` - A string containing a Perforce depot path.
719 * `svn` - A string containing a Subversion repository URL.
720
721 Default: none.
722
723 ##### `submodules`
724
725 Specifies whether to initialize and update each submodule in the repository. (Requires the `submodules` feature.) Valid options: 'true' and 'false'. Default: 'true'.
726
727 ##### `trust_server_cert`
728
729 Instructs Subversion to accept SSL server certificates issued by unknown certificate authorities. Valid options: 'true' and 'false'. Default: 'false'.
730
731 ##### `user`
732
733 Specifies the user to run as for repository operations. (Requires the `user` feature.) Valid options: a string containing a username or UID. Default: none.
734
735 ## Limitations
736
737 Git is the only VCS provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
738
739 This module has been tested with Puppet 2.7 and higher.
740
741 The module has been tested on:
742
743 * CentOS 5/6/7
744 * Debian 6/7/8
745 * Oracle 5/6/7
746 * Red Hat Enterprise Linux 5/6/7
747 * Scientific Linux 5/6/7
748 * SLES 10/11/12
749 * Ubuntu 10.04/12.04/14.04/16.04
750
751 Testing on other platforms has been light and cannot be guaranteed.
752
753 ## Development
754
755 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.
756
757 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.
758
759 You can read the complete module contribution guide [on the Puppet documentation site.](https://docs.puppet.com/guides/module_guides/bgtm.html)