Revision a17deeab

b/doc/design-ovf-support.rst
85 85

  
86 86
In our implementation of the OVF we allow a choice between raw, cow and
87 87
vmdk disk formats for both import and export. Other formats covertable
88
using ``qemu-img`` are allowed, but not tested.
88
using ``qemu-img`` are allowed in import mode, but not tested.
89 89
The justification is the following:
90 90

  
91 91
- Raw format is supported as it is the main format of disk images used
......
250 250

  
251 251
As mentioned, Ganeti will allow export in  ``raw``, ``cow`` and ``vmdk``
252 252
formats.  This means i.e. that the appropriate ``ovf:format``
253
will be provided. It does not mean that other formats cannot be used,
254
rather that we did not test them.
253
will be provided.
255 254
As for import, we will support all formats that ``qemu-img`` can convert
256 255
to ``raw``. At this point this means ``raw``, ``cow``, ``qcow``,
257 256
``qcow2``, ``vmdk`` and ``cloop``.  We do not plan for now to support
......
268 267
purposes and is better standardized.
269 268

  
270 269
Please note, that due to security reasons we require the disk image to
271
be in the same directory as the ``.ovf`` description file.
270
be in the same directory as the ``.ovf`` description file for both
271
import and export.
272 272

  
273 273
In order to completely ignore disk-related information in resulting
274 274
config file, please use ``--disk-template=diskless`` option.
......
302 302
accessibility for Ganeti instances. List of installed OSes can be
303 303
checked using ``gnt-os list`` command.
304 304

  
305
References
306
----------
307

  
308
Files listed in ``ovf:References`` section cannot be hyperlinks.
309

  
305 310
Other
306 311
-----
307 312

  
......
425 430
---------------
426 431

  
427 432
Disk conversion for both import and export is done using external tool
428
called qemu-tools. The same tool is used to determine the type of disk,
429
as well as its virtual size.
433
called ``qemu-img``. The same tool is used to determine the type of
434
disk, as well as its virtual size.
430 435

  
431 436

  
432 437
Import
......
492 497
- if ``--ova`` option was chosen, pack the results into ``.ova`` tarfile
493 498

  
494 499

  
500
Work in progress
501
----------------
502

  
503
- conversion to/from raw disk should be quicker
504
- add graphic card memory to export information (12 MB of memory)
505
- space requirements for conversion + compression + ova are currently
506
  enormous
507
- add support for disks in chunks
508
- add support for certificates
509
- investigate why VMWare's ovftool does not work with ovfconverter's
510
  compression and ova packaging -- maybe noteworty: if OVA archive does
511
  not have a disk (i.e. in OVA package there is only .ovf ad .mf file),
512
  then the ovftool works
513
- investigate why new versions of VirtualBox have problems with OVF
514
  created by ovfconverter (everything works fine with 3.16 version, but
515
  not with 4.0)
516

  
517

  
495 518
.. vim: set textwidth=72 :
496 519
.. Local Variables:
497 520
.. mode: rst
b/doc/ovfconverter.rst
44 44
ignore unused elements of this section, so their presence won't raise
45 45
any warnings.
46 46

  
47

  
48 47
Operating System
49 48
----------------
50 49
List of operating systems available on a cluster is viewable using
51 50
``gnt-os list`` command. When importing from external source, providing
52 51
OS type in a command line (``--os-type=...``) is **required**. This is
53
because rven if the type is given in OVF description, it is not detailed
52
because even if the type is given in OVF description, it is not detailed
54 53
enough for Ganeti to know which os-specific scripts to use.
54
Please note, that instance containing disks may only be imported using
55
OS script that supports raw disk images.
56

  
57
References
58
----------
59
Files listed in ``ovf:References`` section cannot be hyperlinks.
60

  
61

  
62
Limitations on export
63
=====================
64

  
65
Disk content
66
------------
67
Most Ganeti instances do not contain grub. This results in some
68
problems when importing to virtualization software that does expect it.
69
Examples of such software include VirtualBox and VMWare.
70

  
71
To avoid trouble, please install grub inside the instance before
72
exporting it.
73

  
74

  
75
Import to VirtualBox
76
--------------------
77
``format`` option should be set to ``vmdk`` in order for instance to be
78
importable by VirtualBox.
79

  
80
Tests using existing versions of VirtualBox (3.16) suggest, that
81
VirtualBox does not support disk compression or OVA packaging. In future
82
versions this might change.
83

  
84

  
85
Import to VMWare
86
----------------
87
Importing Ganeti instance to VMWare was tested using ``ovftool``.
88

  
89
``format`` option should be set to ``vmdk`` in order for instance to be
90
importable by VMWare.
91

  
92
Presence of Ganeti section does seem to cause some problems and
93
therefore it is recommended to use ``--external`` option on export.
94

  
95
Import of compressed disks generated by ovfconverter was impossible in
96
current version of ``ovftool`` (2.1.0). This seems to be related to old
97
``vmdk`` version. Since the conversion to ``vmdk`` format is done using
98
``qemu-img``, it is possible and in fact expected, that future versions
99
of the latter tool will resolve this problem.
55 100

  
56 101

  
57 102
Import examples
......
130 175
Known issues
131 176
============
132 177

  
133
Export
134
------
135
When exporting to **VirtualBox**, you may encounter errors regarding
136
network. If that is the case, simply change the network type in options
137
to ``NAT``.
178
Conversion errors
179
-----------------
180
If you are encountering trouble when converting the disk, please ensure
181
that you have newest ``qemu-img`` version.
182

  
183
OVA and compression
184
-------------------
185
The compressed disks and OVA packaging do not work correctly in either
186
VirtualBox (old version) or VMWare.
187

  
188
VirtualBox (3.16 OSE) does not seem to support those two, so there is
189
very little we can do about this.
190

  
191
As for VMWare, the reason behind it not accepting compressed or packed
192
instances created by ovfconverter seems to be related to the old vmdk
193
version.
194

  
195
Problems on newest VirtualBox
196
-----------------------------
197
In Oracle VM Virtualbox 4.0+ there seems to be a problem when importing
198
any OVF instance created by ovfconverter. Reasons are again unknown,
199
this will be investigated.
200

  
201
Disk space
202
----------
203
The disk space requirements for both import and export are at the moment
204
very large - we require free space up to about 3-4 times the size of
205
disks. This will most likely be changed in future versions.
138 206

  
139 207

  
140 208
.. vim: set textwidth=72 :

Also available in: Unified diff