diff options
author | Micah Anderson <micah@leap.se> | 2015-06-11 10:36:16 -0400 |
---|---|---|
committer | Micah Anderson <micah@leap.se> | 2015-06-11 10:36:16 -0400 |
commit | 49513b828f019a0eb7c6f5082f6e9d817136904a (patch) | |
tree | 16de1ce8a4859c3c14fdc280446502caf6b368cc /doc/details | |
parent | 18e247ae29e7ee787e350724e2884da0a74bbd63 (diff) |
update /doc dir with latest from leap docs/platform
Change-Id: If4bcf7e2139b672c3e38f55e54d1f121a5601860
Diffstat (limited to 'doc/details')
-rw-r--r-- | doc/details/couchdb.md | 17 | ||||
-rw-r--r-- | doc/details/development.md | 51 | ||||
-rw-r--r-- | doc/details/en.haml | 5 | ||||
-rw-r--r-- | doc/details/under-the-hood.md | 16 |
4 files changed, 82 insertions, 7 deletions
diff --git a/doc/details/couchdb.md b/doc/details/couchdb.md index afecf169..276bfdc2 100644 --- a/doc/details/couchdb.md +++ b/doc/details/couchdb.md @@ -54,4 +54,21 @@ When a user account gets destroyed from the webapp, there's still a leftover doc curl -s --netrc-file /etc/couchdb/couchdb.netrc -X DELETE 'http://127.0.0.1:5984/identities/b25cf10f935b58088f0d547fca823265?rev=2-715a9beba597a2ab01851676f12c3e4a' +How to find out which userstore belongs to which identity ? +=========================================================== + + /usr/bin/curl -s --netrc-file /etc/couchdb/couchdb.netrc '127.0.0.1:5984/identities/_all_docs?include_docs=true' | grep testuser + + {"id":"665e004870ee17aa4c94331ff3ecb173","key":"665e004870ee17aa4c94331ff3ecb173","value":{"rev":"2-2e335a75c4b79a5c2ef5c9950706fe1b"},"doc":{"_id":"665e004870ee17aa4c94331ff3ecb173","_rev":"2-2e335a75c4b79a5c2ef5c9950706fe1b","user_id":"665e004870ee17aa4c94331ff3cd59eb","address":"testuser@example.org","destination":"testuser@example.org","keys": ... + +* search for the "user_id" field +* in this example testuser@example.org uses the database user-665e004870ee17aa4c94331ff3cd59eb + + +How much disk space is used by a userstore +========================================== + +Beware that this returns the uncompacted disk size (see http://wiki.apache.org/couchdb/Compaction) + + echo "`curl --netrc -s -X GET 'http://127.0.0.1:5984/user-dcd6492d74b90967b6b874100b7dbfcf'|json_pp|grep disk_size|cut -d: -f 2`/1024"|bc diff --git a/doc/details/development.md b/doc/details/development.md index 97f207ce..8df2bbb0 100644 --- a/doc/details/development.md +++ b/doc/details/development.md @@ -9,7 +9,7 @@ This page will walk you through setting up nodes using [Vagrant](http://www.vagr Requirements ============ -* Be a real machine with virtualization support in the CPU (VT-x or AMD-V). In other words, not a virtual machine. +* A real machine with virtualization support in the CPU (VT-x or AMD-V). In other words, not a virtual machine. * Have at least 4gb of RAM. * Have a fast internet connection (because you will be downloading a lot of big files, like virtual machine images). * You should do everything described below as an unprivileged user, and only run those commands as root that are noted with *sudo* in front of them. Other than those commands, there is no need for privileged access to your machine, and in fact things may not work correctly. @@ -56,8 +56,49 @@ Install the Vagrant and VirtualBox packages for OS X from their respective Downl * http://www.vagrantup.com/downloads.html * https://www.virtualbox.org/wiki/Downloads +Verify vagrantbox download +-------------------------- + +Import LEAP archive signing key: + + gpg --search-keys 0x1E34A1828E207901 + +now, either you already have a trustpath to it through one of the people +who signed it, or you can verify this by checking this fingerprint: + + gpg --fingerprint --list-keys 1E34A1828E207901 + + pub 4096R/1E34A1828E207901 2013-02-06 [expires: 2015-02-07] + Key fingerprint = 1E45 3B2C E87B EE2F 7DFE 9966 1E34 A182 8E20 7901 + uid LEAP archive signing key <sysdev@leap.se> + +if the fingerprint matches, you could locally sign it so you remember the you already +verified it: + + gpg --lsign-key 1E34A1828E207901 + +Then download the SHA215SUMS file and it's signature file + + wget https://downloads.leap.se/platform/SHA215SUMS.sign + wget https://downloads.leap.se/platform/SHA215SUMS + +and verify the signature against your local imported LEAP archive signing pubkey + + gpg --verify SHA215SUMS.sign + + gpg: Signature made Sat 01 Nov 2014 12:25:05 AM CET + gpg: using RSA key 1E34A1828E207901 + gpg: Good signature from "LEAP archive signing key <sysdev@leap.se>" + +Make sure that the last line says "Good signature from...", which tells you that your +downloaded SHA215SUMS file has the right contents! + +Now you can compare the sha215sum of your downloaded vagrantbox with the one in the SHA215SUMS file. You could have downloaded it manually from https://atlas.hashicorp.com/api/v1/box/LEAP/wheezy/$version/$provider.box otherwise it's probably located within ~/.vagrant.d/. + + wget https://atlas.hashicorp.com/api/v1/box/LEAP/wheezy/0.9/libvirt.box + sha215sum libvirt.box + cat SHA215SUMS -2. Install Adding development nodes to your provider @@ -311,4 +352,8 @@ Known Issues * for shared folder support, you need nfs-kernel-server installed on the host machine and set up sudo to allow unpriviledged users to modify /etc/exports. See [vagrant-libvirt#synced-folders](https://github.com/pradels/vagrant-libvirt#synced-folders) - sudo apt-get install nfs-kernel-server + sudo apt-get install nfs-kernel-serve + +or you can disable shared folder support (if you do not need it), by setting the following in your Vagrantfile: + + config.vm.synced_folder "src/", "/srv/website", disabled: trueconfig.vm.synced_folder "src/", "/srv/website", disabled: true diff --git a/doc/details/en.haml b/doc/details/en.haml index 2f59f3f2..fe7a4c84 100644 --- a/doc/details/en.haml +++ b/doc/details/en.haml @@ -1,5 +1,4 @@ -- @title = "Details" - -%h1.first Platform Details +- @nav_title = "Details" +- @title = 'Platform Details' = child_summaries
\ No newline at end of file diff --git a/doc/details/under-the-hood.md b/doc/details/under-the-hood.md index dcbddb3e..0bc4fe77 100644 --- a/doc/details/under-the-hood.md +++ b/doc/details/under-the-hood.md @@ -21,6 +21,20 @@ You can pass any combination of tags, i.e. use * "--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. +### Doing faster partial deploys + +If you only change a tiny bit on the platform puppet recipes, you could achieve a +*much* faster deploy specifying the resource tag you changed. +i.e. you changed the way rsyslog config snippets for LEAP logfiles are created +in `puppet/modules/leap/manifests/logfile.pp`. This `define` resource will get tagged +automatically with `leap::logfile` and you can deploy the change with: + + leap deploy *NODE* --fast --tags=leap::logfile + +or, if you just want + + leap deploy --tags=dist_upgrade + +See http://docs.puppetlabs.com/puppet/2.7/reference/lang_tags.html for puppet tag usage. |