GitHub - OpenSourceOrg/puppetlabs-vcsrepo: Support for source control repositories

#vcsrepo

####Table of Contents

Overview
Module Description - What the module does and why it is useful
Setup - The basics of getting started with vcsrepo
- Setup requirements
- Beginning with vcsrepo
Usage - Configuration options and additional functionality
- Git
- Bazaar
- CVS
- Mercurial
- Perforce
- Subversion
Reference - An under-the-hood peek at what the module is doing and how
- Type: vcsrepo
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

##Overview

The vcsrepo module lets you use Puppet to easily deploy content from your version control system (VCS).

##Module Description

The vcsrepo module provides a single type with providers to support the following version control systems:

Git
Bazaar
CVS
Mercurial
Perforce
Subversion

Note: git is the only vcs provider officially supported by Puppet Labs.

##Setup

###Setup Requirements

The vcsrepo module does not install any VCS software for you. You must install a VCS before you can use this module.

Like Puppet in general, the vcsrepo module does not automatically create parent directories for the files it manages. Make sure to set up any needed directory structures before you get started.

###Beginning with vcsrepo

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.

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => git,
}

##Usage

Note: git is the only vcsrepo provider officially supported by Puppet Labs.

###Git

####Create a blank repository

To create a blank repository, suitable for use as a central repository, define vcsrepo without source or revision:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => git,
}

If you're managing a central or official repository, you might want to make it a bare repository. To do this, set ensure to 'bare':

vcsrepo { '/path/to/repo':
  ensure   => bare,
  provider => git,
}

####Clone/pull a repository

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => git,
  source   => 'git://example.com/repo.git',
}

If you want to clone your repository as bare or mirror, you can set ensure to 'bare' or 'mirror':

vcsrepo { '/path/to/repo':
  ensure   => mirror,
  provider => git,
  source   => 'git://example.com/repo.git',
}

By default, vcsrepo will use the HEAD of the source repository's master branch. To use another branch or a specific commit, set revision to either a branch name or a commit SHA or tag.

Branch name:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => git,
  source   => 'git://example.com/repo.git',
  revision => 'development',
}

SHA:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => git,
  source   => 'git://example.com/repo.git',
  revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
}

Tag:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => git,
  source   => 'git://example.com/repo.git',
  revision => '1.1.2rc1',
}

To check out a branch as a specific user, supply the user parameter:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => git,
  source   => 'git://example.com/repo.git',
  revision => '0c466b8a5a45f6cd7de82c08df2fb4ce1e920a31',
  user     => 'someUser',
}

To keep the repository at the latest revision, set ensure to 'latest'.

WARNING: this overwrites any local changes to the repository:

vcsrepo { '/path/to/repo':
  ensure   => latest,
  provider => git,
  source   => 'git://example.com/repo.git',
  revision => 'master',
}

To clone the repository but skip initializing submodules, set submodules to 'false':

vcsrepo { '/path/to/repo':
  ensure     => latest,
  provider   => git,
  source     => 'git://example.com/repo.git',
  submodules => false,
}

####Use multiple remotes with a repository In place of a single string, you can set source to a hash of one or more name => URL pairs:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => git,
  remote   => 'origin'
  source   => {
    'origin'       => 'https://github.com/puppetlabs/puppetlabs-vcsrepo.git', 
    'other_remote' => 'https://github.com/other_user/puppetlabs-vcsrepo.git'
  },
}

Note: if you set source to a hash, one of the names you specify must match the value of the remote parameter. That remote serves as the upstream of your managed repository.

####Connect via SSH

To connect to your source repository via SSH (e.g., 'username@server:…'), we recommend managing your SSH keys with Puppet and using the require metaparameter to make sure they are present before the vcsrepo resource is applied.

To use SSH keys associated with a user, specify the username in the user parameter:

vcsrepo { '/path/to/repo':
  ensure     => latest,
  provider   => git,
  source     => 'git://[email protected]/repo.git',
  user       => 'toto', #uses toto's $HOME/.ssh setup
  require    => File['/home/toto/.ssh/id_rsa'],
}

###Bazaar

####Create a blank repository

To create a blank repository, suitable for use as a central repository, define vcsrepo without source or revision:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => bzr,
}

####Branch from an existing repository

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => bzr,
  source   => '/some/path',
}

To branch from a specific revision, set revision to a valid Bazaar revision spec:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => bzr,
  source   => '/some/path',
  revision => '[email protected]',
}

####Connect via SSH

To connect to your source repository via SSH (e.g., 'bzr+ssh://...' or 'sftp://...,'), we recommend using the require metaparameter to make sure your SSH keys are present before the vcsrepo resource is applied:

vcsrepo { '/path/to/repo':
  ensure     => latest,
  provider   => bzr,
  source     => 'bzr+ssh://bzr.example.com/some/path',
  user       => 'toto', #uses toto's $HOME/.ssh setup
  require    => File['/home/toto/.ssh/id_rsa'],
}

###CVS

####Create a blank repository

To create a blank repository, suitable for use as a central repository, define vcsrepo without source or revision:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => cvs,
}

####Checkout/update from a repository

vcsrepo { '/path/to/workspace':
  ensure   => present,
  provider => cvs,
  source   => ':pserver:[email protected]:/sources/myproj',
}

To get a specific module on the current mainline, supply the module parameter:

vcsrepo {'/vagrant/lockss-daemon-source':
  ensure   => present,
  provider => cvs,
  source   => ':pserver:[email protected]:/cvsroot/lockss',
  module   => 'lockss-daemon',
}

To set the GZIP compression levels for your repository history, use the compression parameter:

vcsrepo { '/path/to/workspace':
  ensure      => present,
  provider    => cvs,
  compression => 3,
  source      => ':pserver:[email protected]:/sources/myproj',
}

To get a specific revision, set revision to the revision number.

vcsrepo { '/path/to/workspace':
  ensure      => present,
  provider    => cvs,
  compression => 3,
  source      => ':pserver:[email protected]:/sources/myproj',
  revision    => '1.2',
}

You can also set revision to a tag:

vcsrepo { '/path/to/workspace':
  ensure      => present,
  provider    => cvs,
  compression => 3,
  source      => ':pserver:[email protected]:/sources/myproj',
  revision    => 'SOMETAG',
}

####Connect via SSH

To connect to your source repository via SSH, we recommend using the require metaparameter to make sure your SSH keys are present before the vcsrepo resource is applied:

vcsrepo { '/path/to/repo':
  ensure     => latest,
  provider   => cvs,
  source     => ':pserver:[email protected]:/sources/myproj',
  user       => 'toto', #uses toto's $HOME/.ssh setup
  require    => File['/home/toto/.ssh/id_rsa'],
}

###Mercurial

####Create a blank repository

To create a blank repository, suitable for use as a central repository, define vcsrepo without source or revision:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => hg,
}

####Clone/pull & update a repository

To get the default branch tip:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => hg,
  source   => 'http://hg.example.com/myrepo',
}

For a specific changeset, use revision:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => hg,
  source   => 'http://hg.example.com/myrepo',
  revision => '21ea4598c962',
}

You can also set revision to a tag:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => hg,
  source   => 'http://hg.example.com/myrepo',
  revision => '1.1.2',
}

To check out as a specific user:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => hg,
  source   => 'http://hg.example.com/myrepo',
  user     => 'user',
}

To specify an SSH identity key:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => hg,
  source   => 'ssh://[email protected]/myrepo',
  identity => '/home/user/.ssh/id_dsa1,
}

To specify a username and password for HTTP Basic authentication:

vcsrepo { '/path/to/repo':
  ensure   => latest,
  provider => hg,
  source   => 'http://hg.example.com/myrepo',
  basic_auth_username => 'hgusername',
  basic_auth_password => 'hgpassword',
}

####Connect via SSH

To connect to your source repository via SSH (e.g., 'ssh://...'), we recommend using the require metaparameter to make sure your SSH keys are present before the vcsrepo resource is applied:

vcsrepo { '/path/to/repo':
  ensure     => latest,
  provider   => hg,
  source     => 'ssh://hg.example.com//path/to/myrepo',
  user       => 'toto', #uses toto's $HOME/.ssh setup
  require    => File['/home/toto/.ssh/id_rsa'],
}

###Perforce

####Create an empty workspace

To set up the connection to your Perforce service, set p4config to the location of a valid Perforce config file stored on the node:

vcsrepo { '/path/to/repo':
  ensure     => present,
  provider   => p4,
  p4config   => '/root/.p4config'
}

Note: If you don't include the P4CLIENT setting in your config file, the provider generates a workspace name based on the digest of path and the node's hostname (e.g., puppet-91bc00640c4e5a17787286acbe2c021c):

####Create/update and sync a Perforce workspace

To sync a depot path to head, set ensure to 'latest':

vcsrepo { '/path/to/repo':
  ensure   => latest,
  provider => p4,
  source   => '//depot/branch/...'
}

To sync to a specific changelist, specify its revision number with the revision parameter:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => p4,
  source   => '//depot/branch/...',
  revision => '2341'
}

You can also set revision to a label:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => p4,
  source   => '//depot/branch/...',
  revision => 'my_label'
}

###Subversion

####Create a blank repository

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => svn,
}

####Check out from an existing repository

Provide a source pointing to the branch or tag you want to check out:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => svn,
  source   => 'svn://svnrepo/hello/branches/foo',
}

You can also designate a specific revision:

vcsrepo { '/path/to/repo':
  ensure   => present,
  provider => svn,
  source   => 'svn://svnrepo/hello/branches/foo',
  revision => '1234',
}

####Use a specific Subversion configuration directory

Use the configuration parameter to designate the directory that contains your Subversion configuration files (typically, '/path/to/.subversion'):

vcsrepo { '/path/to/repo':
  ensure        => present,
  provider      => svn,
  source        => 'svn://svnrepo/hello/branches/foo',
  configuration => '/path/to/.subversion',
}

####Connect via SSH

To connect to your source repository via SSH (e.g., 'svn+ssh://...'), we recommend using the require metaparameter to make sure your SSH keys are present before the vcsrepo resource is applied:

vcsrepo { '/path/to/repo':
  ensure     => latest,
  provider   => svn,
  source     => 'svn+ssh://svnrepo/hello/branches/foo',
  user       => 'toto', #uses toto's $HOME/.ssh setup
  require    => File['/home/toto/.ssh/id_rsa'],
}

##Reference

###Type: vcsrepo

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.

####Providers

Note: Not all features are available with all providers.

#####git - Supports the Git VCS.

Features: bare_repositories, depth, multiple_remotes, reference_tracking, ssh_identity, submodules, user

Parameters: depth, ensure, excludes, force, group, identity, owner, path, provider, remote, revision, source, user

#####bzr - Supports the Bazaar VCS.

Features: reference_tracking

Parameters: ensure, excludes, force, group, owner, path, provider, revision, source

#####cvs - Supports the CVS VCS.

Features: cvs_rsh, gzip_compression, modules, reference_tracking, user

Parameters: compression, cvs_rsh, ensure, excludes, force, group, module, owner, path, provider

#####hg - Supports the Mercurial VCS.

Features: reference_tracking, ssh_identity, user

Parameters: ensure, excludes, force, group, identity, owner, path, provider, revision, source, user

#####p4 - Supports the Perforce VCS.

Features: p4config, reference_tracking

Parameters: ensure, excludes, force, group, owner, p4config, path, provider, revision, source

#####svn - Supports the Subversion VCS.

Features: basic_auth, configuration, conflict, depth, filesystem_types, reference_tracking

Parameters: basic_auth_password, basic_auth_username, configuration, conflict, ensure, excludes, force, fstype, group, owner, path, provider, revision, source, trust_server_cert

####Features

Note: Not all features are available with all providers.

bare_repositories - Differentiates between bare repositories and those with working copies. (Available with git.)
basic_auth - Supports HTTP Basic authentication. (Available with svn.)
conflict - Lets you decide how to resolve any conflicts between the source repository and your working copy. (Available with svn.)
configuration - Lets you specify the location of your configuration files. (Available with svn.)
cvs_rsh - Understands the CVS_RSH environment variable. (Available with cvs.)
depth - Supports shallow clones in git or sets scope limit in svn. (Available with git and svn.)
filesystem_types - Supports multiple types of filesystem. (Available with svn.)
gzip_compression - Supports explicit GZip compression levels. (Available with cvs.)
modules - Lets you choose a specific repository module. (Available with cvs.)
multiple_remotes - Tracks multiple remote repositories. (Available with git.)
reference_tracking - Lets you track revision references that can change over time (e.g., some VCS tags and branch names). (Available with all providers)
ssh_identity - Lets you specify an SSH identity file. (Available with git and hg.)
user - Can run as a different user. (Available with git, hg and cvs.)
p4config - Supports setting the P4CONFIG environment. (Available with p4.)
submodules - Supports repository submodules which can be optionally initialized. (Available with git.)

####Parameters

All parameters are optional, except where specified otherwise.

`basic_auth_password`

Specifies the password for HTTP Basic authentication. (Requires the basic_auth feature.) Valid options: a string. Default: none.

`basic_auth_username`

Specifies the username for HTTP Basic authentication. (Requires the basic_auth feature.) Valid options: a string. Default: none.

`compression`

Sets the GZIP compression level for the repository history. (Requires the gzip_compression feature.) Valid options: an integer between 0 and 6. Default: none.

`configuration`

Sets the configuration directory to use. (Requires the configuration feature.) Valid options: a string containing an absolute path. Default: none.

`conflict`

Tells Subversion how to resolve any conflicts between the source repository and your working copy. (Requires the conflict feature.) Valid options: 'base', 'mine-full', 'theirs-full', and 'working'. Default: none.

`cvs_rsh`

Provides a value for the CVS_RSH environment variable. (Requires the cvs_rsh feature.) Valid options: a string. Default: none.

`depth`

In git sets the number of commits to include when creating a shallow clone. (Requires the depth feature.) Valid options: an integer. Default: none.

In svn instructs Subversion to limit the scope of an operation to a particular tree depth. (Requires the depth feature.) Valid options: 'empty', 'files', 'immediates', 'infinity'. Default: none.

`ensure`

Specifies whether the repository should exist. Valid options: 'present', 'bare', 'absent', and 'latest'. Default: 'present'.

`excludes`

Lists any files the repository shouldn't track (similar to .gitignore). Valid options: a string (separate multiple values with the newline character). Default: none.

`force`

Specifies whether to delete any existing files in the repository path if creating a new repository. Use with care. Valid options: 'true' and 'false'. Default: 'false'.

`fstype`

Sets the filesystem type. (Requires the filesystem_types feature.) Valid options: 'fsfs' or 'bdb'. Default: none.

`group`

Specifies a group to own the repository files. Valid options: a string containing a group name or GID. Default: none.

`identity`

Specifies an identity file to use for SSH authentication. (Requires the ssh_identity feature.) Valid options: a string containing an absolute path. Default: none.

`module`

Specifies the repository module to manage. (Requires the modules feature.) Valid options: a string containing the name of a CVS module. Default: none.

`owner`

Specifies a user to own the repository files. Valid options: a string containing a username or UID. Default: none.

`p4config`

Specifies a config file that contains settings for connecting to the Perforce service. (Requires the p4config feature.) Valid options: a string containing the absolute path to a valid Perforce config file. Default: none.

`path`

Specifies a location for the managed repository. Valid options: a string containing an absolute path. Default: the title of your declared resource.

`provider`

Required. Specifies the backend to use for this vcsrepo resource. Valid options: 'bzr', 'cvs', 'git', 'hg', 'p4', and 'svn'.

`remote`

Specifies the remote repository to track. (Requires the multiple_remotes feature.) Valid options: a string containing one of the remote names specified in source. Default: 'origin'.

`revision`

Sets the revision of the repository. Valid options vary by provider:

git - a string containing a Git branch name, or a commit SHA or tag
bzr - a string containing a Bazaar revision spec
cvs - a string containing a CVS tag or revision number
hg - a string containing a Mercurial changeset ID or tag
p4 - a string containing a Perforce change number, label name, client name, or date spec
svn - a string containing a Subversion revision number, revision keyword, or revision date

Default: none.

`source`

Specifies a source repository to serve as the upstream for your managed repository. Default: none. Valid options vary by provider:

git - a string containing a Git repository URL or a hash of name => URL mappings. See also remote.
bzr - a string containing a Bazaar branch location
cvs - a string containing a CVS root
hg - a string containing the local path or URL of a Mercurial repository
p4 - a string containing a Perforce depot path
svn - a string containing a Subversion repository URL

Default: none.

`submodules`

Specifies whether to initialize and update each submodule in the repository. (Requires the submodules feature.) Valid options: 'true' and 'false'. Default: 'true'.

`trust_server_cert`

Instructs Subversion to accept SSL server certificates issued by unknown certificate authorities. Valid options: 'true' and 'false'. Default: 'false'.

`user`

Specifies the user to run as for repository operations. (Requires the user feature.) Valid options: a string containing a username or UID. Default: none.

##Limitations

Git is the only VCS provider officially supported by Puppet Labs.

This module has been tested with Puppet 2.7 and higher.

The module has been tested on:

CentOS 5/6/7
Debian 6/7
Oracle 5/6/7
Red Hat Enterprise Linux 5/6/7
Scientific Linux 5/6/7
SLES 10/11/12
Ubuntu 10.04/12.04/14.04

Testing on other platforms has been light and cannot be guaranteed.

##Development

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.

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.

You can read the complete module contribution guide on the Puppet Labs wiki.

Name		Name	Last commit message	Last commit date
Latest commit History 556 Commits
examples		examples
lib/puppet		lib/puppet
spec		spec
.gitattributes		.gitattributes
.gitignore		.gitignore
.rspec		.rspec
.sync.yml		.sync.yml
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
Gemfile		Gemfile
LICENSE		LICENSE
NOTICE		NOTICE
README.markdown		README.markdown
Rakefile		Rakefile
metadata.json		metadata.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

`basic_auth_password`

`basic_auth_username`

`compression`

`configuration`

`conflict`

`cvs_rsh`

`depth`

`ensure`

`excludes`

`force`

`fstype`

`group`

`identity`

`module`

`owner`

`p4config`

`path`

`provider`

`remote`

`revision`

`source`

`submodules`

`trust_server_cert`

`user`

About

Uh oh!

Releases

Packages

Languages

License

OpenSourceOrg/puppetlabs-vcsrepo

Folders and files

Latest commit

History

Repository files navigation

basic_auth_password

basic_auth_username

compression

configuration

conflict

cvs_rsh

depth

ensure

excludes

force

fstype

group

identity

module

owner

p4config

path

provider

remote

revision

source

submodules

trust_server_cert

user

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

`basic_auth_password`

`basic_auth_username`

`compression`

`configuration`

`conflict`

`cvs_rsh`

`depth`

`ensure`

`excludes`

`force`

`fstype`

`group`

`identity`

`module`

`owner`

`p4config`

`path`

`provider`

`remote`

`revision`

`source`

`submodules`

`trust_server_cert`

`user`

Packages