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