root / doc / ovfconverter.rst @ 54f834df
History | View | Annotate | Download (4.7 kB)
1 | 97c60815 | Agata Murawska | ============= |
---|---|---|---|
2 | 97c60815 | Agata Murawska | OVF converter |
3 | 97c60815 | Agata Murawska | ============= |
4 | 97c60815 | Agata Murawska | |
5 | 97c60815 | Agata Murawska | Using ``ovfconverter`` from the ``tools`` directory, one can easily |
6 | 97c60815 | Agata Murawska | convert previously exported Ganeti instance into OVF package, supported |
7 | 97c60815 | Agata Murawska | by VMWare, VirtualBox and some other virtualization software. It is |
8 | 97c60815 | Agata Murawska | also possible to use instance exported from such a tool and convert it |
9 | 97c60815 | Agata Murawska | to Ganeti config file, used by ``gnt-backup import`` command. |
10 | 97c60815 | Agata Murawska | |
11 | 97c60815 | Agata Murawska | For the internal design of the converter and more detailed description, |
12 | 97c60815 | Agata Murawska | including listing of available command line options, please refer to |
13 | 97c60815 | Agata Murawska | :doc:`design-ovf-support` |
14 | 97c60815 | Agata Murawska | |
15 | 97c60815 | Agata Murawska | As the amount of Ganeti-specific details, that need to be provided in |
16 | 97c60815 | Agata Murawska | order to import an external instance, is rather large, we will present |
17 | 97c60815 | Agata Murawska | here some examples of importing instances from different sources. |
18 | 97c60815 | Agata Murawska | It is also worth noting that there are some limitations regarding |
19 | 97c60815 | Agata Murawska | support for different hardware. |
20 | 97c60815 | Agata Murawska | |
21 | 97c60815 | Agata Murawska | Limitations on import |
22 | 97c60815 | Agata Murawska | ===================== |
23 | 97c60815 | Agata Murawska | |
24 | 97c60815 | Agata Murawska | Network |
25 | 97c60815 | Agata Murawska | ------- |
26 | 97c60815 | Agata Murawska | Available modes for the network include ``bridged`` and ``routed``. |
27 | 97c60815 | Agata Murawska | There is no ``NIC`` mode, which is typically used e.g. by VirtualBox. |
28 | 97c60815 | Agata Murawska | For most usecases this should not be of any effect, since if |
29 | 97c60815 | Agata Murawska | ``NetworkSection`` contains any networks which are not discovered as |
30 | 97c60815 | Agata Murawska | ``bridged`` or ``routed``, the network mode is assigned automatically, |
31 | 97c60815 | Agata Murawska | using Ganeti's cluster defaults. |
32 | 97c60815 | Agata Murawska | |
33 | 97c60815 | Agata Murawska | Backend |
34 | 97c60815 | Agata Murawska | ------- |
35 | 97c60815 | Agata Murawska | The only values that are taken into account regarding Virtual Hardware |
36 | 97c60815 | Agata Murawska | (described in ``VirtualHardwareSection`` of the ``.ovf`` file) are: |
37 | 97c60815 | Agata Murawska | |
38 | 97c60815 | Agata Murawska | - number of virtual CPUs |
39 | 97c60815 | Agata Murawska | - RAM memory |
40 | 97c60815 | Agata Murawska | - hard disks |
41 | 97c60815 | Agata Murawska | - networks |
42 | 97c60815 | Agata Murawska | |
43 | 97c60815 | Agata Murawska | Neither USB nor CD-ROM drive are used in Ganeti. We decided to simply |
44 | 97c60815 | Agata Murawska | ignore unused elements of this section, so their presence won't raise |
45 | 97c60815 | Agata Murawska | any warnings. |
46 | 97c60815 | Agata Murawska | |
47 | 97c60815 | Agata Murawska | |
48 | 97c60815 | Agata Murawska | Operating System |
49 | 97c60815 | Agata Murawska | ---------------- |
50 | 97c60815 | Agata Murawska | List of operating systems available on a cluster is viewable using |
51 | 97c60815 | Agata Murawska | ``gnt-os list`` command. When importing from external source, providing |
52 | 97c60815 | Agata Murawska | OS type in a command line (``--os-type=...``) is **required**. This is |
53 | 97c60815 | Agata Murawska | because rven if the type is given in OVF description, it is not detailed |
54 | 97c60815 | Agata Murawska | enough for Ganeti to know which os-specific scripts to use. |
55 | 97c60815 | Agata Murawska | |
56 | 97c60815 | Agata Murawska | |
57 | 97c60815 | Agata Murawska | Import examples |
58 | 97c60815 | Agata Murawska | =============== |
59 | 97c60815 | Agata Murawska | |
60 | 97c60815 | Agata Murawska | Ganeti's OVF |
61 | 97c60815 | Agata Murawska | ------------ |
62 | 97c60815 | Agata Murawska | If you are importing instance created using ``ovfconverter export`` -- |
63 | 97c60815 | Agata Murawska | you most probably will not have to provide any additional information. |
64 | 97c60815 | Agata Murawska | In that case, the following is all you need (unless you wish to change |
65 | 97c60815 | Agata Murawska | some configuration options):: |
66 | 97c60815 | Agata Murawska | |
67 | 97c60815 | Agata Murawska | ovfconverter import ganeti.ovf |
68 | 97c60815 | Agata Murawska | [...] |
69 | 97c60815 | Agata Murawska | gnt-instance import -n <node> <instance name> |
70 | 97c60815 | Agata Murawska | |
71 | 97c60815 | Agata Murawska | |
72 | 97c60815 | Agata Murawska | Virtualbox, VMWare and other external sources |
73 | 97c60815 | Agata Murawska | --------------------------------------------- |
74 | 97c60815 | Agata Murawska | In case of importing from external source, you will most likely have to |
75 | 97c60815 | Agata Murawska | provide the following details: |
76 | 97c60815 | Agata Murawska | |
77 | 97c60815 | Agata Murawska | - ``os-type`` can be any operating system listed on ``gnt-os list`` |
78 | 97c60815 | Agata Murawska | - ``name`` that has to be resolvable, as it will be used as instance |
79 | 97c60815 | Agata Murawska | name (even if your external instance has a name, it most probably is |
80 | 97c60815 | Agata Murawska | not resolvable to an IP address) |
81 | 97c60815 | Agata Murawska | |
82 | 97c60815 | Agata Murawska | These are not the only options, but the recommended ones. For the |
83 | 97c60815 | Agata Murawska | complete list of available options please refer to |
84 | 97c60815 | Agata Murawska | `Command Line description <design-ovf-support.rst>` |
85 | 97c60815 | Agata Murawska | |
86 | 97c60815 | Agata Murawska | Minimalistic but complete example of importing Virtualbox's OVF |
87 | 97c60815 | Agata Murawska | instance may look like:: |
88 | 97c60815 | Agata Murawska | |
89 | 97c60815 | Agata Murawska | ovfconverter virtualbox.ovf --os-type=lenny-image \ |
90 | 97c60815 | Agata Murawska | --name=xen.test.i1 --disk-template=diskless |
91 | 97c60815 | Agata Murawska | [...] |
92 | 97c60815 | Agata Murawska | gnt-instance import -n node1.xen xen.test.i1 |
93 | 97c60815 | Agata Murawska | |
94 | 97c60815 | Agata Murawska | |
95 | 54f834df | Agata Murawska | |
96 | 54f834df | Agata Murawska | Export example |
97 | 54f834df | Agata Murawska | ============== |
98 | 54f834df | Agata Murawska | |
99 | 54f834df | Agata Murawska | Exporting instance into ``.ovf`` format is pretty streightforward and |
100 | 54f834df | Agata Murawska | requires little - if any - explanation. The only compulsory detail is |
101 | 54f834df | Agata Murawska | the required disk format, provided using the ``--format`` option. |
102 | 54f834df | Agata Murawska | |
103 | 54f834df | Agata Murawska | Export to another Ganeti instance |
104 | 54f834df | Agata Murawska | --------------------------------- |
105 | 54f834df | Agata Murawska | If for some reason it is convenient for you to use ``ovfconverter`` to |
106 | 54f834df | Agata Murawska | move instance between clusters (e.g. because of the disk compression), |
107 | 54f834df | Agata Murawska | the complete example of export may look like this:: |
108 | 54f834df | Agata Murawska | |
109 | 54f834df | Agata Murawska | gnt-backup export -n node1.xen xen.test.i1 |
110 | 54f834df | Agata Murawska | [...] |
111 | 54f834df | Agata Murawska | ovfconverter export --format=vmdk --ova \ |
112 | 54f834df | Agata Murawska | /srv/ganeti/export/xen.i1.node1.xen/config.ini |
113 | 54f834df | Agata Murawska | [...] |
114 | 54f834df | Agata Murawska | |
115 | 54f834df | Agata Murawska | The result is then in |
116 | 54f834df | Agata Murawska | ``/srv/ganeti/export/xen.i1.node1.xen/xen.test.i1.ova`` |
117 | 54f834df | Agata Murawska | |
118 | 54f834df | Agata Murawska | Export to Virtualbox/VMWare/other external tool |
119 | 54f834df | Agata Murawska | ----------------------------------------------- |
120 | 54f834df | Agata Murawska | Typically, when exporting to external tool we do not want |
121 | 54f834df | Agata Murawska | Ganeti-specific configuration to be saved. In that case, simply use the |
122 | 54f834df | Agata Murawska | ``--external`` option:: |
123 | 54f834df | Agata Murawska | |
124 | 54f834df | Agata Murawska | gnt-backup export -n node1.xen xen.test.i1 |
125 | 54f834df | Agata Murawska | [...] |
126 | 54f834df | Agata Murawska | ovfconverter export --external --output-dir ~/ganeti-instance/ \ |
127 | 54f834df | Agata Murawska | /srv/ganeti/export/xen.i1.node1.xen/config.ini |
128 | 54f834df | Agata Murawska | |
129 | 54f834df | Agata Murawska | |
130 | 54f834df | Agata Murawska | Known issues |
131 | 54f834df | Agata Murawska | ============ |
132 | 54f834df | Agata Murawska | |
133 | 54f834df | Agata Murawska | Export |
134 | 54f834df | Agata Murawska | ------ |
135 | 54f834df | Agata Murawska | When exporting to **VirtualBox**, you may encounter errors regarding |
136 | 54f834df | Agata Murawska | network. If that is the case, simply change the network type in options |
137 | 54f834df | Agata Murawska | to ``NAT``. |
138 | 54f834df | Agata Murawska | |
139 | 54f834df | Agata Murawska | |
140 | 97c60815 | Agata Murawska | .. vim: set textwidth=72 : |
141 | 97c60815 | Agata Murawska | .. Local Variables: |
142 | 97c60815 | Agata Murawska | .. mode: rst |
143 | 97c60815 | Agata Murawska | .. fill-column: 72 |
144 | 97c60815 | Agata Murawska | .. End: |