diff options
| author | Micah Anderson <micah@riseup.net> | 2013-07-03 11:45:03 -0400 |
|---|---|---|
| committer | Micah Anderson <micah@riseup.net> | 2013-07-03 16:54:10 -0400 |
| commit | 76824412771cdeaf4b62fcd711e2f722bd32e08f (patch) | |
| tree | d48d4c99b437dda52f6665e7b935266c04d15b46 /doc/under-the-hood.md | |
| parent | 506c70eb951b7aa18d009fc4fc77ce2f20a6ffe8 (diff) | |
Copy the current state of the platform documentation into the doc directory.
Originally I thought it would be better to add the leap_doc git repository as a
submodule, but I decided against that:
. it requires that the user has to start off by initializing submodules,
something that the leap_cli does for you
. it would result in more up-to-date documentation than was targeted for this
release
. it would result in an unfortunate directory structure (doc/doc/platform).
For these reasons it seemed to me better to put a snapshot of our current
platform documentation into the doc directory right before release. This just
means a step in our release process of refreshing these docs once we have
reviewed them and updated the known-issues for this release.
Change-Id: Ib395ea30553772fd195dd50315f026a2576feedd
Diffstat (limited to 'doc/under-the-hood.md')
| -rw-r--r-- | doc/under-the-hood.md | 37 |
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. + + |