summaryrefslogtreecommitdiff
path: root/doc/under-the-hood.md
diff options
context:
space:
mode:
authorMicah Anderson <micah@riseup.net>2013-07-03 16:55:22 -0400
committerMicah Anderson <micah@riseup.net>2013-07-03 16:55:22 -0400
commit597dc1d48e4d8d4bdb8e5292f31da8151b2da5a3 (patch)
tree80f4fa7f1172111a7a419090f4a6ff438266e0a6 /doc/under-the-hood.md
parentf657473f72d3f6119dddbe9b6c5cc7262adcc4c0 (diff)
parent76824412771cdeaf4b62fcd711e2f722bd32e08f (diff)
Merge branch 'feature/documentation_update' into leap
Diffstat (limited to 'doc/under-the-hood.md')
-rw-r--r--doc/under-the-hood.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/under-the-hood.md b/doc/under-the-hood.md
new file mode 100644
index 00000000..080a153e
--- /dev/null
+++ b/doc/under-the-hood.md
@@ -0,0 +1,37 @@
+@title = "Under the hood"
+
+This page contains various details on the how the platform is implemented. You can safely ignore this page, although it may be useful if you plan to make modifications to the platform.
+
+Puppet Details
+======================================
+
+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.
+
+