diff options
author | Adam Coldrick <adam.coldrick@codethink.co.uk> | 2015-06-02 13:52:51 +0000 |
---|---|---|
committer | Adam Coldrick <adam.coldrick@codethink.co.uk> | 2015-06-02 13:52:51 +0000 |
commit | 0cd8880023fc65ec581da95dd49a58b5996a1279 (patch) | |
tree | ab2c40dd442b044e12b4338fd55cab2dabf031c6 /initramfs.write.help | |
parent | 4f43fdd08770c113f7443fecbda43d4316091d4b (diff) | |
parent | 30cba5d9a8757f6bafc8079377aa3d6705e8364c (diff) | |
download | definitions-0cd8880023fc65ec581da95dd49a58b5996a1279.tar.gz |
Put the deployment extensions from morphlib in definitions
This merge commit merges the deployment extensions and all relevant
history from morphlib into definitions.
Diffstat (limited to 'initramfs.write.help')
-rw-r--r-- | initramfs.write.help | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/initramfs.write.help b/initramfs.write.help new file mode 100644 index 00000000..54d3ae8c --- /dev/null +++ b/initramfs.write.help @@ -0,0 +1,55 @@ +# Copyright (C) 2014, 2015 Codethink Limited +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; version 2 of the License. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with this program; if not, see <http://www.gnu.org/licenses/>. + +help: | + + Create an initramfs for a system by taking an existing system and + converting it to the appropriate format. + + The system must have a `/init` executable as the userland entry-point. + This can have a different path, if `rdinit=$path` is added to + the kernel command line. This can be added to the `rawdisk`, + `virtualbox-ssh` and `kvm` write extensions with the `KERNEL_CMDLINE` + option. + + It is possible to use a ramfs as the final rootfs without a `/init` + executable, by setting `root=/dev/mem`, or `rdinit=/sbin/init`, + but this is beyond the scope for the `initramfs.write` extension. + + The intended use of initramfs.write is to be part of a nested + deployment, so the parent system has an initramfs stored as + `/boot/initramfs.gz`. See the following example: + + name: initramfs-test + kind: cluster + systems: + - morph: minimal-system-x86_64-generic + deploy: + system: + type: rawdisk + location: initramfs-system-x86_64.img + DISK_SIZE: 1G + HOSTNAME: initramfs-system + INITRAMFS_PATH: boot/initramfs.gz + subsystems: + - morph: initramfs-x86_64 + deploy: + initramfs: + type: initramfs + location: boot/initramfs.gz + + Parameters: + + * location: the path where the initramfs will be installed (e.g. + `boot/initramfs.gz`) in the above example |