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