summaryrefslogtreecommitdiffstats
path: root/helper/febootstrap-supermin-helper.pod
blob: 7a3dbd113748a693abb9b47eb4993c98200d15a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
=head1 NAME

febootstrap-supermin-helper - Reconstruct initramfs from supermin appliance.

=head1 SYNOPSIS

 febootstrap-supermin-helper supermin.img hostfiles.txt host_cpu kernel initrd
 febootstrap-supermin-helper input [...] host_cpu kernel initrd

 febootstrap-supermin-helper -f ext2 input [...] host_cpu kernel initrd appliance

=head1 DESCRIPTION

I<febootstrap-supermin-helper> reconstructs a bootable kernel and
initramfs from a supermin appliance.  First you should be familiar
with L<febootstrap(8)>, L<febootstrap-to-initramfs(8)> and
L<febootstrap-to-supermin(8)>.

=head1 PARAMETERS

Of the required parameters, the first few are I<input> files, and the
last two or three are I<output> files.

C<supermin.img> and C<hostfiles.txt> are the input files which
describe the supermin appliance.  (You can also use a directory name
here which is searched for files).

C<host_cpu> should be the host CPU, eg. C<x86_64> or C<i686>.

C<kernel>, C<initrd> and C<appliance> are the temporary output files
that this script produces.  These output files are meant to be used
just for booting the appliance, and should be deleted straight
afterwards.  The extra C<appliance> parameter is only required when
the format is C<ext2>.

=head1 OPTIONS

=over 4

=item B<-f fmt> | B<--format fmt>

Select the output format for the appliance.  Possible formats are:

=over 4

=item cpio

A Linux initramfs.  This is the default.

In this case you have to supply names for the C<kernel>
and C<initrd>, where the C<initrd> is the appliance.

=item ext2

An ext2 filesystem.

In this case you have to supply names for the C<kernel>,
a small C<initrd> which is used just to locate the appliance,
and the C<appliance> (the ext2 filesystem).

=back

=item B<-k file> | B<--kmods file>

If this option is specified, then C<file> should be a list of
wildcards matching kernel module names, eg:

 virtio*.ko
 scsi*.ko
 piix.ko

In this case, only kernel modules matching those wildcards will be
included in the output appliance.  Note: You must resolve any
dependencies yourself as this does not pull in dependent modules
automatically.

If this option is not specified, then every kernel module from the
host will be included.  This is safer, but can produce rather large
appliances which need a lot more memory to boot.

=back

=head1 SPEED

In libguestfs, on a mid-range Intel-based PC, we reconstruct the
initramfs using this script in around 1/5th of a second (assuming a
"hot cache" - it's rather slower when run the first time on a cold
cache).

Some tips to improve performance:

=over 4

=item *

Use a kernel module whitelist (the C<--kmods> option), and only
list the kernel modules you really need.

=item *

Minimize the appliance, removing as much extraneous junk as possible.

As well as using L<febootstrap-minimize(8)> it is worth checking for
anything that is not necessary for your particular application and
removing it by hand.

=back

=head1 SEE ALSO

L<febootstrap(8)>,
L<febootstrap-to-initramfs(8)>,
L<febootstrap-to-supermin(8)>.

=head1 AUTHORS

Richard W.M. Jones <rjones @ redhat . com>

=head1 COPYRIGHT

(C) Copyright 2009-2010 Red Hat Inc.,
L<http://people.redhat.com/~rjones/febootstrap>.

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; either version 2 of the License, or
(at your option) any later version.

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, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.