Commit c2e818b6 authored by Iustin Pop's avatar Iustin Pop
Browse files

Remove the SGML man sources



… finally!
Signed-off-by: default avatarIustin Pop <iustin@google.com>
Reviewed-by: default avatarRené Nussbaumer <rn@google.com>
parent 6be8e2bf
<refsect1>
<title>REPORTING BUGS</title>
<para>
Report bugs to <ulink
url="http://code.google.com/p/ganeti/"></ulink> or contact the
developers using the Ganeti mailing list
&lt;ganeti@googlegroups.com&gt;.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
Ganeti overview and specifications:
<citerefentry>
<refentrytitle>ganeti</refentrytitle>
<manvolnum>7</manvolnum>
</citerefentry> (general overview),
<citerefentry>
<refentrytitle>ganeti-os-interface</refentrytitle>
<manvolnum>7</manvolnum>
</citerefentry> (guest OS definitions).
</para>
<para>Ganeti commands:
<citerefentry>
<refentrytitle>gnt-cluster</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (cluster-wide commands),
<citerefentry>
<refentrytitle>gnt-job</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (job-related commands),
<citerefentry>
<refentrytitle>gnt-node</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (node-related commands),
<citerefentry>
<refentrytitle>gnt-instance</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (instance commands),
<citerefentry>
<refentrytitle>gnt-os</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (guest OS commands),
<citerefentry>
<refentrytitle>gnt-backup</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (instance import/export commands),
<citerefentry>
<refentrytitle>gnt-debug</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (debug commands).
</para>
<para>Ganeti daemons:
<citerefentry>
<refentrytitle>ganeti-watcher</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (automatic instance restarter),
<citerefentry>
<refentrytitle>ganeti-cleaner</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (job queue cleaner),
<citerefentry>
<refentrytitle>ganeti-noded</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (node daemon),
<citerefentry>
<refentrytitle>ganeti-masterd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (master daemon),
<citerefentry>
<refentrytitle>ganeti-rapi</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> (remote API daemon).
</para>
</refsect1>
<refsect1>
<title>COPYRIGHT</title>
<para>
Copyright (C) 2006, 2007, 2008, 2009, 2010 Google Inc. Permission is
granted to copy, distribute and/or modify under the terms of the
&gnu; General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option)
any later version.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
</para>
</refsect1>
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>June 08, 2010</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>8</manvolnum>">
<!ENTITY dhucpackage "<refentrytitle>ganeti-cleaner</refentrytitle>">
<!ENTITY dhpackage "ganeti-cleaner">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<!ENTITY footer SYSTEM "footer.sgml">
]>
<refentry>
<refentryinfo>
<copyright>
<year>2009</year>
<year>2010</year>
<holder>Google Inc.</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
<refmiscinfo>Ganeti 2.2</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Ganeti job queue cleaner</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
The <command>&dhpackage;</command> is a periodically run script to clean
old job files from the job queue archive and to remove expired X509
certificates and keys.
</para>
<para>
<command>&dhpackage;</command> automatically removes all files older than
21 days from
<filename>@LOCALSTATEDIR@/lib/ganeti/queue/archive</filename> and all
expired certificates and keys from
<filename>@LOCALSTATEDIR@/run/ganeti/crypto</filename>
</para>
</refsect1>
&footer;
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>June 08, 2010</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>8</manvolnum>">
<!ENTITY dhucpackage "<refentrytitle>ganeti-confd</refentrytitle>">
<!ENTITY dhpackage "ganeti-confd">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<!ENTITY footer SYSTEM "footer.sgml">
]>
<refentry>
<refentryinfo>
<copyright>
<year>2009</year>
<holder>Google Inc.</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
<refmiscinfo>Ganeti 2.2</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Ganeti conf daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage; </command>
<arg>-f</arg>
<arg>-d</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
<command>&dhpackage;</command> is a daemon used to answer queries related
to the configuration of a Ganeti cluster.
</para>
<para>
For testing purposes, you can give the <option>-f</option>
option and the program won't detach from the running terminal.
</para>
<para>
Debug-level message can be activated by giving the
<option>-d</option> option.
</para>
<refsect2>
<title>ROLE</title>
<para>
The role of the conf daemon is to make sure we have a highly available
and very fast way to query cluster configuration values. This daemon is
automatically active on all master candidates, and so has no single
point of failure. It communicates via UDP so each query can easily be
sent to multiple servers, and it answers queries from a cached copy of
the config it keeps in memory, so no disk access is required to get an
answer.
</para>
<para>
The config is reloaded from disk automatically when it changes, with a
rate limit of once per second.
</para>
<para>
If the conf daemon is stopped on all nodes, its clients won't be able
to get query answers.
</para>
</refsect2>
<refsect2>
<title>COMMUNICATION PROTOCOL</title>
<para>
The confd protocol is an HMAC authenticated json-encoded custom format,
over UDP. A client library is provided to make it easy to write
software to query confd. More information can be found in the Ganeti
2.1 design doc, and an example usage can be seen in the (external) NBMA
daemon for Ganeti.
</para>
</refsect2>
</refsect1>
&footer;
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>June 08, 2010</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>8</manvolnum>">
<!ENTITY dhucpackage "<refentrytitle>ganeti-masterd</refentrytitle>">
<!ENTITY dhpackage "ganeti-masterd">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<!ENTITY footer SYSTEM "footer.sgml">
]>
<refentry>
<refentryinfo>
<copyright>
<year>2008</year>
<year>2009</year>
<year>2010</year>
<holder>Google Inc.</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
<refmiscinfo>Ganeti 2.2</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Ganeti master daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage; </command>
<arg>-f</arg>
<arg>-d</arg>
<arg>--no-voting</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
The <command>&dhpackage;</command> is the daemon which is
responsible for the overall cluster coordination. Without it, no
change can be performed on the cluster.
</para>
<para>
For testing purposes, you can give the <option>-f</option>
option and the program won't detach from the running terminal.
</para>
<para>
Debug-level message can be activated by giving the
<option>-d</option> option.
</para>
<refsect2>
<title>ROLE</title>
<para>
The role of the master daemon is to coordinate all the actions
that change the state of the cluster. Things like accepting
new jobs, coordinating the changes on nodes (via RPC calls to
the respective node daemons), maintaining the configuration
and so on are done via this daemon.
</para>
<para>
The only action that can be done without the master daemon is
the failover of the master role to another node in the
cluster, via the <command>gnt-cluster
master-failover</command> command.
</para>
<para>
If the master daemon is stopped, the instances are not
affected, but they won't be restarted automatically in case of
failure.
</para>
</refsect2>
<refsect2>
<title>STARTUP</title>
<para>
At startup, the master daemon will confirm with the node
daemons that the node it is running is indeed the master node
of the cluster. It will abort if it doesn't get half plus one
positive answers (offline nodes are queried too, just in case
our configuration is stale).
</para>
<para>
For small clusters with a number of nodes down, and especially
for two-node clusters where the other has gone done, this
creates a problem. In this case the
<option>--no-voting</option> option can be used to skip this
process. The option requires interactive confirmation, as
having two masters on the same cluster is a very dangerous
situation and will most likely lead to data loss.
</para>
</refsect2>
<refsect2>
<title>JOB QUEUE</title>
<para>
The master daemon maintains a job queue (located under
<filename
class="directory">@LOCALSTATEDIR@/lib/ganeti/queue</filename>) in
which all current jobs are stored, one job per file serialized
in JSON format; in this directory a subdirectory called
<filename class="directory">archive</filename> holds archived
job files.
</para>
<para>
The moving of jobs from the current to the queue directory is
done via a request to the master; this can be accomplished
from the command line with the <command>gnt-job
archive</command> or <command>gnt-job autoarchive</command>
commands. In case of problems with the master, a job file can
simply be moved away or deleted (but this might leave the
cluster inconsistent).
</para>
</refsect2>
<refsect2>
<title>COMMUNICATION PROTOCOL</title>
<para>
The master accepts commands over a Unix socket, using JSON
serialized messages separated by a specific byte sequence. For
more details, see the design documentation supplied with
Ganeti.
</para>
</refsect2>
</refsect1>
&footer;
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>June 08, 2010</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>8</manvolnum>">
<!ENTITY dhucpackage "<refentrytitle>ganeti-noded</refentrytitle>">
<!ENTITY dhpackage "ganeti-noded">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<!ENTITY footer SYSTEM "footer.sgml">
]>
<refentry>
<refentryinfo>
<copyright>
<year>2006</year>
<year>2007</year>
<year>2008</year>
<year>2009</year>
<year>2010</year>
<holder>Google Inc.</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
<refmiscinfo>Ganeti 2.2</refmiscinfo>
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Ganeti node daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage; </command>
<arg>-f</arg>
<arg>-d</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
The <command>&dhpackage;</command> is the daemon which is
responsible for the node functions in the Ganeti system.
</para>
<para>
By default, in order to be able to support features such as node
powercycling even on systems with a very damaged root disk,
<command>ganeti-noded</command> locks itself in RAM using
<citerefentry>
<refentrytitle>mlockall</refentrytitle>
<manvolnum>2</manvolnum>
</citerefentry>. You can disable this feature by passing in the
<option>--no-mlock</option> to the daemon.
</para>
<para>
For testing purposes, you can give the <option>-f</option>
option and the program won't detach from the running terminal.
</para>
<para>
Debug-level message can be activated by giving the
<option>-d</option> option.
</para>
<para>
Logging to syslog, rather than its own log file, can be enabled by
passing in the <option>--syslog</option> option.
</para>
<para>
The <command>ganeti-noded</command> daemon listens to port 1811 TCP, on
all interfaces, by default. This can be overridden by an entry the
services database (<filename>/etc/services</filename>) or by passing the
<option>-p</option> option. The <option>-b</option> option can be used to
specify the address to bind to (defaults to 0.0.0.0).
</para>
<para>
Ganeti noded communication is protected via SSL, with a key generated at
cluster init time. This can be disabled with the
<option>--no-ssl</option> option, or a different SSL key and certificate
can be specified using the <option>-K</option> and <option>-C</option>
options.
</para>
<refsect2>
<title>ROLE</title>
<para>
The role of the node daemon is to do almost all the actions
that change the state of the node. Things like creating disks
for instances, activating disks, starting/stopping instance
and so on are done via the node daemon.
</para>
<para>
Also, in some cases the startup/shutdown of the master daemon
are done via the node daemon, and the cluster IP address is
also added/removed to the master node via it.
</para>
<para>
If the node daemon is stopped, the instances are not affected,
but the master won't be able to talk to that node.
</para>
</refsect2>
<refsect2>
<title>COMMUNICATION PROTOCOL</title>
<para>
Currently the master-node RPC is done using a simple RPC protocol built
using JSON over HTTP(S).
</para>
</refsect2>
</refsect1>
&footer;
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>June 08, 2010</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>7</manvolnum>">
<!ENTITY dhucpackage "<refentrytitle>ganeti-os-interface</refentrytitle>">
<!ENTITY dhpackage "ganeti">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
<!ENTITY footer SYSTEM "footer.sgml">
]>
<refentry>
<refentryinfo>
<copyright>
<year>2006</year>
<year>2007</year>
<year>2008</year>
<year>2009</year>
<year>2010</year>
<holder>Google Inc.</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
<refmiscinfo>Ganeti 2.2</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ganeti-os-interface</refname>
<refpurpose>Specifications for guest OS types</refpurpose>
</refnamediv>