Move gnt-job to ganeti.client.gnt_job
[ganeti-local] / man / ganeti-noded.sgml
1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3   <!-- Please adjust the date whenever revising the manpage. -->
4   <!ENTITY dhdate      "<date>June 08, 2010</date>">
5   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
6        allowed: see man(7), man(1). -->
7   <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
8   <!ENTITY dhucpackage "<refentrytitle>ganeti-noded</refentrytitle>">
9   <!ENTITY dhpackage   "ganeti-noded">
10
11   <!ENTITY debian      "<productname>Debian</productname>">
12   <!ENTITY gnu         "<acronym>GNU</acronym>">
13   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
14   <!ENTITY footer SYSTEM "footer.sgml">
15 ]>
16
17 <refentry>
18   <refentryinfo>
19     <copyright>
20       <year>2006</year>
21       <year>2007</year>
22       <year>2008</year>
23       <year>2009</year>
24       <year>2010</year>
25       <holder>Google Inc.</holder>
26     </copyright>
27     &dhdate;
28   </refentryinfo>
29   <refmeta>
30     &dhucpackage;
31
32     &dhsection;
33     <refmiscinfo>Ganeti 2.2</refmiscinfo>
34   </refmeta>
35   <refnamediv>
36     <refname>&dhpackage;</refname>
37
38     <refpurpose>Ganeti node daemon</refpurpose>
39   </refnamediv>
40   <refsynopsisdiv>
41     <cmdsynopsis>
42       <command>&dhpackage; </command>
43       <arg>-f</arg>
44       <arg>-d</arg>
45
46     </cmdsynopsis>
47   </refsynopsisdiv>
48   <refsect1>
49     <title>DESCRIPTION</title>
50
51     <para>
52       The <command>&dhpackage;</command> is the daemon which is
53       responsible for the node functions in the Ganeti system.
54     </para>
55
56     <para>
57       By default, in order to be able to support features such as node
58       powercycling even on systems with a very damaged root disk,
59       <command>ganeti-noded</command> locks itself in RAM using
60       <citerefentry>
61         <refentrytitle>mlockall</refentrytitle>
62         <manvolnum>2</manvolnum>
63       </citerefentry>. You can disable this feature by passing in the
64       <option>--no-mlock</option> to the daemon.
65     </para>
66
67     <para>
68       For testing purposes, you can give the <option>-f</option>
69       option and the program won't detach from the running terminal.
70     </para>
71
72     <para>
73       Debug-level message can be activated by giving the
74       <option>-d</option> option.
75     </para>
76
77     <para>
78       Logging to syslog, rather than its own log file, can be enabled by
79       passing in the <option>--syslog</option> option.
80     </para>
81
82     <para>
83       The <command>ganeti-noded</command> daemon listens to port 1811 TCP, on
84       all interfaces, by default. This can be overridden by an entry the
85       services database (<filename>/etc/services</filename>) or by passing the
86       <option>-p</option> option. The <option>-b</option> option can be used to
87       specify the address to bind to (defaults to 0.0.0.0).
88     </para>
89
90     <para>
91       Ganeti noded communication is protected via SSL, with a key generated at
92       cluster init time. This can be disabled with the
93       <option>--no-ssl</option> option, or a different SSL key and certificate
94       can be specified using the <option>-K</option> and <option>-C</option>
95       options.
96     </para>
97
98     <refsect2>
99       <title>ROLE</title>
100       <para>
101         The role of the node daemon is to do almost all the actions
102         that change the state of the node. Things like creating disks
103         for instances, activating disks, starting/stopping instance
104         and so on are done via the node daemon.
105       </para>
106
107       <para>
108         Also, in some cases the startup/shutdown of the master daemon
109         are done via the node daemon, and the cluster IP address is
110         also added/removed to the master node via it.
111       </para>
112
113       <para>
114         If the node daemon is stopped, the instances are not affected,
115         but the master won't be able to talk to that node.
116       </para>
117     </refsect2>
118
119     <refsect2>
120       <title>COMMUNICATION PROTOCOL</title>
121       <para>
122         Currently the master-node RPC is done using a simple RPC protocol built
123         using JSON over HTTP(S).
124       </para>
125     </refsect2>
126
127   </refsect1>
128
129   &footer;
130
131 </refentry>
132
133 <!-- Keep this comment at the end of the file
134 Local variables:
135 mode: sgml
136 sgml-omittag:t
137 sgml-shorttag:t
138 sgml-minimize-attributes:nil
139 sgml-always-quote-attributes:t
140 sgml-indent-step:2
141 sgml-indent-data:t
142 sgml-parent-document:nil
143 sgml-default-dtd-file:nil
144 sgml-exposed-tags:nil
145 sgml-local-catalogs:nil
146 sgml-local-ecat-files:nil
147 End:
148 -->