root / man / gnt-backup.sgml @ c05bcecf
History | View | Annotate | Download (8.5 kB)
1 | dd4b1106 | Iustin Pop | <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|---|---|---|
2 | dd4b1106 | Iustin Pop | |
3 | dd4b1106 | Iustin Pop | <!-- Fill in your name for FIRSTNAME and SURNAME. --> |
4 | dd4b1106 | Iustin Pop | <!-- Please adjust the date whenever revising the manpage. --> |
5 | dd4b1106 | Iustin Pop | <!ENTITY dhdate "<date>Jul 6, 2007</date>"> |
6 | dd4b1106 | Iustin Pop | <!-- SECTION should be 1-8, maybe w/ subsection other parameters are |
7 | dd4b1106 | Iustin Pop | allowed: see man(7), man(1). --> |
8 | dd4b1106 | Iustin Pop | <!ENTITY dhsection "<manvolnum>8</manvolnum>"> |
9 | dd4b1106 | Iustin Pop | <!ENTITY dhucpackage "<refentrytitle>gnt-backup</refentrytitle>"> |
10 | dd4b1106 | Iustin Pop | <!ENTITY dhpackage "gnt-backup"> |
11 | dd4b1106 | Iustin Pop | |
12 | dd4b1106 | Iustin Pop | <!ENTITY debian "<productname>Debian</productname>"> |
13 | dd4b1106 | Iustin Pop | <!ENTITY gnu "<acronym>GNU</acronym>"> |
14 | dd4b1106 | Iustin Pop | <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> |
15 | dd4b1106 | Iustin Pop | <!ENTITY footer SYSTEM "footer.sgml"> |
16 | dd4b1106 | Iustin Pop | ]> |
17 | dd4b1106 | Iustin Pop | |
18 | dd4b1106 | Iustin Pop | <refentry> |
19 | dd4b1106 | Iustin Pop | <refentryinfo> |
20 | dd4b1106 | Iustin Pop | <copyright> |
21 | dd4b1106 | Iustin Pop | <year>2007</year> |
22 | dd4b1106 | Iustin Pop | <holder>Google Inc.</holder> |
23 | dd4b1106 | Iustin Pop | </copyright> |
24 | dd4b1106 | Iustin Pop | &dhdate; |
25 | dd4b1106 | Iustin Pop | </refentryinfo> |
26 | dd4b1106 | Iustin Pop | <refmeta> |
27 | dd4b1106 | Iustin Pop | &dhucpackage; |
28 | dd4b1106 | Iustin Pop | |
29 | dd4b1106 | Iustin Pop | &dhsection; |
30 | dd4b1106 | Iustin Pop | <refmiscinfo>ganeti 1.2</refmiscinfo> |
31 | dd4b1106 | Iustin Pop | </refmeta> |
32 | dd4b1106 | Iustin Pop | <refnamediv> |
33 | dd4b1106 | Iustin Pop | <refname>&dhpackage;</refname> |
34 | dd4b1106 | Iustin Pop | |
35 | dd4b1106 | Iustin Pop | <refpurpose>ganeti instance import/export</refpurpose> |
36 | dd4b1106 | Iustin Pop | </refnamediv> |
37 | dd4b1106 | Iustin Pop | <refsynopsisdiv> |
38 | dd4b1106 | Iustin Pop | <cmdsynopsis> |
39 | dd4b1106 | Iustin Pop | <command>&dhpackage; </command> |
40 | dd4b1106 | Iustin Pop | |
41 | dd4b1106 | Iustin Pop | <arg choice="req">command</arg> |
42 | dd4b1106 | Iustin Pop | <arg>arguments...</arg> |
43 | dd4b1106 | Iustin Pop | </cmdsynopsis> |
44 | dd4b1106 | Iustin Pop | </refsynopsisdiv> |
45 | dd4b1106 | Iustin Pop | <refsect1> |
46 | dd4b1106 | Iustin Pop | <title>DESCRIPTION</title> |
47 | dd4b1106 | Iustin Pop | |
48 | dd4b1106 | Iustin Pop | <para> |
49 | dd4b1106 | Iustin Pop | The <command>&dhpackage;</command> is used for importing and exporting |
50 | dd4b1106 | Iustin Pop | instances and their configuration from a ganeti system. It is useful for |
51 | dd4b1106 | Iustin Pop | backing instances up and also to migrate them between clusters. |
52 | dd4b1106 | Iustin Pop | </para> |
53 | dd4b1106 | Iustin Pop | |
54 | dd4b1106 | Iustin Pop | </refsect1> |
55 | dd4b1106 | Iustin Pop | <refsect1> |
56 | dd4b1106 | Iustin Pop | <title>COMMANDS</title> |
57 | dd4b1106 | Iustin Pop | |
58 | dd4b1106 | Iustin Pop | <refsect2> |
59 | dd4b1106 | Iustin Pop | <title>EXPORT</title> |
60 | dd4b1106 | Iustin Pop | |
61 | dd4b1106 | Iustin Pop | <cmdsynopsis> |
62 | dd4b1106 | Iustin Pop | <command>export</command> |
63 | dd4b1106 | Iustin Pop | <arg choice="req">-n <replaceable>node</replaceable></arg> |
64 | dd4b1106 | Iustin Pop | <arg>--noshutdown</arg> |
65 | dd4b1106 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
66 | dd4b1106 | Iustin Pop | </cmdsynopsis> |
67 | dd4b1106 | Iustin Pop | |
68 | dd4b1106 | Iustin Pop | <para> |
69 | f69dab6d | Iustin Pop | Exports an instance to the target node. All the instance data |
70 | f69dab6d | Iustin Pop | and its configuration will be exported under the |
71 | f69dab6d | Iustin Pop | /srv/ganeti/exports/<replaceable>instance</replaceable> |
72 | f69dab6d | Iustin Pop | directory on the target node. |
73 | dd4b1106 | Iustin Pop | </para> |
74 | dd4b1106 | Iustin Pop | |
75 | dd4b1106 | Iustin Pop | <para> |
76 | dd4b1106 | Iustin Pop | The <option>--noshutdown</option> option will create a |
77 | dd4b1106 | Iustin Pop | snapshot disk of the instance without shutting it down first. |
78 | dd4b1106 | Iustin Pop | While this is faster and involves no downtime, it cannot be |
79 | dd4b1106 | Iustin Pop | guaranteed that the instance data will be in a consistent state |
80 | dd4b1106 | Iustin Pop | in the exported dump. |
81 | dd4b1106 | Iustin Pop | </para> |
82 | dd4b1106 | Iustin Pop | |
83 | dd4b1106 | Iustin Pop | <para> |
84 | dd4b1106 | Iustin Pop | Example: |
85 | dd4b1106 | Iustin Pop | <screen> |
86 | 017778ac | Guido Trotter | # gnt-backup export -n node1.example.com instance3.example.com |
87 | dd4b1106 | Iustin Pop | </screen> |
88 | dd4b1106 | Iustin Pop | </para> |
89 | dd4b1106 | Iustin Pop | </refsect2> |
90 | dd4b1106 | Iustin Pop | |
91 | dd4b1106 | Iustin Pop | <refsect2> |
92 | dd4b1106 | Iustin Pop | <title>IMPORT</title> |
93 | dd4b1106 | Iustin Pop | <cmdsynopsis> |
94 | dd4b1106 | Iustin Pop | <command>import</command> |
95 | 4677a909 | Michael Hanselmann | <arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg> |
96 | dd4b1106 | Iustin Pop | <arg>-s <replaceable>disksize</replaceable></arg> |
97 | 1e808cbf | Guido Trotter | <arg>--swap-size <replaceable>disksize</replaceable></arg> |
98 | dd4b1106 | Iustin Pop | <arg>-m <replaceable>memsize</replaceable></arg> |
99 | dd4b1106 | Iustin Pop | <arg>-b <replaceable>bridge</replaceable></arg> |
100 | dd4b1106 | Iustin Pop | <sbr> |
101 | dd4b1106 | Iustin Pop | <arg choice="req">-t<group> |
102 | dd4b1106 | Iustin Pop | <arg>diskless</arg> |
103 | dd4b1106 | Iustin Pop | <arg>plain</arg> |
104 | dd4b1106 | Iustin Pop | <arg>local_raid1</arg> |
105 | dd4b1106 | Iustin Pop | <arg>remote_raid1</arg> |
106 | f69dab6d | Iustin Pop | <arg>drbd</arg> |
107 | dd4b1106 | Iustin Pop | </group> |
108 | dd4b1106 | Iustin Pop | </arg> |
109 | f69dab6d | Iustin Pop | <sbr> |
110 | dd4b1106 | Iustin Pop | <arg choice="req">--src-node=<replaceable>source-node</replaceable></arg> |
111 | dd4b1106 | Iustin Pop | <arg choice="req">--src-dir=<replaceable>source-dir</replaceable></arg> |
112 | dd4b1106 | Iustin Pop | <arg choice="req"><replaceable>instance</replaceable></arg> |
113 | dd4b1106 | Iustin Pop | </cmdsynopsis> |
114 | dd4b1106 | Iustin Pop | <para> |
115 | dd4b1106 | Iustin Pop | Imports a new instance from an export residing on |
116 | dd4b1106 | Iustin Pop | <replaceable>source-node</replaceable> in |
117 | dd4b1106 | Iustin Pop | <replaceable>source-dir</replaceable>. |
118 | dd4b1106 | Iustin Pop | <replaceable>instance</replaceable> must be in DNS and |
119 | dd4b1106 | Iustin Pop | resolve to a IP in the same network as the nodes in the |
120 | dd4b1106 | Iustin Pop | cluster. |
121 | dd4b1106 | Iustin Pop | </para> |
122 | dd4b1106 | Iustin Pop | |
123 | dd4b1106 | Iustin Pop | <para> |
124 | dd4b1106 | Iustin Pop | The <option>-s</option> option specifies the disk size for |
125 | d5687e89 | Guido Trotter | the instance, in mebibytes (defaults to |
126 | d5687e89 | Guido Trotter | <constant>20480MiB</constant> = |
127 | d5687e89 | Guido Trotter | <constant>20GiB</constant>). You can also use one of the |
128 | d5687e89 | Guido Trotter | suffixes <literal>m</literal>, <literal>g</literal> or |
129 | d5687e89 | Guido Trotter | <literal>t</literal> to specificy the exact the units used; |
130 | d5687e89 | Guido Trotter | these suffixes map to mebibytes, gibibytes and tebibytes. |
131 | dd4b1106 | Iustin Pop | </para> |
132 | dd4b1106 | Iustin Pop | |
133 | dd4b1106 | Iustin Pop | <para> |
134 | 1e808cbf | Guido Trotter | The <option>--swap-size</option> option specifies the swap |
135 | 1e808cbf | Guido Trotter | disk size (in mebibytes) for the instance (the one presented |
136 | 1e808cbf | Guido Trotter | as <filename class="devicefile">/dev/sdb</filename>). The |
137 | 1e808cbf | Guido Trotter | default is <constant>4096MiB</constant>. As for the disk |
138 | 1e808cbf | Guido Trotter | size, you can specify other suffixes. |
139 | 1e808cbf | Guido Trotter | </para> |
140 | 1e808cbf | Guido Trotter | |
141 | 1e808cbf | Guido Trotter | <para> |
142 | dd4b1106 | Iustin Pop | The <option>-m</option> option specifies the memory size for |
143 | 88269100 | Guido Trotter | the instance, in mebibytes (defaults to 128 MiB). Again, you |
144 | 88269100 | Guido Trotter | can use other suffixes (e.g. <userinput>2g</userinput>). |
145 | dd4b1106 | Iustin Pop | </para> |
146 | dd4b1106 | Iustin Pop | |
147 | dd4b1106 | Iustin Pop | <para> |
148 | dd4b1106 | Iustin Pop | The <option>-b</option> option specifies the bridge to which the |
149 | dd4b1106 | Iustin Pop | instance will be connected. (defaults to the cluster-wide default |
150 | dd4b1106 | Iustin Pop | bridge specified at cluster intialization time). |
151 | dd4b1106 | Iustin Pop | </para> |
152 | dd4b1106 | Iustin Pop | |
153 | dd4b1106 | Iustin Pop | <para> |
154 | dd4b1106 | Iustin Pop | The <option>-t</option> options specifies the disk layout type for |
155 | dd4b1106 | Iustin Pop | the instance. The available choices are: |
156 | dd4b1106 | Iustin Pop | <variablelist> |
157 | dd4b1106 | Iustin Pop | <varlistentry> |
158 | dd4b1106 | Iustin Pop | <term>diskless</term> |
159 | dd4b1106 | Iustin Pop | <listitem> |
160 | dd4b1106 | Iustin Pop | <para> |
161 | dd4b1106 | Iustin Pop | This creates an instance with no disks. Its useful for |
162 | dd4b1106 | Iustin Pop | testing only (or other special cases). |
163 | dd4b1106 | Iustin Pop | </para> |
164 | dd4b1106 | Iustin Pop | </listitem> |
165 | dd4b1106 | Iustin Pop | </varlistentry> |
166 | dd4b1106 | Iustin Pop | <varlistentry> |
167 | dd4b1106 | Iustin Pop | <term>plain</term> |
168 | dd4b1106 | Iustin Pop | <listitem> |
169 | dd4b1106 | Iustin Pop | <para>Disk devices will be logical volumes.</para> |
170 | dd4b1106 | Iustin Pop | </listitem> |
171 | dd4b1106 | Iustin Pop | </varlistentry> |
172 | dd4b1106 | Iustin Pop | <varlistentry> |
173 | dd4b1106 | Iustin Pop | <term>local_raid1</term> |
174 | dd4b1106 | Iustin Pop | <listitem> |
175 | dd4b1106 | Iustin Pop | <para> |
176 | dd4b1106 | Iustin Pop | Disk devices will be md raid1 arrays over two local |
177 | dd4b1106 | Iustin Pop | logical volumes. |
178 | dd4b1106 | Iustin Pop | </para> |
179 | dd4b1106 | Iustin Pop | </listitem> |
180 | dd4b1106 | Iustin Pop | </varlistentry> |
181 | dd4b1106 | Iustin Pop | <varlistentry> |
182 | dd4b1106 | Iustin Pop | <term>remote_raid1</term> |
183 | dd4b1106 | Iustin Pop | <listitem> |
184 | dd4b1106 | Iustin Pop | <para> |
185 | f69dab6d | Iustin Pop | Disk devices will be md raid1 arrays with one |
186 | f69dab6d | Iustin Pop | component (so it's not actually raid1): a drbd (0.7.x) |
187 | f69dab6d | Iustin Pop | device between the instance's primary node and the |
188 | f69dab6d | Iustin Pop | node given by the second value of the |
189 | 4677a909 | Michael Hanselmann | <option>--node</option> option. |
190 | dd4b1106 | Iustin Pop | </para> |
191 | dd4b1106 | Iustin Pop | </listitem> |
192 | dd4b1106 | Iustin Pop | </varlistentry> |
193 | f69dab6d | Iustin Pop | <varlistentry> |
194 | f69dab6d | Iustin Pop | <term>drbd</term> |
195 | f69dab6d | Iustin Pop | <listitem> |
196 | f69dab6d | Iustin Pop | <para> |
197 | f69dab6d | Iustin Pop | Disk devices will be drbd (version 8.x) on top of lvm |
198 | f69dab6d | Iustin Pop | volumes. They are equivalent in functionality to |
199 | f69dab6d | Iustin Pop | <replaceable>remote_raid1</replaceable>, but are |
200 | f69dab6d | Iustin Pop | recommended for new instances (if you have drbd 8.x |
201 | f69dab6d | Iustin Pop | installed). |
202 | f69dab6d | Iustin Pop | </para> |
203 | f69dab6d | Iustin Pop | </listitem> |
204 | f69dab6d | Iustin Pop | </varlistentry> |
205 | dd4b1106 | Iustin Pop | </variablelist> |
206 | dd4b1106 | Iustin Pop | </para> |
207 | dd4b1106 | Iustin Pop | |
208 | dd4b1106 | Iustin Pop | <para> |
209 | c234fe4c | Guido Trotter | The optional second value of the <option>--node</option> is used for |
210 | c234fe4c | Guido Trotter | the remote raid template type and specifies the remote node. |
211 | c234fe4c | Guido Trotter | </para> |
212 | c234fe4c | Guido Trotter | |
213 | c234fe4c | Guido Trotter | <para> |
214 | 017778ac | Guido Trotter | If you do not want gnt-backup to wait for the disk mirror |
215 | dd4b1106 | Iustin Pop | to be synced, use the <option>--no-wait-for-sync</option> |
216 | dd4b1106 | Iustin Pop | option. |
217 | dd4b1106 | Iustin Pop | </para> |
218 | dd4b1106 | Iustin Pop | |
219 | dd4b1106 | Iustin Pop | <para> |
220 | dd4b1106 | Iustin Pop | Example: |
221 | dd4b1106 | Iustin Pop | <screen> |
222 | dd4b1106 | Iustin Pop | # gnt-backup import -t plain -s 30 -m 512 -n node1.example.com \ |
223 | dd4b1106 | Iustin Pop | > --src-node=node2.example.com \ |
224 | dd4b1106 | Iustin Pop | > --src-dir=/srv/ganeti/exports/instance3.example.com \ |
225 | dd4b1106 | Iustin Pop | > instance3.example.com |
226 | dd4b1106 | Iustin Pop | </screen> |
227 | dd4b1106 | Iustin Pop | </para> |
228 | dd4b1106 | Iustin Pop | |
229 | dd4b1106 | Iustin Pop | </refsect2> |
230 | dd4b1106 | Iustin Pop | |
231 | dd4b1106 | Iustin Pop | <refsect2> |
232 | dd4b1106 | Iustin Pop | <title>LIST</title> |
233 | dd4b1106 | Iustin Pop | |
234 | dd4b1106 | Iustin Pop | <cmdsynopsis> |
235 | dd4b1106 | Iustin Pop | <command>list</command> |
236 | 59885275 | Guido Trotter | <arg>--node=<replaceable>NODE</replaceable></arg> |
237 | dd4b1106 | Iustin Pop | </cmdsynopsis> |
238 | dd4b1106 | Iustin Pop | |
239 | dd4b1106 | Iustin Pop | <para> |
240 | f69dab6d | Iustin Pop | Lists the exports currently available in the default directory |
241 | f69dab6d | Iustin Pop | in all the nodes of the current cluster, or optionally only a |
242 | 59885275 | Guido Trotter | subset of them specified using the <option>--node</option> |
243 | 59885275 | Guido Trotter | option (which can be used multiple times) |
244 | dd4b1106 | Iustin Pop | </para> |
245 | dd4b1106 | Iustin Pop | |
246 | f69dab6d | Iustin Pop | <para> |
247 | f69dab6d | Iustin Pop | Example: |
248 | f69dab6d | Iustin Pop | <screen> |
249 | f69dab6d | Iustin Pop | # gnt-backup list --nodes node1 --nodes node2 |
250 | f69dab6d | Iustin Pop | </screen> |
251 | dd4b1106 | Iustin Pop | </refsect2> |
252 | dd4b1106 | Iustin Pop | |
253 | dd4b1106 | Iustin Pop | </refsect1> |
254 | dd4b1106 | Iustin Pop | |
255 | dd4b1106 | Iustin Pop | &footer; |
256 | dd4b1106 | Iustin Pop | |
257 | dd4b1106 | Iustin Pop | </refentry> |
258 | dd4b1106 | Iustin Pop | |
259 | dd4b1106 | Iustin Pop | <!-- Keep this comment at the end of the file |
260 | dd4b1106 | Iustin Pop | Local variables: |
261 | dd4b1106 | Iustin Pop | mode: sgml |
262 | dd4b1106 | Iustin Pop | sgml-omittag:t |
263 | dd4b1106 | Iustin Pop | sgml-shorttag:t |
264 | dd4b1106 | Iustin Pop | sgml-minimize-attributes:nil |
265 | dd4b1106 | Iustin Pop | sgml-always-quote-attributes:t |
266 | dd4b1106 | Iustin Pop | sgml-indent-step:2 |
267 | dd4b1106 | Iustin Pop | sgml-indent-data:t |
268 | dd4b1106 | Iustin Pop | sgml-parent-document:nil |
269 | dd4b1106 | Iustin Pop | sgml-default-dtd-file:nil |
270 | dd4b1106 | Iustin Pop | sgml-exposed-tags:nil |
271 | dd4b1106 | Iustin Pop | sgml-local-catalogs:nil |
272 | dd4b1106 | Iustin Pop | sgml-local-ecat-files:nil |
273 | dd4b1106 | Iustin Pop | End: |
274 | dd4b1106 | Iustin Pop | --> |