Add submodules feature to git provider
[puppet_vcsrepo.git] / README.markdown
1 #vcsrepo
2
3 [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-vcsrepo.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-vcsrepo)
4
5 ####Table of Contents
6
7 1. [Overview](#overview)
8 2. [Module Description - What the module does and why it is useful](#module-description)
9 3. [Setup - The basics of getting started with vcsrepo](#setup)
10     * [Beginning with vcsrepo](#beginning-with-vcsrepo)
11 4. [Usage - Configuration options and additional functionality](#usage)
12     * [Bazaar](#bazaar)
13     * [CVS](#cvs)
14     * [Git](#git)
15     * [Mercurial](#mercurial)
16     * [Perforce](#perforce)
17     * [Subversion](#subversion)  
18 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
19     * [Type: vcsrepo](#type-vcsrepo)
20         * [Providers](#providers)
21         * [Features](#features)
22         * [Parameters](#parameters)
23         * [Features and Parameters by Provider](#features-and-parameters-by-provider)
24 5. [Limitations - OS compatibility, etc.](#limitations)
25 6. [Development - Guide for contributing to the module](#development)
26
27 ##Overview
28
29 The vcsrepo module allows you to use Puppet to easily deploy content from your version control system (VCS).
30
31 ##Module Description
32
33 This module provides a single type with providers for each VCS, which can be used to describe: 
34
35 * A working copy checked out from a (remote or local) source, at an
36   arbitrary revision
37 * A blank working copy not associated with a source (when it makes
38   sense for the VCS being used)
39 * A blank central repository (when the distinction makes sense for the VCS
40   being used)   
41
42 ##Setup
43
44 ###Beginning with vcsrepo       
45
46 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). 
47
48     vcsrepo { "/path/to/repo":
49       ensure   => present,
50       provider => git,
51     }
52
53 ##Usage
54
55 The vcsrepo module works with the following VCSs:
56
57 * [Git (git)](#git)*
58 * [Bazaar (bzr)](#bazaar)
59 * [CVS (cvs)](#cvs)
60 * [Mercurial (hg)](#mercurial)
61 * [Perforce (p4)](#perforce)
62 * [Subversion (svn)](#subversion)
63
64 **Note:** Git is the only VCS provider officially [supported](https://forge.puppetlabs.com/supported) by Puppet Labs.
65
66
67 ###Git
68
69 #####To create a blank repository
70
71 To create a blank repository suitable for use as a central repository,
72 define `vcsrepo` without `source` or `revision`.
73
74     vcsrepo { "/path/to/repo":
75       ensure   => present,
76       provider => git,
77     }
78
79 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'.
80
81     vcsrepo { "/path/to/repo":
82       ensure   => bare,
83       provider => git,
84     }
85
86 #####To clone/pull a repository
87
88 To get the current HEAD on the master branch,
89
90     vcsrepo { "/path/to/repo":
91       ensure   => present,
92       provider => git,
93       source   => "git://example.com/repo.git",
94     }
95
96 To get a specific revision or branch (can be a commit SHA, tag, or branch name),
97
98  **SHA**
99
100     vcsrepo { "/path/to/repo":
101       ensure   => present,
102       provider => git,
103       source   => 'git://example.com/repo.git',
104       revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
105     }
106
107 **Tag**
108
109     vcsrepo { "/path/to/repo":
110       ensure   => present,
111       provider => git,
112       source   => 'git://example.com/repo.git',
113       revision => '1.1.2rc1',
114     }
115
116 **Branch name**
117
118     vcsrepo { "/path/to/repo":
119       ensure   => present,
120       provider => git,
121       source   => 'git://example.com/repo.git',
122       revision => 'development',
123     }
124
125 To check out a branch as a specific user,
126
127     vcsrepo { "/path/to/repo":
128       ensure   => present,
129       provider => git,
130       source   => 'git://example.com/repo.git',
131       revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
132       user     => 'someUser',
133     }
134
135 To keep the repository at the latest revision (**WARNING:** this will always overwrite local changes to the repository),
136
137     vcsrepo { "/path/to/repo":
138       ensure   => latest,
139       provider => git,
140       source   => 'git://example.com/repo.git',
141       revision => 'master',
142     }
143
144 To clone the repository but skip initialiazing submodules,
145
146     vcsrepo { "/path/to/repo":
147       ensure     => latest,
148       provider   => git,
149       source     => 'git://example.com/repo.git',
150       submodules => false,
151     }
152
153 #####Sources that use SSH
154
155 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.
156
157 For SSH keys associated with a user, enter the username in the `user` parameter. Doing so will use that user's keys.
158
159     user => 'toto'  # will use toto's $HOME/.ssh setup
160
161 #####Further Examples
162
163 For more examples using Git, see `examples/git/`.
164
165 ###Bazaar
166
167 #####Create a blank repository
168
169 To create a blank repository suitable for use as a central repository,
170 define `vcsrepo` without `source` or `revision`.
171
172     vcsrepo { "/path/to/repo":
173       ensure   => present,
174       provider => bzr,
175     }
176
177 #####Branch from an existing repository
178
179 Provide the `source` location to branch from an existing repository.
180
181     vcsrepo { "/path/to/repo":
182       ensure   => present,
183       provider => bzr,
184       source   => 'lp:myproj',
185     }
186
187 For a specific revision, use `revision` with a valid revisionspec
188 (see `bzr help revisionspec` for more information on formatting a revision).
189
190     vcsrepo { "/path/to/repo":
191       ensure   => present,
192       provider => bzr,
193       source   => 'lp:myproj',
194       revision => 'menesis@pov.lt-20100309191856-4wmfqzc803fj300x',
195     }
196
197 #####Sources that use SSH
198
199 When your source uses SSH, for instance 'bzr+ssh://...' or 'sftp://...,'
200 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.
201   
202 #####Further examples
203
204 For more examples using Bazaar, see `examples/bzr/`.
205
206 ###CVS
207
208 #####To create a blank repository
209
210 To create a blank repository suitable for use as a central repository,
211 define `vcsrepo` without `source` or `revision`.
212
213     vcsrepo { "/path/to/repo":
214       ensure   => present,
215       provider => cvs,
216     }
217
218 #####To checkout/update from a repository
219
220 To get the current mainline,
221
222     vcsrepo { "/path/to/workspace":
223       ensure   => present,
224       provider => cvs,
225       source   => ":pserver:anonymous@example.com:/sources/myproj",
226     }
227     
228 To get a specific module on the current mainline,
229
230     vcsrepo {"/vagrant/lockss-daemon-source":
231       ensure   => present,
232       provider => cvs,
233       source   => ":pserver:anonymous@lockss.cvs.sourceforge.net:/cvsroot/lockss",
234       module   => "lockss-daemon",
235     }
236
237
238 You can use the `compression` parameter to set the GZIP compression levels for your repository history.
239
240     vcsrepo { "/path/to/workspace":
241       ensure      => present,
242       provider    => cvs,
243       compression => 3,
244       source      => ":pserver:anonymous@example.com:/sources/myproj",
245     }
246
247 For a specific tag, use `revision`.
248
249     vcsrepo { "/path/to/workspace":
250       ensure      => present,
251       provider    => cvs,
252       compression => 3,
253       source      => ":pserver:anonymous@example.com:/sources/myproj",
254       revision    => "SOMETAG",
255     }
256
257 #####Sources that use SSH
258
259 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.
260
261 #####Further examples
262
263 For for more examples using CVS, see `examples/cvs/`.
264
265 ###Mercurial
266
267 #####To create a blank repository
268
269 To create a blank repository suitable for use as a central repository,
270 define `vcsrepo` without `source` or `revision`.
271
272     vcsrepo { "/path/to/repo":
273       ensure   => present,
274       provider => hg,
275     }
276
277 #####To clone/pull & update a repository
278
279 To get the default branch tip,
280
281     vcsrepo { "/path/to/repo":
282       ensure   => present,
283       provider => hg,
284       source   => "http://hg.example.com/myrepo",
285     }
286
287 For a specific changeset, use `revision`.
288
289     vcsrepo { "/path/to/repo":
290       ensure   => present,
291       provider => hg,
292       source   => "http://hg.example.com/myrepo",
293       revision => '21ea4598c962',
294     }
295
296 You can also set `revision` to a tag.
297
298     vcsrepo { "/path/to/repo":
299       ensure   => present,
300       provider => hg,
301       source   => "http://hg.example.com/myrepo",
302       revision => '1.1.2',
303     }
304
305 To check out as a specific user,
306
307     vcsrepo { "/path/to/repo":
308       ensure   => present,
309       provider => hg,
310       source   => "http://hg.example.com/myrepo",
311       user     => 'user',
312     }
313
314 To specify an SSH identity key,
315
316     vcsrepo { "/path/to/repo":
317       ensure   => present,
318       provider => hg,
319       source   => "ssh://hg@hg.example.com/myrepo",
320       identity => "/home/user/.ssh/id_dsa,
321     }
322
323 To specify a username and password for HTTP Basic authentication,
324
325     vcsrepo { "/path/to/repo":
326       ensure   => latest,
327       provider => hg,
328       source   => 'http://hg.example.com/myrepo',
329       basic_auth_username => 'hgusername',
330       basic_auth_password => 'hgpassword',
331     }
332
333 #####Sources that use SSH 
334
335 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.
336
337 #####Further Examples
338
339 For more examples using Mercurial, see `examples/hg/`.
340
341 ###Perforce
342
343 #####To create an empty Workspace
344
345 To create an empty Workspace, define a `vcsrepo` without a `source` or `revision`.  The 
346 Environment variables P4PORT, P4USER, etc... are used to define the Perforce server
347 connection settings.
348
349     vcsrepo { "/path/to/repo":
350       ensure     => present,
351       provider   => p4
352     }
353
354 If no `P4CLIENT` environment name is provided a workspace generated name is calculated
355 based on the Digest of path and hostname.  For example:
356
357     puppet-91bc00640c4e5a17787286acbe2c021c
358
359 A Perforce configuration file can be used by setting the `P4CONFIG` environment or
360 defining `p4config`.  If a configuration is defined, then the environment variable for 
361 `P4CLIENT` is replaced.
362  
363     vcsrepo { "/path/to/repo":
364       ensure     => present,
365       provider   => p4,
366       p4config   => '.p4config'
367     }
368
369 #####To create/update and sync a Perforce workspace
370
371 To sync a depot path to head, ensure `latest`:
372
373     vcsrepo { "/path/to/repo":
374         ensure   => latest,
375         provider => p4,
376         source   => '//depot/branch/...'
377     }
378
379 For a specific changelist, ensure `present` and specify a `revision`:
380
381     vcsrepo { "/path/to/repo":
382         ensure   => present,
383         provider => p4,
384         source   => '//depot/branch/...',
385         revision => '2341'
386     }
387
388 You can also set `revision` to a label:
389
390     vcsrepo { "/path/to/repo":
391         ensure   => present,
392         provider => p4,
393         source   => '//depot/branch/...',
394         revision => 'my_label'
395     }
396
397 #####To authenticate against the Perforce server
398
399 Either set the environment variables `P4USER` and `P4PASSWD` or use a configuration file.
400 For secure servers set the `P4PASSWD` with a valid ticket generated using `p4 login -p`.
401
402 #####Further Examples
403
404 For examples you can run, see `examples/p4/`
405
406 ###Subversion
407
408 #####To create a blank repository
409
410 To create a blank repository suitable for use as a central repository,
411 define `vcsrepo` without `source` or `revision`.
412
413     vcsrepo { "/path/to/repo":
414       ensure   => present,
415       provider => svn,
416     }
417
418 #####To check out from a repository
419
420 Provide a `source` pointing to the branch/tag you want to check out from a repository.
421
422     vcsrepo { "/path/to/repo":
423       ensure   => present,
424       provider => svn,
425       source   => "svn://svnrepo/hello/branches/foo",
426     }
427
428 You can also provide a specific revision.
429
430     vcsrepo { "/path/to/repo":
431       ensure   => present,
432       provider => svn,
433       source   => "svn://svnrepo/hello/branches/foo",
434       revision => '1234',
435     }
436
437 #####Using a specific Subversion configuration directory 
438
439 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'.
440
441     vcsrepo { "/path/to/repo":
442         ensure        => present,
443         provider      => svn,
444         source        => "svn://svnrepo/hello/branches/foo",
445         configuration => "/path/to/.subversion",
446     }
447
448 #####Sources that use SSH 
449
450 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.
451
452 ####Further examples
453
454 For more examples using Subversion, see `examples/svn/`.
455
456 ##Reference
457
458 ###Type: vcsrepo
459
460 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. 
461
462 ####Providers
463
464 **Note**: Not all features are available with all providers.
465
466 * `git`   - Supports the Git VCS. (Contains features: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `user`.)
467 * `bar`   - Supports the Bazaar VCS. (Contains features: `reference_tracking`.)
468 * `cvs`   - Supports the CVS VCS. (Contains features: `cvs_rsh`, `gzip_compression`, `modules`, `reference_tracking`, `user`.)
469 * `dummy` - 
470 * `hg`    - Supports the Mercurial VCS. (Contains features: `reference_tracking`, `ssh_identity`, `user`.)
471 * `p4`    - Supports the Perforce VCS. (Contains features: `reference_tracking`, `filesystem_types`, `p4config`.)
472 * `svn`   - Supports the Subversion VCS. (Contains features: `basic_auth`, `configuration`, `filesystem_types`, `reference_tracking`.)
473
474 ####Features
475
476 **Note**: Not all features are available with all providers.
477
478 * `bare_repositories` - The provider differentiates between bare repositories and those with working copies. (Available with `git`.)
479 * `basic_auth` -  The provider supports HTTP Basic Authentication. (Available with `svn`.)
480 * `configuration` - The provider supports setting the configuration path.(Available with `svn`.)
481 * `cvs_rsh` - The provider understands the CVS_RSH environment variable. (Available with `cvs`.)
482 * `depth` - The provider can do shallow clones. (Available with `git`.)
483 * `filesystem_types` - The provider supports different filesystem types. (Available with `svn`.)
484 * `gzip_compression` - The provider supports explicit GZip compression levels. (Available with `cvs`.)
485 * `modules` - The provider allows specific repository modules to be chosen. (Available with `cvs`.)
486 * `multiple_remotes` - The repository tracks multiple remote repositories. (Available with `git`.)
487 * `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`.)
488 * `ssh_identity` - The provider supports a configurable SSH identity file. (Available with `git` and `hg`.)
489 * `user` - The provider can run as a different user. (Available with `git`, `hg` and `cvs`.)
490 * `p4config` - The provider support setting the P4CONFIG environment. (Available with `p4`.)
491 * `submodules` - The provider supports repository submodules which can be optionally initialized. (Available with `git`.)
492
493 ####Parameters
494
495 * `basic_auth_password` - Specifies the HTTP Basic Authentication password. (Requires the `basic_auth` feature.)
496 * `basic_auth_username` - Specifies the HTTP Basic Authentication username. (Requires the `basic_auth` feature.)
497 * `compression` - Set the GZIP compression levels for your repository history. (Requires the `gzip_compression` feature.)
498 * `configuration` - Sets the configuration directory to use. (Requires the `configuration` feature.)
499 * `cvs_rsh` -  The value to be used for the CVS_RSH environment variable. (Requires the `cvs_rsh` feature.)
500 * `depth` - The value to be used to do a shallow clone. (Requires the `depth` feature.)
501 * `ensure` - Determines the state of the repository. Valid values are 'present', 'bare', 'absent', 'latest'.
502 * `excludes` - Lists any files to be excluded from the repository. Can be an array or string.
503 * `force` - Forces repository creation. Valid values are 'true' and 'false'. **WARNING** Forcing will destroy any files in the path.
504 * `fstype` - Sets the filesystem type. (Requires the `filesystem_types` feature.)
505 * `group` - Determines the group/gid that owns the repository files.
506 * `identity` - Specifies the SSH identity file. (Requires the `ssh_identity` feature.)
507 * `module` - Specifies the repository module to manage. (Requires the `modules` feature.)
508 * `owner` - Specifies the user/uid that owns the repository files.
509 * `path` - Specifies the absolute path to the repository. If omitted, the value defaults to the resource's title.
510 * `provider` - Specifies the backend to use for this vcsrepo resource. 
511 * `remote` - Specifies the remote repository to track. (Requires the `multiple_remotes` feature.)
512 * `revision` - Sets the revision of the repository. Values can match /^\S+$/.
513 * `source` - Specifies the source URI for the repository.
514 * `user` - Specifies the user to run as for repository operations.
515 * `p4config` - Specifies the P4CONFIG environment used for Perforce connection configuration.
516
517 ####Features and Parameters by Provider
518
519 #####`git`
520 **Features**: `bare_repositories`, `depth`, `multiple_remotes`, `reference_tracking`, `ssh_identity`, `user`, `submodules`
521
522 **Parameters**: `depth`, `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `remote`, `revision`, `source`, `user`, `submodules`
523
524 #####`bzr`
525 **Features**: `reference_tracking`
526
527 **Parameters**: `ensure`, `excludes`, `force`, `group`, `owner`, `path`, `provider`, `revision`, `source`, `user`
528
529 #####`cvs`
530 **Features**: `cvs_rsh`, `gzip_compression`, `modules`, `reference_tracking`, `revision`
531
532 **Parameters**: `compression`, `cvs_rsh`, `ensure`, `excludes`, `force`, `group`, `module`, `owner`, `path`, `provider`, `revision`, `source`, `user`
533
534 #####`hg`
535 **Features**: `reference_tracking`, `ssh_identity`, `user`
536
537 **Parameters**: `ensure`, `excludes`, `force`, `group`, `identity`, `owner`, `path`, `provider`, `revision`, `source`, `user`
538
539 #####`p4`
540 **Features**: `reference_tracking`, `filesystem_types`, `p4config`
541
542 **Parameters**: `ensure`, `group`, `owner`, `path`, `provider`, `revision`, `source`, `p4config`
543
544 #####`svn`
545 **Features**: `basic_auth`, `configuration`, `filesystem_types`, `reference_tracking`
546
547 **Parameters**: `basic_auth_password`, `basic_auth_username`, `configuration`, `ensure`, `excludes`, `force`, `fstype`, `group`, `owner`, `path`, `provider`, `revision`, `source`, `user`
548         
549 ##Limitations
550
551 Git is the only VCS provider officially [supported](https://forge.puppetlabs.com/supported) by Puppet Labs.
552
553 This module has been built on and tested against Puppet 2.7 and higher.
554
555 The module has been tested on:
556
557 RedHat Enterprise Linux 5/6
558 Debian 6/7
559 CentOS 5/6
560 Ubuntu 12.04
561 Gentoo
562 Arch Linux
563 FreeBSD
564
565 Testing on other platforms has been light and cannot be guaranteed.
566
567 ##Development
568
569 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.
570
571 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.
572
573 You can read the complete module contribution guide on the Puppet Labs wiki.