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