Skip to content
This repository has been archived by the owner on Apr 4, 2018. It is now read-only.

Commit

Permalink
Bulk out README introduction.
Browse files Browse the repository at this point in the history
  • Loading branch information
dcarley committed Jun 12, 2013
1 parent 07c489f commit 7aafc6f
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
@@ -1,14 +1,25 @@
# puppet-skeleton

Skeleton project for infrastructure teams.
This is a skeleton project for Web Operations teams using Puppet. It ties
together a suite of sensible defaults, best current practices, and re-usable
code. The intentions of which are two-fold:

## Requirements
- New projects can get started and bootstrapped faster without needing to
collate or re-writing this material themselves.

- [Ruby](http://www.ruby-lang.org/) and [Bundler](http://gembundler.com/) -- ideally with [rbenv](https://github.com/sstephenson/rbenv)
- [Vagrant](http://www.vagrantup.com/) -- ideally version >= 1.1
- The standardisation and modularisation of these materials makes it easier
for ongoing improvements to be shared, in both directions, between
different teams.

It is suggested that you fork or clone this repository when starting out.
Improvements can be submitted back with pull requests. Any significant
portions of code should be modularised to a more appropriate distribution
mechanism, such as Ruby gems or Vagrant plugins.

## Batteries included

Here are the headline details of what's inside.

### Module management

[librarian-puppet](https://github.com/rodjek/librarian-puppet) is used to
Expand All @@ -32,3 +43,8 @@ A modularised `Rakefile` will call the following test suites, in order:

A simple `Vagrantfile` demonstrating the use of a mutli-VM setup with a
Puppet provisioner.

## Requirements

- [Ruby](http://www.ruby-lang.org/) and [Bundler](http://gembundler.com/) -- ideally with [rbenv](https://github.com/sstephenson/rbenv)
- [Vagrant](http://www.vagrantup.com/) -- ideally version >= 1.1

0 comments on commit 7aafc6f

Please sign in to comment.