1OZ-INSTALL(1) General Commands Manual OZ-INSTALL(1)
2
6 oz-install - tool to automatically install operating systems into files
7
10 oz-install [OPTIONS] <tdl-file>
11
14 This is a tool to automatically install operating system into files
15 that represent disk images. The input is an XML file representing the
16 operating system and packages to be installed. By default (and by
17 design), the first stage of the install only installs a JEOS (Just
18 Enough Operating System); customization, including the installation of
19 additional packages can also be done, but requires additional flags.
20 Note that oz-install does the actual installation using a combination
22 of KVM and libvirt, so both of these must be available (and working)
23 for oz-install to have a chance to succeed.
24
27 -a <auto>
28 Use the user-provided auto installation file auto. By default,
29 Oz will use a hard-coded auto-installation file (kickstart, pre‐
30 seed, sif, etc) to do a basic OS installation. Using this
31 option, the user can provide an alternate auto-installation file
32 to do the install. The caveat is that user-provided auto-
33 installation files are more likely to cause installation errors,
34 so this option should be used with caution.
35 -c <config>
37 Get the configuration from config file config, instead of the
38 default /etc/oz/oz.cfg. If neither one exists, Oz will use sen‐
39 sible defaults. The config file is in standard ini format; for
40 an explanation of the sections and keys, see the CONFIGURATION
41 FILE section.
42 -d <loglevel>
44 Turn on debugging output to level loglevel. The log levels are:
45 0 - errors only (this is the default)
47 1 - errors and warnings
49 2 - errors, warnings, and information
51 3 - all messages
53 4 - all messages, prepended with the level and classname
55 -x <xmlfile>
57 Oz will normally generate a libvirt XML file in the current
58 working directory suffixed with the date and time. Specifing
59 the -x option allows the filename to be overridden.
60 -f Force the generation of new installation media. By default, oz-
62 install will always try to use a locally cached version of the
63 oz-modified install media if it is available. Failing that, oz-
64 install will try to use a locally cached version of the pristine
65 install media if it is available. You can use this flag to
66 force it to always download and regenerate the oz-modified
67 install media, even if it has a local version available.
68 -g Generate the ICICLE (a package manifest, with some additional
70 metadata) after the installation is complete.
71 -h Print a short help message.
73 -p Cleanup old guests before installation. By default, if a guest
75 with the same libvirt UUID, libvirt name, or diskimage exists
76 prior to Oz starting installation, Oz will abort. If this
77 option is used, then Oz will undefine the libvirt guest with the
78 same name or UUID and delete the diskimage, so it should be used
79 with caution.
80 -t <timeout>
82 Terminate the installation of the guest in timeout seconds
83 rather than the oz default. This value should be increased if
84 running on slow storage or running multiple oz-install opera‐
85 tions on the same machine.
86 Please note that there is a separate termination action that
88 occurs if 300 seconds elapses with no disk activity to the oper‐
89 ating system. This timer value is not configurable.
90 -u Customize the image after installation. This generally installs
92 additional packages onto the disk image after installation.
93
96 The Oz configuration file is in standard INI format with several sec‐
97 tions. If any section or configuration key is missing, Oz will use a
98 sensible default. For true/false configuration keys, the values of
99 "true", "True", "yes", or "Yes" can be used to turn the option on, and
100 "false", "False", "no", or "No" can be used to turn the behavior off.
101 The configuration file should have the following form:
102 [paths]
105 output_dir = /var/lib/libvirt/images
106 data_dir = /var/lib/oz
107 screenshot_dir = .
108 [libvirt]
110 uri = qemu:///system
111 type = kvm
112 bridge_name = virbr0
113 [cache]
115 original_media = yes
116 modified_media = no
117 jeos = no
118 The paths section defines the paths that Oz will use for storing data.
120 The output_dir key describes where to store the images after they are
121 built, and the data_dir key describes where to cache install media and
122 use temporary storage. Both locations must have a decent amount of
123 free disk space in order for Oz to work properly. The screenshot_dir
124 key describes where to store screenshots of failed installs.
125 The libvirt section allows some manipulation of how Oz uses libvirt.
127 The uri key describes the libvirt URI to use to do the guest installa‐
128 tion. The type key defines what type of virtualization to use. The
129 bridge_name key defines which bridge Oz should place the guests that it
130 launches on.
131 The cache section allows some manipulation of how Oz caches data. The
133 caching of data in Oz is a tradeoff between installation time and stor‐
134 age space. The original_media key tells Oz to cache the original
135 installation media so that it does not have to download it the next
136 time an install for the same operating system is requested. The modi‐
137 fied_media key tells Oz to cache the oz-modified installation media so
138 that it does not have to download and modify it the next time an
139 install for the same operating system is requested. The jeos key tells
140 Oz to cache the installed operating system after installation. This
141 can significantly speed up subsequent installation of the same operat‐
142 ing system, with the additional downside of the operating system get‐
143 ting out-of-date with respect to security updates. Use with care.
144
147 oz-generate-icicle(1), oz-customize(1), oz-cleanup-cache(1)
148
151 Chris Lalancette <clalance@redhat.com>
152oz-install Dec 2010 OZ-INSTALL(1)