root / man / ganeti-rapi.rst @ 27a8a190
History | View | Annotate | Download (1.5 kB)
1 | f52cb680 | Iustin Pop | ganeti-rapi(8) Ganeti | Version @GANETI_VERSION@ |
---|---|---|---|
2 | f52cb680 | Iustin Pop | ================================================ |
3 | f52cb680 | Iustin Pop | |
4 | f52cb680 | Iustin Pop | Name |
5 | f52cb680 | Iustin Pop | ---- |
6 | f52cb680 | Iustin Pop | |
7 | f52cb680 | Iustin Pop | ganeti-rapi - Ganeti remote API daemon |
8 | f52cb680 | Iustin Pop | |
9 | f52cb680 | Iustin Pop | Synopsis |
10 | f52cb680 | Iustin Pop | -------- |
11 | f52cb680 | Iustin Pop | |
12 | 27a8a190 | Michael Hanselmann | | **ganeti-rapi** [-d] [-f] [\--no-ssl] [-K *SSL_KEY_FILE*] |
13 | 27a8a190 | Michael Hanselmann | | [-C *SSL_CERT_FILE*] [\--require-authentication] |
14 | f52cb680 | Iustin Pop | |
15 | f52cb680 | Iustin Pop | DESCRIPTION |
16 | f52cb680 | Iustin Pop | ----------- |
17 | f52cb680 | Iustin Pop | |
18 | f52cb680 | Iustin Pop | **ganeti-rapi** is the daemon providing a remote API for Ganeti |
19 | f52cb680 | Iustin Pop | clusters. |
20 | f52cb680 | Iustin Pop | |
21 | f52cb680 | Iustin Pop | It is automatically started on the master node, and by default it |
22 | f52cb680 | Iustin Pop | uses SSL encryption. This can be disabled by passing the |
23 | f52cb680 | Iustin Pop | ``--no-ssl`` option, or alternatively the certificate used can be |
24 | f52cb680 | Iustin Pop | changed via the ``-C`` option and the key via the ``-K`` option. |
25 | f52cb680 | Iustin Pop | |
26 | 27a8a190 | Michael Hanselmann | The daemon will listen to the "ganeti-rapi" TCP port, as listed in the |
27 | f52cb680 | Iustin Pop | system services database, or if not defined, to port 5080 by default. |
28 | f52cb680 | Iustin Pop | |
29 | f52cb680 | Iustin Pop | See the *Ganeti remote API* documentation for further information. |
30 | f52cb680 | Iustin Pop | |
31 | f52cb680 | Iustin Pop | Requests are logged to ``@LOCALSTATEDIR@/log/ganeti/rapi-daemon.log``, |
32 | f52cb680 | Iustin Pop | in the same format as for the node and master daemon. |
33 | f52cb680 | Iustin Pop | |
34 | f52cb680 | Iustin Pop | ACCESS CONTROLS |
35 | f52cb680 | Iustin Pop | --------------- |
36 | f52cb680 | Iustin Pop | |
37 | 41f3d54d | Michael Hanselmann | Most query operations are allowed without authentication. Only the |
38 | f52cb680 | Iustin Pop | modification operations require authentication, in the form of basic |
39 | 27a8a190 | Michael Hanselmann | authentication. Specify the ``--require-authentication`` command line |
40 | 27a8a190 | Michael Hanselmann | flag to always require authentication. |
41 | f52cb680 | Iustin Pop | |
42 | fdd9ac5b | Michael Hanselmann | The users and their rights are defined in the |
43 | 27a8a190 | Michael Hanselmann | ``@LOCALSTATEDIR@/lib/ganeti/rapi/users`` file. The format of this file |
44 | 27a8a190 | Michael Hanselmann | is described in the Ganeti documentation (``rapi.html``). |
45 | 9ff4f2c0 | Michael Hanselmann | |
46 | 9ff4f2c0 | Michael Hanselmann | .. vim: set textwidth=72 : |
47 | 9ff4f2c0 | Michael Hanselmann | .. Local Variables: |
48 | 9ff4f2c0 | Michael Hanselmann | .. mode: rst |
49 | 9ff4f2c0 | Michael Hanselmann | .. fill-column: 72 |
50 | 9ff4f2c0 | Michael Hanselmann | .. End: |