Since we're overriding retrieve anyhow, make all the values for ensure explicit
[puppet_vcsrepo.git] / README.CVS.markdown
1 Using vcsrepo with CVS
2 ======================
3
4 To create a blank repository
5 ----------------------------
6
7 Define a `vcsrepo` without a `source` or `revision`:
8
9     vcsrepo { "/path/to/repo":
10       ensure => present,
11       provider => cvs
12     }
13
14 To checkout/update from a repository
15 ------------------------------------
16
17 To get the current mainline:
18
19     vcsrepo { "/path/to/workspace":
20         ensure => present,
21         provider => cvs,
22         source => ":pserver:anonymous@example.com:/sources/myproj"
23     }
24
25 You can use the `compression` parameter (it works like CVS `-z`):
26
27     vcsrepo { "/path/to/workspace":
28         ensure => present,
29         provider => cvs,
30         compression => 3,
31         source => ":pserver:anonymous@example.com:/sources/myproj"
32     }
33
34 For a specific tag, use `revision`:
35
36     vcsrepo { "/path/to/workspace":
37         ensure => present,
38         provider => cvs,
39         compression => 3,
40         source => ":pserver:anonymous@example.com:/sources/myproj",
41         revision => "SOMETAG"
42     }
43
44 For sources that use SSH
45 ------------------------
46
47 Manage your SSH keys with Puppet and use `require` in your `vcsrepo`
48 to ensure they are present.  For more information, see the `require`
49 metaparameter documentation[1].
50
51 More Examples
52 -------------
53
54 For examples you can run, see `examples/cvs/`
55
56 [1]: http://docs.reductivelabs.com/references/stable/metaparameter.html#require