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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='ref-kickstart'>
<title>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</title>
<section id='openembedded-kickstart-wks-reference'>
<title>Introduction</title>
<para>
The current Wic implementation supports only the basic kickstart
partitioning commands:
<filename>partition</filename> (or <filename>part</filename>
for short) and <filename>bootloader</filename>.
<note>
Future updates will implement more commands and options.
If you use anything that is not specifically supported, results
can be unpredictable.
</note>
</para>
<para>
This chapter provides a reference on the available kickstart
commands.
The information lists the commands, their syntax, and meanings.
Kickstart commands are based on the Fedora kickstart versions but
with modifications to reflect Wic capabilities.
You can see the original documentation for those commands at the
following links:
<itemizedlist>
<listitem><para>
<ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition'>http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition</ulink>
</para></listitem>
<listitem><para>
<ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader'>http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader</ulink>
</para></listitem>
</itemizedlist>
</para>
</section>
<section id='command-part-or-partition'>
<title>Command: part or partition</title>
<para>
Either of these commands create a partition on the system and use
the following syntax:
<literallayout class='monospaced'>
part [<replaceable>mntpoint</replaceable>]
partition [<replaceable>mntpoint</replaceable>]
</literallayout>
If you do not provide <replaceable>mntpoint</replaceable>, Wic
creates a partition but does not mount it.
</para>
<para>
The <filename><replaceable>mntpoint</replaceable></filename> is
where the partition will be mounted and must be of one of the
following forms:
<itemizedlist>
<listitem><para>
<filename>/<replaceable>path</replaceable></filename>:
For example, "/", "/usr", or "/home"
</para></listitem>
<listitem><para>
<filename>swap</filename>:
The created partition is used as swap space.
</para></listitem>
</itemizedlist>
</para>
<para>
Specifying a <replaceable>mntpoint</replaceable> causes the
partition to automatically be mounted.
Wic achieves this by adding entries to the filesystem table (fstab)
during image generation.
In order for wic to generate a valid fstab, you must also provide
one of the <filename>--ondrive</filename>,
<filename>--ondisk</filename>, or
<filename>--use-uuid</filename> partition options as part of the
command.
Here is an example using "/" as the mountpoint.
The command uses "--ondisk" to force the partition onto the
<filename>sdb</filename> disk:
<literallayout class='monospaced'>
part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
</literallayout>
</para>
<para>
Here is a list that describes other supported options you can use
with the <filename>part</filename> and
<filename>partition</filename> commands:
<itemizedlist>
<listitem><para>
<emphasis><filename>--size</filename>:</emphasis>
The minimum partition size in MBytes.
Specify an integer value such as 500.
Do not append the number with "MB".
You do not need this option if you use
<filename>--source</filename>.
</para></listitem>
<listitem><para>
<emphasis><filename>--source</filename>:</emphasis>
This option is a Wic-specific option that names the source
of the data that populates the partition.
The most common value for this option is "rootfs", but you
can use any value that maps to a valid source plug-in.
For information on the source plug-ins, see the
"<link linkend='wic-plug-ins-interface'>Wic Plug-Ins Interface</link>"
section.</para>
<para>If you use <filename>--source rootfs</filename>, Wic
creates a partition as large as needed and to fill it with
the contents of the root filesystem pointed to by the
<filename>-r</filename> command-line option or the
equivalent rootfs derived from the <filename>-e</filename>
command-line option.
The filesystem type used to create the partition is driven
by the value of the <filename>--fstype</filename> option
specified for the partition.
See the entry on <filename>--fstype</filename> that follows
for more information.</para>
<para>If you use
<filename>--source <replaceable>plugin-name</replaceable></filename>,
Wic creates a partition as large as needed and fills it
with the contents of the partition that is generated by the
specified plug-in name using the data pointed to by the
<filename>-r</filename> command-line option or the
equivalent rootfs derived from the <filename>-e</filename>
command-line option.
Exactly what those contents and filesystem type end up
being are dependent on the given plug-in implementation.
</para>
<para>If you do not use the <filename>--source</filename>
option, the <filename>wic</filename> command creates an
empty partition.
Consequently, you must use the <filename>--size</filename>
option to specify the size of the empty partition.
</para></listitem>
<listitem><para>
<emphasis><filename>--ondisk</filename> or <filename>--ondrive</filename>:</emphasis>
Forces the partition to be created on a particular disk.
</para></listitem>
<listitem><para>
<emphasis><filename>--fstype</filename>:</emphasis>
Sets the file system type for the partition.
Valid values are:
<itemizedlist>
<listitem><para>
<filename>ext4</filename>
</para></listitem>
<listitem><para>
<filename>ext3</filename>
</para></listitem>
<listitem><para>
<filename>ext2</filename>
</para></listitem>
<listitem><para>
<filename>btrfs</filename>
</para></listitem>
<listitem><para>
<filename>squashfs</filename>
</para></listitem>
<listitem><para>
<filename>swap</filename>
</para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>
<emphasis><filename>--fsoptions</filename>:</emphasis>
Specifies a free-form string of options to be used when
mounting the filesystem.
This string will be copied into the
<filename>/etc/fstab</filename> file of the installed
system and should be enclosed in quotes.
If not specified, the default string is "defaults".
</para></listitem>
<listitem><para>
<emphasis><filename>--label label</filename>:</emphasis>
Specifies the label to give to the filesystem to be made on
the partition.
If the given label is already in use by another filesystem,
a new label is created for the partition.
</para></listitem>
<listitem><para>
<emphasis><filename>--active</filename>:</emphasis>
Marks the partition as active.
</para></listitem>
<listitem><para>
<emphasis><filename>--align (in KBytes)</filename>:</emphasis>
This option is a Wic-specific option that says to start a
partition on an <replaceable>x</replaceable> KBytes
boundary.
</para></listitem>
<listitem><para>
<emphasis><filename>--no-table</filename>:</emphasis>
This option is a Wic-specific option.
Using the option reserves space for the partition and
causes it to become populated.
However, the partition is not added to the partition table.
</para></listitem>
<listitem><para>
<emphasis><filename>--extra-space</filename>:</emphasis>
This option is a Wic-specific option that adds extra space
after the space filled by the content of the partition.
The final size can go beyond the size specified by the
<filename>--size</filename> option.
The default value is 10 Mbytes.
</para></listitem>
<listitem><para>
<emphasis><filename>--overhead-factor</filename>:</emphasis>
This option is a Wic-specific option that multiplies the
size of the partition by the option's value.
You must supply a value greater than or equal to "1".
The default value is "1.3".
</para></listitem>
<listitem><para>
<emphasis><filename>--part-type</filename>:</emphasis>
This option is a Wic-specific option that specifies the
partition type globally unique identifier (GUID) for GPT
partitions.
You can find the list of partition type GUIDs at
<ulink url='http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs'></ulink>.
</para></listitem>
<listitem><para>
<emphasis><filename>--use-uuid</filename>:</emphasis>
This option is a Wic-specific option that causes Wic to
generate a random GUID for the partition.
The generated identifier is used in the bootloader
configuration to specify the root partition.
</para></listitem>
<listitem><para>
<emphasis><filename>--uuid</filename>:</emphasis>
This option is a Wic-specific option that specifies the
partition UUID.
</para></listitem>
</itemizedlist>
</para>
</section>
<section id='command-bootloader'>
<title>Command: bootloader</title>
<para>
This command specifies how the bootloader should be configured and
supports the following options:
<note>
Bootloader functionality and boot partitions are implemented by
the various <filename>--source</filename> plug-ins that
implement bootloader functionality.
The bootloader command essentially provides a means of
modifying bootloader configuration.
</note>
<itemizedlist>
<listitem><para>
<emphasis><filename>--timeout</filename>:</emphasis>
Specifies the number of seconds before the bootloader times
out and boots the default option.
</para></listitem>
<listitem><para>
<emphasis><filename>--append</filename>:</emphasis>
Specifies kernel parameters.
These parameters will be added to the syslinux
<filename>APPEND</filename> or <filename>grub</filename>
kernel command line.
</para></listitem>
<listitem><para>
<emphasis><filename>--configfile</filename>:</emphasis>
Specifies a user-defined configuration file for the
bootloader.
You can provide a full pathname for the file or a file that
exists in the <filename>canned-wks</filename> folder.
This option overrides all other bootloader options.
</para></listitem>
</itemizedlist>
</para>
</section>
</chapter>
<!--
vim: expandtab tw=80 ts=4
-->
|
