puppet-github-face

A Puppet Face to manage installing Puppet modules from GitHub

APACHE-2.0 License

Stars
12

puppet-github-face

Description

A Puppet Face for managing Puppet modules located on GitHub

It's heavily based on Jesse Newland's knife-github-cookbooks Knife plugin (https://github.com/websterclay/knife-github-cookbooks). Jesse's a cool guy and you should check out his other work like Rump (https://github.com/railsmachine/rump).

Requirements

  • git
  • puppet ~> 2.7.0

Installation

Install puppet-github-face as a module in your Puppet master's module path.

Usage

Installing modules

Say you wanted to install the yum module located at https://github.com/module/yum. To do so, you'd run the following command:

$ puppet github install --user module --repo yum

The repo at https://github.com/modules/yum will be cloned into a temporary directory and then moved into your module path. Any existing modules of the same name will be DELETED.

Comparing modules

Say you want to compare your installed yum module with the upstream GitHub module. To do so, you can run the following command.

$ puppet github compare --user module --repo yum

If the yum module is installed locally it'll compare it with the version on GitHub and return a unified diff output of the changes in the module.

Conventions

If the repo you're trying to install is prefixed or suffixed with puppet and/or modules, this will be stripped from the repo name. For example, running:

$ puppet faces github install modules/puppet-mysql_module

Will create the modules in the mysql directory in the module path.

Author

James Turnbull [email protected]

With much thanks to Jesse Newland for inspiration.

License

Author:: James Turnbull (<[email protected]>)
Copyright:: Copyright (c) 2011 James Turnbull
License:: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.