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