aboutsummaryrefslogtreecommitdiff
path: root/puppet/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'puppet/README.md')
-rw-r--r--puppet/README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/puppet/README.md b/puppet/README.md
new file mode 100644
index 0000000..9ab8d84
--- /dev/null
+++ b/puppet/README.md
@@ -0,0 +1,44 @@
+Puppet Boostrap Module
+======================
+
+This is a multi-purpose but very specific puppet module which can be used:
+
+* As the base repository for a puppet infrastructure.
+* As a standalone provisioner for boxes, with Vagrant support.
+* It can be optionally used together with the Hydra Suite from https://git.fluxo.info/hydra
+
+Setting up a new puppet repository
+----------------------------------
+
+You'll basically use the `bootstrap` repository as your `puppet` repository:
+
+ git clone git://git.fluxo.info/puppet-bootstrap.git puppet
+ cd puppet && git tag -v # check integrity
+ make deps # install dependencies
+ make submodules # add all needed puppet modules as as git submodules
+ make config # basic configuration
+
+Using as a standalone provisioner
+---------------------------------
+
+This will be a `Vagrant` example:
+
+ cd your-project
+ git clone git://git.fluxo.info/puppet-bootstrap.git puppet # use submodule or subtree as you please
+ ln -s puppet/Vagrantfile # or copy if you want to customize
+ ( cd puppet && make modules ) # need the mr binary to download the submodules
+ vagrant up web # with no arguments, all defined VMs are started
+
+Using subtrees or symlinks for modules
+--------------------------------------
+
+You might use `make subtrees` instead of `make submodules`. Also, if you already have
+all the modules in a different subtree, use
+
+ make symlinks MODULES=/path/to/puppet/modules
+
+Recommended puppet modules
+--------------------------
+
+This repository plays well with other puppet modules hosted at https://git.fluxo.info, some of them
+based on https://gitlab.com/shared-puppet-modules-group.