puppet-git

============

A puppet module for managing the installation and configuration of git.

WARNING Changes to how Puppet sets up the environment variables with exec resources means this module no longer works as intended when managing repositories as any user other than root. It is recommended that the Puppetlabs vcsrepo module is used manage repositories.

Feature Roadmap

This module is going to be refactored to operate in conjunction to the vcsrepo module. It will manage the installation of git, the configuration of git specific settings, executing git commands, and eventually the management of git hook scripts.

Implemented Features:

• Installs git from packages
• Optionally installs git-svn from packages (defaults installed)
• Optionally installs git-gui from packages (defaults not installed)

Features not yet updated

• Initialising user accounts with git configurations

Features to be Implemented

• Sets git user's globals settings
• Sets git repository local settings
• Executes git commands
• Pushes hook scripts into git repositories

Usage

To install git

A basic install with the defaults would be:

include git

Otherwise using the parametrs:

class{git:
  svn => 'installed',
  gui => 'installed',
}

Parameters

• ensure: Sets the ensure parameter passed to the git package. The default is installed.
• svn: Sets the ensure paramater passed to the git-svn package. The default is installed.
• gui: Sets the ensure parameter passed to the git-gui package. The default is absent.
• package: Specifies a custom package. The default is git, except for older versions of Debian and Ubuntu where the default is git-core.
• git_root: Currently does nothing, it's functionality is to be reviewed.

To set up git for a user

This basically sets the users name and email as git global variables, and should allow them to just use git. The username should be a valid user account.

With default settings just use:

git::user{'username':}

Otherwise using parameters:

git::user{'username':
 user_name  => 'Some User',
 user_email => '[email protected]',
}

Parameters

• user_name sets the user's name to the specified string, and not the default of ${name} on ${fqdn}, where fqdn is the fully qualified domain name as discovered by facter.
• user_email sets the user's email address to the specified string, and not the default of ${name}@${fqdn}, where fqdn is the fully qualified domain name as discovered by facter.

To specify a git repository

Using the git::repo class is depreciated and vcsrepo should be considered instead.

This will clone a git repository from a vaild git URI to a specified path on the target server. It is strongly recommended that read-only git URIs are used. If no source is given, the target path will simply be initialised as a git repository.

With minimum parameters, should create the directory /usr/src/repo and run git init in it:

git::repo{'repo_name':
  path => '/usr/src/repo',
}

With minimum parameters to clone from a remote source:

git::repo{'repo_name':
 path   => '/usr/src/repo',
 source => 'git://example.org/example/repo.git'
}

Parameters

• path sets the path where the git repository is created or cloned to
• source sets the git URI from which the git repository is cloned from
• branch this string sets a specific branch to check out
• git_tag this string sets a specific tag to check out
• update if set to true, when puppet runs it will revert any local changes and pull the current branch from the source if there is any difference between the local repository and the source repository.
• bare if set to true, it creates a bare repository

Note: I am uncertain on how it will behave if both tag and branch are set, but tag should override branch.

Dependencies

• stdlib

Attribution

puppet-blank

This module is derived from the puppet-blank module by Aaron Hicks ([email protected])

• https://github.com/Aethylred/puppet-blank

This module has been developed for the use with Open Source Puppet (Apache 2.0 license) for automating server & service deployment.

• http://puppetlabs.com/puppet/puppet-open-source/

rspec-puppet-augeas

This module includes the Travis configuration to use rspec-puppet-augeas to test and verify changes made to files using the augeas resource available in Puppet. Check the rspec-puppet-augeas documentation for usage.

This will require a copy of the original input files to spec/fixtures/augeas using the same filesystem layout that the resource expects:

$ tree spec/fixtures/augeas/
spec/fixtures/augeas/
`-- etc
    `-- ssh
        `-- sshd_config

Gnu General Public License

This file is part of the git Puppet module.

The git Puppet module is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The git Puppet module is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the git Puppet module. If not, see http://www.gnu.org/licenses/.