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