ganeti-rapi(8)

📦
version 3.1.0~rc2 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute

✨ ganeti-rapi(8) — the remote API daemon, but make it fashion ✨

okay bestie, sit down, hydrate, and let me tell you about ganeti-rapi, the Ganeti remote API daemon 💅

💖 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] [--ssl-chain
SSL_CHAIN_FILE]

🌸 DESCRIPTION 🌸

ganeti-rapi is the daemon that serves up a remote API for Ganeti clusters. it's the little guy holding the door open for your HTTP requests, no cap 🚪✨

It gets started automatically on the master node, and by default it uses SSL encryption 🔐. Wanna turn that off? Pass --no-ssl. Or, if you'd rather swap the certs, change the certificate with -C and the key with -K. And if your certificate chain involves intermediate certificates that the server needs to present, that chain file can be provided with --ssl-chain. chain, but make it certified 💅

The daemon will listen on the ganeti-rapi TCP port, as listed in the system services database — or, if that's not defined, port 5080 by default. The port can be overridden with -p. The -b option lets you specify the address to bind to (defaults to 0.0.0.0). Careful though, bestie: 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 😭 (like a clingy ex, fr fr). Alternatively to setting the IP with --b, the -i option can be used to specify the interface to bind to.

The max number of simultaneous client connections can be configured with --max-clients, which defaults to 20. Connections above this count are still accepted, but no responses are sent until enough connections are closed. it's giving "we'll get to you when we get to you" energy 🙈

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. everything goes in the group chat, iykyk 📝

👑 ACCESS CONTROLS 👑

Most query operations are allowed without authentication. Only the modification operations require authentication, in the form of basic authentication. If you want everything locked down, specify the --require-authentication command line flag to always require authentication. main character security only 🔥

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). go read it, it's iconic 📖

😭 REPORTING BUGS 😭

Report bugs to the project's issue tracker or contact the developers using the Ganeti mailing list. we don't bite, we just debug 🦋

🌈 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 (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.

and that's the whole page, bestie 🎀 this one's from Ganeti, sitting at version 3.1.0~rc2 — go forth and expose your API responsibly, you absolute icon 👑✨

📦 where this page comes from