From feee2b3b60a642102e797399c3071903cce99728 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20G=C3=A2teau?= Date: Fri, 25 Jul 2014 16:43:32 +0200 Subject: [PATCH] Document keys in GlobalStorage --- hacking/GlobalStorage.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 hacking/GlobalStorage.md diff --git a/hacking/GlobalStorage.md b/hacking/GlobalStorage.md new file mode 100644 index 000000000..e7fec1458 --- /dev/null +++ b/hacking/GlobalStorage.md @@ -0,0 +1,24 @@ +# GlobalStorage keys + +The GlobalStorage structure contains information which is shared among jobs. +Jobs are free to define their own keys, but some keys have been standardized. +Here they are: + +## bootLoader + +A dictionary with the following keys: + +- `installPath`: device where the boot loader should be installed ("/dev/sda", "/dev/sdb1"...) + +## partitions + +A list of dictionaries, one per partition. The dictionary contains the following keys: + +- `device`: path to the partition device +- `fs`: the name of the file system +- `mountPoint`: where the device should be mounted + +## rootMountPoint + +A string which contains the path where the root file system has been mounted. +This key is set by the `mount` job.