root / man / ganeti-rapi.sgml @ 36e23a40
History | View | Annotate | Download (3.8 kB)
1 | 320d986d | Iustin Pop | <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ |
---|---|---|---|
2 | 320d986d | Iustin Pop | |
3 | 320d986d | Iustin Pop | <!-- Fill in your name for FIRSTNAME and SURNAME. --> |
4 | 320d986d | Iustin Pop | <!-- Please adjust the date whenever revising the manpage. --> |
5 | 320d986d | Iustin Pop | <!ENTITY dhdate "<date>February 11, 2009</date>"> |
6 | 320d986d | Iustin Pop | <!-- SECTION should be 1-8, maybe w/ subsection other parameters are |
7 | 320d986d | Iustin Pop | allowed: see man(7), man(1). --> |
8 | 320d986d | Iustin Pop | <!ENTITY dhsection "<manvolnum>8</manvolnum>"> |
9 | 320d986d | Iustin Pop | <!ENTITY dhucpackage "<refentrytitle>ganeti-rapi</refentrytitle>"> |
10 | 320d986d | Iustin Pop | <!ENTITY dhpackage "ganeti-rapi"> |
11 | 320d986d | Iustin Pop | |
12 | 320d986d | Iustin Pop | <!ENTITY debian "<productname>Debian</productname>"> |
13 | 320d986d | Iustin Pop | <!ENTITY gnu "<acronym>GNU</acronym>"> |
14 | 320d986d | Iustin Pop | <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> |
15 | 320d986d | Iustin Pop | <!ENTITY footer SYSTEM "footer.sgml"> |
16 | 320d986d | Iustin Pop | ]> |
17 | 320d986d | Iustin Pop | |
18 | 320d986d | Iustin Pop | <refentry> |
19 | 320d986d | Iustin Pop | <refentryinfo> |
20 | 320d986d | Iustin Pop | <copyright> |
21 | 320d986d | Iustin Pop | <year>2008</year> |
22 | 320d986d | Iustin Pop | <year>2009</year> |
23 | 320d986d | Iustin Pop | <holder>Google Inc.</holder> |
24 | 320d986d | Iustin Pop | </copyright> |
25 | 320d986d | Iustin Pop | &dhdate; |
26 | 320d986d | Iustin Pop | </refentryinfo> |
27 | 320d986d | Iustin Pop | <refmeta> |
28 | 320d986d | Iustin Pop | &dhucpackage; |
29 | 320d986d | Iustin Pop | |
30 | 320d986d | Iustin Pop | &dhsection; |
31 | 320d986d | Iustin Pop | <refmiscinfo>ganeti 2.0</refmiscinfo> |
32 | 320d986d | Iustin Pop | </refmeta> |
33 | 320d986d | Iustin Pop | <refnamediv> |
34 | 320d986d | Iustin Pop | <refname>&dhpackage;</refname> |
35 | 320d986d | Iustin Pop | |
36 | 320d986d | Iustin Pop | <refpurpose>ganeti remote API daemon</refpurpose> |
37 | 320d986d | Iustin Pop | </refnamediv> |
38 | 320d986d | Iustin Pop | <refsynopsisdiv> |
39 | 320d986d | Iustin Pop | <cmdsynopsis> |
40 | 320d986d | Iustin Pop | <command>&dhpackage; </command> |
41 | 320d986d | Iustin Pop | <arg>-d</arg> |
42 | 320d986d | Iustin Pop | <arg>-f</arg> |
43 | 320d986d | Iustin Pop | <arg>-p <replaceable>PORT</replaceable></arg> |
44 | 320d986d | Iustin Pop | <arg>--no-ssl</arg> |
45 | 320d986d | Iustin Pop | <arg>-K <replaceable>SSL_KEY_FILE</replaceable></arg> |
46 | 320d986d | Iustin Pop | <arg>-C <replaceable>SSL_CERT_FILE</replaceable></arg> |
47 | 320d986d | Iustin Pop | |
48 | 320d986d | Iustin Pop | </cmdsynopsis> |
49 | 320d986d | Iustin Pop | </refsynopsisdiv> |
50 | 6e99c5a0 | Iustin Pop | |
51 | 320d986d | Iustin Pop | <refsect1> |
52 | 320d986d | Iustin Pop | <title>DESCRIPTION</title> |
53 | 320d986d | Iustin Pop | |
54 | 320d986d | Iustin Pop | <para> |
55 | 320d986d | Iustin Pop | <command>&dhpackage;</command> is the daemon providing a remote |
56 | 320d986d | Iustin Pop | API for Ganeti clusters. |
57 | 320d986d | Iustin Pop | </para> |
58 | 320d986d | Iustin Pop | |
59 | 320d986d | Iustin Pop | <para> |
60 | 320d986d | Iustin Pop | It is automatically started on the master node, and by default |
61 | 320d986d | Iustin Pop | it uses SSL encryption. This can be disabled by passing the |
62 | 320d986d | Iustin Pop | <option>--no-ssl</option> option, or alternatively the |
63 | 320d986d | Iustin Pop | certificate used can be changed via the <option>-C</option> |
64 | 320d986d | Iustin Pop | option and the key via the <option>-K</option> option. |
65 | 320d986d | Iustin Pop | </para> |
66 | 320d986d | Iustin Pop | |
67 | 320d986d | Iustin Pop | <para> |
68 | 320d986d | Iustin Pop | The daemon will listen by default on the port 5080, but this can |
69 | 320d986d | Iustin Pop | be changed via the <option>-p</option> option. |
70 | 320d986d | Iustin Pop | </para> |
71 | 320d986d | Iustin Pop | |
72 | 320d986d | Iustin Pop | <para> |
73 | 320d986d | Iustin Pop | See the <emphasis>Ganeti remote API</emphasis> documentation for |
74 | 320d986d | Iustin Pop | further information. |
75 | 320d986d | Iustin Pop | </para> |
76 | 320d986d | Iustin Pop | |
77 | 320d986d | Iustin Pop | <para> |
78 | 320d986d | Iustin Pop | Requests are logged to |
79 | 320d986d | Iustin Pop | <filename>@LOCALSTATEDIR@/log/ganeti/rapi-daemon.log</filename>, |
80 | 320d986d | Iustin Pop | in the same format as for the node and master daemon. |
81 | 320d986d | Iustin Pop | </para> |
82 | 320d986d | Iustin Pop | |
83 | 320d986d | Iustin Pop | </refsect1> |
84 | 320d986d | Iustin Pop | |
85 | 6e99c5a0 | Iustin Pop | <refsect1> |
86 | 6e99c5a0 | Iustin Pop | <title>ACCESS CONTROLS</title> |
87 | 6e99c5a0 | Iustin Pop | |
88 | 6e99c5a0 | Iustin Pop | <para> |
89 | 6e99c5a0 | Iustin Pop | All query operations are allowed without authentication. Only |
90 | 6e99c5a0 | Iustin Pop | the modification operations require authentication, in the form |
91 | 6e99c5a0 | Iustin Pop | of basic authentication. |
92 | 6e99c5a0 | Iustin Pop | </para> |
93 | 6e99c5a0 | Iustin Pop | |
94 | 6e99c5a0 | Iustin Pop | <para> |
95 | 6e99c5a0 | Iustin Pop | The users and their rights are defined in a file named |
96 | 6e99c5a0 | Iustin Pop | <filename>rapi_users</filename>, located in the <filename |
97 | 6e99c5a0 | Iustin Pop | class="directory">@LOCALSTATEDIR@/ganeti</filename> |
98 | 6e99c5a0 | Iustin Pop | directory. The users should be listed one per line, in the |
99 | 6e99c5a0 | Iustin Pop | following format: |
100 | 6e99c5a0 | Iustin Pop | </para> |
101 | 6e99c5a0 | Iustin Pop | |
102 | 6e99c5a0 | Iustin Pop | <screen>username password options</screen> |
103 | 6e99c5a0 | Iustin Pop | |
104 | 6e99c5a0 | Iustin Pop | <para> |
105 | 6e99c5a0 | Iustin Pop | Currently the <replaceable>options</replaceable> field should |
106 | 6e99c5a0 | Iustin Pop | equal the string <emphasis>write</emphasis> in order to actually |
107 | 6e99c5a0 | Iustin Pop | give write permission for the given users. Example: |
108 | 6e99c5a0 | Iustin Pop | </para> |
109 | 6e99c5a0 | Iustin Pop | <screen>rclient secret write |
110 | 6e99c5a0 | Iustin Pop | guest tespw |
111 | 6e99c5a0 | Iustin Pop | </screen> |
112 | 6e99c5a0 | Iustin Pop | <para>The first user (<userinput>rclient</userinput>) will have |
113 | 6e99c5a0 | Iustin Pop | read-write rights, whereas the second user does only have read |
114 | 6e99c5a0 | Iustin Pop | (query) rights, and as such is no different than not using |
115 | 6e99c5a0 | Iustin Pop | authentication at all.</para> |
116 | 6e99c5a0 | Iustin Pop | </refsect1> |
117 | 320d986d | Iustin Pop | &footer; |
118 | 320d986d | Iustin Pop | |
119 | 320d986d | Iustin Pop | </refentry> |
120 | 320d986d | Iustin Pop | |
121 | 320d986d | Iustin Pop | <!-- Keep this comment at the end of the file |
122 | 320d986d | Iustin Pop | Local variables: |
123 | 320d986d | Iustin Pop | mode: sgml |
124 | 320d986d | Iustin Pop | sgml-omittag:t |
125 | 320d986d | Iustin Pop | sgml-shorttag:t |
126 | 320d986d | Iustin Pop | sgml-minimize-attributes:nil |
127 | 320d986d | Iustin Pop | sgml-always-quote-attributes:t |
128 | 320d986d | Iustin Pop | sgml-indent-step:2 |
129 | 320d986d | Iustin Pop | sgml-indent-data:t |
130 | 320d986d | Iustin Pop | sgml-parent-document:nil |
131 | 320d986d | Iustin Pop | sgml-default-dtd-file:nil |
132 | 320d986d | Iustin Pop | sgml-exposed-tags:nil |
133 | 320d986d | Iustin Pop | sgml-local-catalogs:nil |
134 | 320d986d | Iustin Pop | sgml-local-ecat-files:nil |
135 | 320d986d | Iustin Pop | End: |
136 | 320d986d | Iustin Pop | --> |