ganeti-rapi(8) Ganeti | Version 3.0.0

Name

ganeti-rapi - Ganeti remote API daemon

Synopsis

ganeti-rapi [-d] [-f] [-p PORT] [-b ADDRESS] [-i INTERFACE]
[--max-clients CLIENTS] [--no-ssl] [-K SSL_KEY_FILE]
[-C SSL_CERT_FILE] | [--require-authentication]

DESCRIPTION

ganeti-rapi is the daemon providing a remote API for Ganeti clusters.

It is automatically started on the master node, and by default it uses SSL encryption. This can be disabled by passing the --no-ssl option, or alternatively the certificate used can be changed via the -C option and the key via the -K option.

The daemon will listen to the "ganeti-rapi" TCP port, as listed in the system services database, or if not defined, to port 5080 by default. The port can be overridden by passing the -p option. The -b option can be used to specify the address to bind to (defaults to 0.0.0.0). Note that if you specify the address, the watcher needs to be informed about it using its option --rapi-ip, otherwise it will not be able to reach the RAPI interface and will attempt to restart it all the time. Alternatively to setting the IP with --b, the -i option can be used to specify the interface to bind do.

The maximum number of simultaneous client connections may be configured with the --max-clients option. This defaults to 20. Connections above this count are accepted, but no responses are sent until enough connections are closed.

See the Ganeti remote API documentation for further information.

Requests are logged to /var/log/ganeti/rapi-daemon.log, in the same format as for the node and master daemon.

ACCESS CONTROLS

Most query operations are allowed without authentication. Only the modification operations require authentication, in the form of basic authentication. Specify the --require-authentication command line flag to always require authentication.

The users and their rights are defined in the /var/lib/ganeti/rapi/users file. The format of this file is described in the Ganeti documentation (rapi.html).

REPORTING BUGS

Report bugs to the project's issue tracker or contact the developers using the Ganeti mailing list.

SEE ALSO

Ganeti overview and specifications: ganeti(7) (general overview), ganeti-os-interface(7) (guest OS definitions), ganeti-extstorage-interface(7) (external storage providers).

Ganeti commands: gnt-cluster(8) (cluster-wide commands), gnt-job(8) (job-related commands), gnt-node(8) (node-related commands), gnt-instance(8) (instance commands), gnt-os(8) (guest OS commands), gnt-storage(8) (storage commands), gnt-group(8) (node group commands), gnt-backup(8) (instance import/export commands), gnt-debug(8) (debug commands).

Ganeti daemons: ganeti-watcher(8) (automatic instance restarter), ganeti-cleaner(8) (job queue cleaner), ganeti-noded(8) (node daemon), ganeti-rapi(8) (remote API daemon).

Ganeti htools: htools(1) (generic binary), hbal(1) (cluster balancer), hspace(1) (capacity calculation), hail(1) (IAllocator plugin), hscan(1) (data gatherer from remote clusters), hinfo(1) (cluster information printer), mon-collector(7) (data collectors interface).

COPYRIGHT

Copyright (C) 2006-2015 Google Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.