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