You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.markdown
+19-1
Original file line number
Diff line number
Diff line change
@@ -22,10 +22,12 @@
22
22
5.[Limitations - OS compatibility, etc.](#limitations)
23
23
6.[Development - Guide for contributing to the module](#development)
24
24
25
+
<aid="overview"></a>
25
26
## Overview
26
27
27
28
The vcsrepo module lets you use Puppet to easily deploy content from your version control system (VCS).
28
29
30
+
<aid="module-description"></a>
29
31
## Module description
30
32
31
33
The vcsrepo module provides a single type with providers to support the following version control systems:
@@ -39,14 +41,17 @@ The vcsrepo module provides a single type with providers to support the followin
39
41
40
42
**Note:**`git` is the only vcs provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
41
43
44
+
<aid="setup"></a>
42
45
## Setup
43
46
47
+
<aid="setup-requirements"></a>
44
48
### Setup requirements
45
49
46
50
The vcsrepo module does not install any VCS software for you. You must install a VCS before you can use this module.
47
51
48
52
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
53
54
+
<aid="beginning-with-vcsrepo"></a>
50
55
### Beginning with vcsrepo
51
56
52
57
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).
@@ -58,10 +63,12 @@ vcsrepo { '/path/to/repo':
58
63
}
59
64
~~~
60
65
66
+
<aid="usage"></a>
61
67
## Usage
62
68
63
69
**Note:**`git` is the only vcsrepo provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported)
64
70
71
+
<aid="git"></a>
65
72
### Git
66
73
67
74
#### Create a blank repository
@@ -230,7 +237,7 @@ vcsrepo { '/path/to/repo':
230
237
}
231
238
~~~
232
239
233
-
240
+
<aid="bazaar"></a>
234
241
### Bazaar
235
242
236
243
#### Create a blank repository
@@ -279,6 +286,7 @@ vcsrepo { '/path/to/repo':
279
286
}
280
287
~~~
281
288
289
+
<aid="cvs"></a>
282
290
### CVS
283
291
284
292
#### Create a blank repository
@@ -362,6 +370,7 @@ vcsrepo { '/path/to/repo':
362
370
}
363
371
~~~
364
372
373
+
<aid="mercurial"></a>
365
374
### Mercurial
366
375
367
376
#### Create a blank repository
@@ -457,6 +466,7 @@ vcsrepo { '/path/to/repo':
457
466
}
458
467
~~~
459
468
469
+
<aid="perforce"></a>
460
470
### Perforce
461
471
462
472
#### Create an empty workspace
@@ -507,6 +517,7 @@ vcsrepo { '/path/to/repo':
507
517
}
508
518
~~~
509
519
520
+
<aid="subversion"></a>
510
521
### Subversion
511
522
512
523
#### Create a blank repository
@@ -657,12 +668,15 @@ vcsrepo { '/path/to/repo':
657
668
}
658
669
~~~
659
670
671
+
<aid="reference"></a>
660
672
## Reference
661
673
674
+
<aid="type-vcsrepo"></a>
662
675
### Type: vcsrepo
663
676
664
677
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.
665
678
679
+
<aid="providers"></a>
666
680
#### Providers
667
681
668
682
**Note:** Not all features are available with all providers.
*`p4config` - Supports setting the `P4CONFIG` environment. (Available with `p4`.)
725
740
*`submodules` - Supports repository submodules which can be optionally initialized. (Available with `git`.)
726
741
742
+
<aid="parameters"></a>
727
743
#### Parameters
728
744
729
745
All parameters are optional, except where specified otherwise.
@@ -848,6 +864,7 @@ Instructs Subversion to accept SSL server certificates issued by unknown certifi
848
864
849
865
Specifies the user to run as for repository operations. (Requires the `user` feature.) Valid options: a string containing a username or UID. Default: none.
850
866
867
+
<aid="limitations"></a>
851
868
## Limitations
852
869
853
870
Git is the only VCS provider officially [supported by Puppet Inc.](https://forge.puppet.com/supported) Git with 3.18 changes the maximum enabled TLS protocol version, this breaks some HTTPS functionality on older operating systems. They are Enterprise Linux 5 and OracleLinux 6.
@@ -856,6 +873,7 @@ The includes parameter is only supported when SVN client version is >= 1.6.
856
873
857
874
For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-vcsrepo/blob/master/metadata.json)
858
875
876
+
<aid="development"></a>
859
877
## Development
860
878
861
879
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.
0 commit comments