root / man / gnt-node.sgml @ dcb93971
History | View | Annotate | Download (9.1 kB)
1 | a8083063 | Iustin Pop | <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|---|---|---|
2 | a8083063 | Iustin Pop | |
3 | a8083063 | Iustin Pop | <!-- Fill in your name for FIRSTNAME and SURNAME. --> |
4 | a8083063 | Iustin Pop | <!-- Please adjust the date whenever revising the manpage. --> |
5 | a8083063 | Iustin Pop | <!ENTITY dhdate "<date>June 20, 2007</date>"> |
6 | a8083063 | Iustin Pop | <!-- SECTION should be 1-8, maybe w/ subsection other parameters are |
7 | a8083063 | Iustin Pop | allowed: see man(7), man(1). --> |
8 | a8083063 | Iustin Pop | <!ENTITY dhsection "<manvolnum>8</manvolnum>"> |
9 | a8083063 | Iustin Pop | <!ENTITY dhucpackage "<refentrytitle>gnt-node</refentrytitle>"> |
10 | a8083063 | Iustin Pop | <!ENTITY dhpackage "gnt-node"> |
11 | a8083063 | Iustin Pop | |
12 | a8083063 | Iustin Pop | <!ENTITY debian "<productname>Debian</productname>"> |
13 | a8083063 | Iustin Pop | <!ENTITY gnu "<acronym>GNU</acronym>"> |
14 | a8083063 | Iustin Pop | <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> |
15 | a8083063 | Iustin Pop | <!ENTITY footer SYSTEM "footer.sgml"> |
16 | a8083063 | Iustin Pop | ]> |
17 | a8083063 | Iustin Pop | |
18 | a8083063 | Iustin Pop | <refentry> |
19 | a8083063 | Iustin Pop | <refentryinfo> |
20 | a8083063 | Iustin Pop | <copyright> |
21 | a8083063 | Iustin Pop | <year>2006</year> |
22 | a8083063 | Iustin Pop | <year>2007</year> |
23 | a8083063 | Iustin Pop | <holder>Google Inc.</holder> |
24 | a8083063 | Iustin Pop | </copyright> |
25 | a8083063 | Iustin Pop | &dhdate; |
26 | a8083063 | Iustin Pop | </refentryinfo> |
27 | a8083063 | Iustin Pop | <refmeta> |
28 | a8083063 | Iustin Pop | &dhucpackage; |
29 | a8083063 | Iustin Pop | |
30 | a8083063 | Iustin Pop | &dhsection; |
31 | a8083063 | Iustin Pop | <refmiscinfo>ganeti 1.2</refmiscinfo> |
32 | a8083063 | Iustin Pop | </refmeta> |
33 | a8083063 | Iustin Pop | <refnamediv> |
34 | a8083063 | Iustin Pop | <refname>&dhpackage;</refname> |
35 | a8083063 | Iustin Pop | |
36 | a8083063 | Iustin Pop | <refpurpose>node administration</refpurpose> |
37 | a8083063 | Iustin Pop | </refnamediv> |
38 | a8083063 | Iustin Pop | <refsynopsisdiv> |
39 | a8083063 | Iustin Pop | <cmdsynopsis> |
40 | a8083063 | Iustin Pop | <command>&dhpackage; </command> |
41 | a8083063 | Iustin Pop | |
42 | a8083063 | Iustin Pop | <arg choice="req">command</arg> |
43 | a8083063 | Iustin Pop | <arg>arguments...</arg> |
44 | a8083063 | Iustin Pop | </cmdsynopsis> |
45 | a8083063 | Iustin Pop | </refsynopsisdiv> |
46 | a8083063 | Iustin Pop | <refsect1> |
47 | a8083063 | Iustin Pop | <title>DESCRIPTION</title> |
48 | a8083063 | Iustin Pop | |
49 | a8083063 | Iustin Pop | <para> |
50 | a8083063 | Iustin Pop | The <command>&dhpackage;</command> is used for managing the |
51 | a8083063 | Iustin Pop | (physical) nodes in the ganeti system. |
52 | a8083063 | Iustin Pop | </para> |
53 | a8083063 | Iustin Pop | |
54 | a8083063 | Iustin Pop | </refsect1> |
55 | a8083063 | Iustin Pop | <refsect1> |
56 | a8083063 | Iustin Pop | <title>COMMANDS</title> |
57 | a8083063 | Iustin Pop | |
58 | a8083063 | Iustin Pop | <refsect2> |
59 | a8083063 | Iustin Pop | <title>ADD</title> |
60 | a8083063 | Iustin Pop | |
61 | a8083063 | Iustin Pop | <cmdsynopsis> |
62 | a8083063 | Iustin Pop | <command>add</command> |
63 | a8083063 | Iustin Pop | <arg>-s <replaceable>secondary_ip</replaceable></arg> |
64 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
65 | a8083063 | Iustin Pop | </cmdsynopsis> |
66 | a8083063 | Iustin Pop | |
67 | a8083063 | Iustin Pop | <para> |
68 | a8083063 | Iustin Pop | Adds the given node to the cluster. |
69 | a8083063 | Iustin Pop | </para> |
70 | a8083063 | Iustin Pop | |
71 | a8083063 | Iustin Pop | <para> |
72 | a8083063 | Iustin Pop | This command is used to join a new node to the cluster. You |
73 | a8083063 | Iustin Pop | will have to provide the password for root of the node to be |
74 | a8083063 | Iustin Pop | able to add the node in the cluster. The command needs to be |
75 | a8083063 | Iustin Pop | run on the ganeti master. |
76 | a8083063 | Iustin Pop | </para> |
77 | a8083063 | Iustin Pop | |
78 | a8083063 | Iustin Pop | <para> |
79 | a8083063 | Iustin Pop | Note that the command is potentially destructive, as it will |
80 | a8083063 | Iustin Pop | forcibly join the specified host the cluster, not paying |
81 | a8083063 | Iustin Pop | attention to its current status (it could be already in a |
82 | a8083063 | Iustin Pop | cluster, etc.) |
83 | a8083063 | Iustin Pop | </para> |
84 | a8083063 | Iustin Pop | |
85 | a8083063 | Iustin Pop | <para> |
86 | a8083063 | Iustin Pop | The <option>-s</option> is used in dual-home clusters and |
87 | a8083063 | Iustin Pop | specifies the new node's IP in the secondary network. See the |
88 | a8083063 | Iustin Pop | discussion in <citerefentry> |
89 | a8083063 | Iustin Pop | <refentrytitle>gnt-cluster</refentrytitle> |
90 | a8083063 | Iustin Pop | <manvolnum>8</manvolnum> </citerefentry> for more |
91 | a8083063 | Iustin Pop | informations. |
92 | a8083063 | Iustin Pop | </para> |
93 | a8083063 | Iustin Pop | |
94 | a8083063 | Iustin Pop | <para> |
95 | a8083063 | Iustin Pop | Example: |
96 | a8083063 | Iustin Pop | <screen> |
97 | a8083063 | Iustin Pop | # gnt-node add node5.example.com |
98 | a8083063 | Iustin Pop | # gnt-node add -s 192.168.44.5 node5.example.com |
99 | a8083063 | Iustin Pop | </screen> |
100 | a8083063 | Iustin Pop | </para> |
101 | a8083063 | Iustin Pop | </refsect2> |
102 | a8083063 | Iustin Pop | |
103 | a8083063 | Iustin Pop | <refsect2> |
104 | a8083063 | Iustin Pop | <title>INFO</title> |
105 | a8083063 | Iustin Pop | |
106 | a8083063 | Iustin Pop | <cmdsynopsis> |
107 | a8083063 | Iustin Pop | <command>info</command> |
108 | a8083063 | Iustin Pop | <arg rep="repeat"><replaceable>node</replaceable></arg> |
109 | a8083063 | Iustin Pop | </cmdsynopsis> |
110 | a8083063 | Iustin Pop | |
111 | a8083063 | Iustin Pop | <para> |
112 | a8083063 | Iustin Pop | Show detailed information about the nodes in the cluster. If you |
113 | a8083063 | Iustin Pop | don't give any arguments, all nodes will be shows, otherwise the |
114 | a8083063 | Iustin Pop | output will be restricted to the given names. |
115 | a8083063 | Iustin Pop | </para> |
116 | a8083063 | Iustin Pop | </refsect2> |
117 | a8083063 | Iustin Pop | |
118 | a8083063 | Iustin Pop | <refsect2> |
119 | a8083063 | Iustin Pop | <title>LIST</title> |
120 | a8083063 | Iustin Pop | |
121 | a8083063 | Iustin Pop | <cmdsynopsis> |
122 | a8083063 | Iustin Pop | <command>list</command> |
123 | a8083063 | Iustin Pop | <arg>--no-headers</arg> |
124 | a8083063 | Iustin Pop | <arg>--separator=<replaceable>SEPARATOR</replaceable></arg> |
125 | a8083063 | Iustin Pop | <arg>-o <replaceable>FIELD,...</replaceable></arg> |
126 | a8083063 | Iustin Pop | </cmdsynopsis> |
127 | a8083063 | Iustin Pop | |
128 | a8083063 | Iustin Pop | <para> |
129 | a8083063 | Iustin Pop | Lists the nodes in the cluster. If you give the |
130 | a8083063 | Iustin Pop | <option>--ip-info</option> option, the output contains just |
131 | a8083063 | Iustin Pop | the node name, primary ip and secondary ip. In case the |
132 | a8083063 | Iustin Pop | secondary ip is the same as the primary one, it will be listed |
133 | a8083063 | Iustin Pop | as <emphasis>"-"</emphasis>. |
134 | a8083063 | Iustin Pop | </para> |
135 | a8083063 | Iustin Pop | |
136 | a8083063 | Iustin Pop | <para> |
137 | a8083063 | Iustin Pop | The <option>--no-headers</option> option will skip the initial |
138 | a8083063 | Iustin Pop | header line. The <option>--separator</option> option takes an |
139 | a8083063 | Iustin Pop | argument which denotes what will be used between the output |
140 | a8083063 | Iustin Pop | fields. Both these options are to help scripting. |
141 | a8083063 | Iustin Pop | </para> |
142 | a8083063 | Iustin Pop | |
143 | a8083063 | Iustin Pop | <para> |
144 | a8083063 | Iustin Pop | The <option>-o</option> option takes a comma-separated list of |
145 | a8083063 | Iustin Pop | output fields. The available fields and their meaning are: |
146 | a8083063 | Iustin Pop | <variablelist> |
147 | a8083063 | Iustin Pop | <varlistentry> |
148 | a8083063 | Iustin Pop | <term>name</term> |
149 | a8083063 | Iustin Pop | <listitem> |
150 | a8083063 | Iustin Pop | <simpara>the node name</simpara> |
151 | a8083063 | Iustin Pop | </listitem> |
152 | a8083063 | Iustin Pop | </varlistentry> |
153 | a8083063 | Iustin Pop | <varlistentry> |
154 | a8083063 | Iustin Pop | <term>pinst</term> |
155 | a8083063 | Iustin Pop | <listitem> |
156 | a8083063 | Iustin Pop | <simpara>the number of instances having this node as |
157 | a8083063 | Iustin Pop | primary</simpara> |
158 | a8083063 | Iustin Pop | </listitem> |
159 | a8083063 | Iustin Pop | </varlistentry> |
160 | a8083063 | Iustin Pop | <varlistentry> |
161 | a8083063 | Iustin Pop | <term>sinst</term> |
162 | a8083063 | Iustin Pop | <listitem> |
163 | a8083063 | Iustin Pop | <simpara>the number of instances having this node as a |
164 | a8083063 | Iustin Pop | secondary node</simpara> |
165 | a8083063 | Iustin Pop | </listitem> |
166 | a8083063 | Iustin Pop | </varlistentry> |
167 | a8083063 | Iustin Pop | <varlistentry> |
168 | a8083063 | Iustin Pop | <term>pip</term> |
169 | a8083063 | Iustin Pop | <listitem> |
170 | a8083063 | Iustin Pop | <simpara>the primary ip of this node (used for cluster |
171 | a8083063 | Iustin Pop | communication)</simpara> |
172 | a8083063 | Iustin Pop | </listitem> |
173 | a8083063 | Iustin Pop | </varlistentry> |
174 | a8083063 | Iustin Pop | <varlistentry> |
175 | a8083063 | Iustin Pop | <term>sip</term> |
176 | a8083063 | Iustin Pop | <listitem> |
177 | a8083063 | Iustin Pop | <simpara> |
178 | a8083063 | Iustin Pop | the secondary ip of this node (used for data |
179 | a8083063 | Iustin Pop | replication in dual-ip clusters, see <citerefentry> |
180 | a8083063 | Iustin Pop | <refentrytitle>gnt-cluster</refentrytitle> |
181 | a8083063 | Iustin Pop | <manvolnum>8</manvolnum> |
182 | a8083063 | Iustin Pop | </citerefentry> |
183 | a8083063 | Iustin Pop | </simpara> |
184 | a8083063 | Iustin Pop | </listitem> |
185 | a8083063 | Iustin Pop | </varlistentry> |
186 | a8083063 | Iustin Pop | <varlistentry> |
187 | a8083063 | Iustin Pop | <term>dtotal</term> |
188 | a8083063 | Iustin Pop | <listitem> |
189 | a8083063 | Iustin Pop | <simpara>total disk space in the volume group used for |
190 | a8083063 | Iustin Pop | instance disk allocations</simpara> |
191 | a8083063 | Iustin Pop | </listitem> |
192 | a8083063 | Iustin Pop | </varlistentry> |
193 | a8083063 | Iustin Pop | <varlistentry> |
194 | a8083063 | Iustin Pop | <term>dfree</term> |
195 | a8083063 | Iustin Pop | <listitem> |
196 | a8083063 | Iustin Pop | <simpara>available disk space in the volume group</simpara> |
197 | a8083063 | Iustin Pop | </listitem> |
198 | a8083063 | Iustin Pop | </varlistentry> |
199 | a8083063 | Iustin Pop | <varlistentry> |
200 | a8083063 | Iustin Pop | <term>mtotal</term> |
201 | a8083063 | Iustin Pop | <listitem> |
202 | a8083063 | Iustin Pop | <simpara>total memory on the physical node</simpara> |
203 | a8083063 | Iustin Pop | </listitem> |
204 | a8083063 | Iustin Pop | </varlistentry> |
205 | a8083063 | Iustin Pop | <varlistentry> |
206 | a8083063 | Iustin Pop | <term>mnode</term> |
207 | a8083063 | Iustin Pop | <listitem> |
208 | a8083063 | Iustin Pop | <simpara>the memory used by the node itself</simpara> |
209 | a8083063 | Iustin Pop | </listitem> |
210 | a8083063 | Iustin Pop | </varlistentry> |
211 | a8083063 | Iustin Pop | <varlistentry> |
212 | a8083063 | Iustin Pop | <term>mfree</term> |
213 | a8083063 | Iustin Pop | <listitem> |
214 | a8083063 | Iustin Pop | <simpara>memory available for instance |
215 | a8083063 | Iustin Pop | allocations</simpara> |
216 | a8083063 | Iustin Pop | </listitem> |
217 | a8083063 | Iustin Pop | </varlistentry> |
218 | a8083063 | Iustin Pop | </variablelist> |
219 | a8083063 | Iustin Pop | </para> |
220 | a8083063 | Iustin Pop | |
221 | a8083063 | Iustin Pop | <para> |
222 | a8083063 | Iustin Pop | Note that some of this fields are known from the configuration |
223 | a8083063 | Iustin Pop | of the cluster (<simplelist type="inline"> |
224 | a8083063 | Iustin Pop | <member>name</member> <member>pinst</member> |
225 | a8083063 | Iustin Pop | <member>sinst</member> <member>pip</member> |
226 | a8083063 | Iustin Pop | <member>sip</member> </simplelist> and thus the master does |
227 | a8083063 | Iustin Pop | not need to contact the node for this data (making the listing |
228 | a8083063 | Iustin Pop | fast if only fields from this set are selected), whereas the |
229 | a8083063 | Iustin Pop | other fields are "live" fields and we need to make a query to |
230 | a8083063 | Iustin Pop | the cluster nodes. |
231 | a8083063 | Iustin Pop | </para> |
232 | a8083063 | Iustin Pop | |
233 | a8083063 | Iustin Pop | <para> |
234 | a8083063 | Iustin Pop | Depending on the virtualization type and implementation |
235 | a8083063 | Iustin Pop | details, the mtotal, mnode and mfree may have slighly varying |
236 | a8083063 | Iustin Pop | meanings. For example, some solutions share the node memory |
237 | a8083063 | Iustin Pop | with the pool of memory used for instances |
238 | a8083063 | Iustin Pop | (<acronym>UML</acronym>), whereas others have separate memory |
239 | a8083063 | Iustin Pop | for the node and for the instances (Xen). |
240 | a8083063 | Iustin Pop | </para> |
241 | a8083063 | Iustin Pop | </refsect2> |
242 | a8083063 | Iustin Pop | |
243 | a8083063 | Iustin Pop | <refsect2> |
244 | a8083063 | Iustin Pop | <title>REMOVE</title> |
245 | a8083063 | Iustin Pop | |
246 | a8083063 | Iustin Pop | <cmdsynopsis> |
247 | a8083063 | Iustin Pop | <command>remove</command> |
248 | a8083063 | Iustin Pop | <arg choice="req"><replaceable>nodename</replaceable></arg> |
249 | a8083063 | Iustin Pop | </cmdsynopsis> |
250 | a8083063 | Iustin Pop | |
251 | a8083063 | Iustin Pop | <para> |
252 | a8083063 | Iustin Pop | Removes a node from the cluster. Instances must be removed or |
253 | a8083063 | Iustin Pop | migrated to another cluster before. |
254 | a8083063 | Iustin Pop | </para> |
255 | a8083063 | Iustin Pop | |
256 | a8083063 | Iustin Pop | <para> |
257 | a8083063 | Iustin Pop | Example: |
258 | a8083063 | Iustin Pop | <screen> |
259 | a8083063 | Iustin Pop | # gnt-node remove node5.example.com |
260 | a8083063 | Iustin Pop | </screen> |
261 | a8083063 | Iustin Pop | </para> |
262 | a8083063 | Iustin Pop | </refsect2> |
263 | a8083063 | Iustin Pop | |
264 | dcb93971 | Michael Hanselmann | <refsect2> |
265 | dcb93971 | Michael Hanselmann | <title>VOLUMES</title> |
266 | dcb93971 | Michael Hanselmann | |
267 | dcb93971 | Michael Hanselmann | <cmdsynopsis> |
268 | dcb93971 | Michael Hanselmann | <command>volumes</command> |
269 | dcb93971 | Michael Hanselmann | <arg rep="repeat"><replaceable>node</replaceable></arg> |
270 | dcb93971 | Michael Hanselmann | </cmdsynopsis> |
271 | dcb93971 | Michael Hanselmann | |
272 | dcb93971 | Michael Hanselmann | <para> |
273 | dcb93971 | Michael Hanselmann | Lists all logical volumes and their physical disks from the node(s) |
274 | dcb93971 | Michael Hanselmann | provided. |
275 | dcb93971 | Michael Hanselmann | </para> |
276 | dcb93971 | Michael Hanselmann | |
277 | dcb93971 | Michael Hanselmann | <para> |
278 | dcb93971 | Michael Hanselmann | Example: |
279 | dcb93971 | Michael Hanselmann | <screen> |
280 | dcb93971 | Michael Hanselmann | # gnt-node volumes node5.example.com |
281 | dcb93971 | Michael Hanselmann | Node PhysDev VG Name Size Instance |
282 | dcb93971 | Michael Hanselmann | node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11000.meta 128 instance1.example.com |
283 | dcb93971 | Michael Hanselmann | node1.example.com /dev/hdc1 xenvg instance1.example.com-sda_11001.data 256 instance1.example.com |
284 | dcb93971 | Michael Hanselmann | </screen> |
285 | dcb93971 | Michael Hanselmann | </para> |
286 | dcb93971 | Michael Hanselmann | </refsect2> |
287 | dcb93971 | Michael Hanselmann | |
288 | a8083063 | Iustin Pop | </refsect1> |
289 | a8083063 | Iustin Pop | |
290 | a8083063 | Iustin Pop | &footer; |
291 | a8083063 | Iustin Pop | |
292 | a8083063 | Iustin Pop | </refentry> |
293 | a8083063 | Iustin Pop | |
294 | a8083063 | Iustin Pop | <!-- Keep this comment at the end of the file |
295 | a8083063 | Iustin Pop | Local variables: |
296 | a8083063 | Iustin Pop | mode: sgml |
297 | a8083063 | Iustin Pop | sgml-omittag:t |
298 | a8083063 | Iustin Pop | sgml-shorttag:t |
299 | a8083063 | Iustin Pop | sgml-minimize-attributes:nil |
300 | a8083063 | Iustin Pop | sgml-always-quote-attributes:t |
301 | a8083063 | Iustin Pop | sgml-indent-step:2 |
302 | a8083063 | Iustin Pop | sgml-indent-data:t |
303 | a8083063 | Iustin Pop | sgml-parent-document:nil |
304 | a8083063 | Iustin Pop | sgml-default-dtd-file:nil |
305 | a8083063 | Iustin Pop | sgml-exposed-tags:nil |
306 | a8083063 | Iustin Pop | sgml-local-catalogs:nil |
307 | a8083063 | Iustin Pop | sgml-local-ecat-files:nil |
308 | a8083063 | Iustin Pop | End: |
309 | a8083063 | Iustin Pop | --> |