1OZ-GENERATE-ICICLE(1) General Commands Manual OZ-GENERATE-ICICLE(1)
2
6 oz-generate-icicle - tool to generate an ICICLE (package manifest) of a
7 disk image
8
11 oz-generate-icicle [OPTIONS] <tdl-file> <libvirt-xml-file>
12
15 This is a tool to generate a package manifest (also called ICICLE) from
16 a disk image. This program can be used as a counterpart to oz-install,
17 though it does not have to be used in conjunction.
18 Note that oz-generate-icicle does the actual work using a combination
20 of KVM and libvirt, so both of these must be available (and working)
21 for oz-generate-icicle to have a chance to succeed.
22
25 -c <config>
26 Get the configuration from config file config, instead of the
27 default /etc/oz/oz.cfg. If neither one exists, Oz will use sen‐
28 sible defaults. The config file is in standard ini format; for
29 an explanation of the sections and keys, see the CONFIGURATION
30 FILE section.
31 -d <loglevel>
33 Turn on debugging output to level loglevel. The log levels are:
34 0 - errors only (this is the default)
36 1 - errors and warnings
38 2 - errors, warnings, and information
40 3 - all messages
42 4 - all messages, prepended with the level and classname
44 -h Print a short help message.
46 -i <icicle>
48 oz-generate-icicle will normally write the ICICLE XML to stdout.
49 To have oz-generate-icicle write the ICICLE to a file instead,
50 use this option.
51
54 The Oz configuration file is in standard INI format with several sec‐
55 tions. If any section or configuration key is missing, Oz will use a
56 sensible default. For true/false configuration keys, the values of
57 "true", "True", "yes", or "Yes" can be used to turn the option on, and
58 "false", "False", "no", or "No" can be used to turn the behavior off.
59 The configuration file should have the following form:
60 [paths]
63 output_dir = /var/lib/libvirt/images
64 data_dir = /var/lib/oz
65 screenshot_dir = .
66 sshprivkey = /etc/oz/id_rsa-icicle-gen
67 [libvirt]
69 uri = qemu:///system
70 type = kvm
71 bridge_name = virbr0
72 cpus = 1
73 memory = 1024
74 image_type = raw
75 [cache]
77 original_media = yes
78 modified_media = no
79 jeos = no
80 [icicle]
82 safe_generation = no
83 The paths section defines the paths that Oz will use for storing data.
85 The output_dir key describes where to store the images after they are
86 built, and the data_dir key describes where to cache install media and
87 use temporary storage. Both locations must have a decent amount of
88 free disk space in order for Oz to work properly. The screenshot_dir
89 key describes where to store screenshots of failed installs. The ssh‐
90 privkey key describes where the ssh keys are stored, which are required
91 by Oz to do customization of the image.
92 The libvirt section allows some manipulation of how Oz uses libvirt.
94 The uri key describes the libvirt URI to use to do the guest installa‐
95 tion. The type key defines what type of virtualization to use. The
96 bridge_name key defines which bridge Oz should place the guests that it
97 launches on. The cpus key defines how many cpus should be used inside
98 the virtual machine. The memory key defines how much memory (in
99 megabytes) should be used inside the virtual machine. The image_type
100 key defines which output disk type should be used; this can be any
101 value that libvirt supports.
102 The cache section allows some manipulation of how Oz caches data. The
104 caching of data in Oz is a tradeoff between installation time and stor‐
105 age space. The original_media key tells Oz to cache the original
106 installation media so that it does not have to download it the next
107 time an install for the same operating system is requested. The modi‐
108 fied_media key tells Oz to cache the oz-modified installation media so
109 that it does not have to download and modify it the next time an
110 install for the same operating system is requested. The jeos key tells
111 Oz to cache the installed operating system after installation. This
112 can significantly speed up subsequent installation of the same operat‐
113 ing system, with the additional downside of the operating system get‐
114 ting out-of-date with respect to security updates. Use with care.
115 The icicle section allows some manipulation of how Oz generates ICICLE
117 output. ICICLE is a package manifest that can optionally be generated
118 at the end of installs. The safe_generation key controls whether Oz
119 uses a throwaway overlay file while generating the ICICLE. If it is
120 set to "no" (the default), then Oz will boot up the guest at the end of
121 the install and run the appropriate commands to generate the ICICLE.
122 If it is set to "yes", then Oz will use a throwaway overlay file while
123 generating the ICICLE. After the ICICLE is generated, Oz will delete
124 the backing file, leaving the original disk image pristine.
125
128 oz-install(1), oz-customize(1), oz-cleanup-cache(1), oz-examples(1)
129
132 Chris Lalancette <clalancette@gmail.com>
133oz-generate-icicle Aug 2011 OZ-GENERATE-ICICLE(1)