summaryrefslogtreecommitdiff
path: root/extensions/initramfs.write.help
diff options
context:
space:
mode:
Diffstat (limited to 'extensions/initramfs.write.help')
-rw-r--r--extensions/initramfs.write.help55
1 files changed, 0 insertions, 55 deletions
diff --git a/extensions/initramfs.write.help b/extensions/initramfs.write.help
deleted file mode 100644
index 54d3ae8c..00000000
--- a/extensions/initramfs.write.help
+++ /dev/null
@@ -1,55 +0,0 @@
-# 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