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