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