code.grnet.gr Git - ganeti-local/blob - man/ganeti-rapi.sgml

   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>February 11, 2009</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>ganeti-rapi</refentrytitle>">
  10   <!ENTITY dhpackage   "ganeti-rapi">
  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>2008</year>
  22       <year>2009</year>
  23       <holder>Google Inc.</holder>
  24     </copyright>
  25     &dhdate;
  26   </refentryinfo>
  27   <refmeta>
  28     &dhucpackage;
  29
  30     &dhsection;
  31     <refmiscinfo>ganeti 2.0</refmiscinfo>
  32   </refmeta>
  33   <refnamediv>
  34     <refname>&dhpackage;</refname>
  35
  36     <refpurpose>ganeti remote API daemon</refpurpose>
  37   </refnamediv>
  38   <refsynopsisdiv>
  39     <cmdsynopsis>
  40       <command>&dhpackage; </command>
  41       <arg>-d</arg>
  42       <arg>-f</arg>
  43       <arg>-p <replaceable>PORT</replaceable></arg>
  44       <arg>--no-ssl</arg>
  45       <arg>-K <replaceable>SSL_KEY_FILE</replaceable></arg>
  46       <arg>-C <replaceable>SSL_CERT_FILE</replaceable></arg>
  47
  48     </cmdsynopsis>
  49   </refsynopsisdiv>
  50   <refsect1>
  51     <title>DESCRIPTION</title>
  52
  53     <para>
  54       <command>&dhpackage;</command> is the daemon providing a remote
  55       API for Ganeti clusters.
  56     </para>
  57
  58     <para>
  59       It is automatically started on the master node, and by default
  60       it uses SSL encryption. This can be disabled by passing the
  61       <option>--no-ssl</option> option, or alternatively the
  62       certificate used can be changed via the <option>-C</option>
  63       option and the key via the <option>-K</option> option.
  64     </para>
  65
  66     <para>
  67       The daemon will listen by default on the port 5080, but this can
  68       be changed via the <option>-p</option> option.
  69     </para>
  70
  71     <para>
  72       See the <emphasis>Ganeti remote API</emphasis> documentation for
  73       further information.
  74     </para>
  75
  76     <para>
  77       Requests are logged to
  78       <filename>@LOCALSTATEDIR@/log/ganeti/rapi-daemon.log</filename>,
  79       in the same format as for the node and master daemon.
  80     </para>
  81
  82   </refsect1>
  83
  84   &footer;
  85
  86 </refentry>
  87
  88 <!-- Keep this comment at the end of the file
  89 Local variables:
  90 mode: sgml
  91 sgml-omittag:t
  92 sgml-shorttag:t
  93 sgml-minimize-attributes:nil
  94 sgml-always-quote-attributes:t
  95 sgml-indent-step:2
  96 sgml-indent-data:t
  97 sgml-parent-document:nil
  98 sgml-default-dtd-file:nil
  99 sgml-exposed-tags:nil
 100 sgml-local-catalogs:nil
 101 sgml-local-ecat-files:nil
 102 End:
 103 -->