began puppet documentation

1 files changed, 34 insertions, 0 deletions

diff --git a/docs/platform/puppet.md b/docs/platform/puppet.md
new file mode 100644
index 0000000..d2a7ac7
--- /dev/null
+++ b/docs/platform/puppet.md
@@ -0,0 +1,34 @@
+Notes on Puppet Usage in Leap Platform
+======================================
+
+
+Run stages
+----------
+
+We use two run stages for resource ordering:
+
+* initial: configure hostname, apt-get update + apt-get dist-upgrade
+* main: everything else
+
+Stage initial is run before stage main.
+
+see http://docs.puppetlabs.com/puppet/2.7/reference/lang_run_stages.html for run stage documentation.
+
+Tags
+----
+
+Tags are beeing used to deploy different classes.
+
+* leap_base:    site_config::default (configure hostname + resolver, sshd, )
+* leap_slow:    site_config::slow (slow: apt-get update, apt-get dist-upgrade)
+* leap_service: cofigure platform service (openvpn, couchdb, etc.)
+
+You can pass any combination of tags, i.e. use
+
+* "--tags leap_base,leap_slow,leap_service" (DEFAULT): Deploy all
+* "--tags leap_service": Only deploy service(s) (useful for debugging/development)
+* "--tags leap_base": Only deploy basic configuration (again, useful for debugging/development)
+
+See http://docs.puppetlabs.com/puppet/2.7/reference/lang_tags.html for puppet tag usage.
+
+