NOVA-API(1)

✨ NOVA-API(1) ✨

okay bestie, welcome to the nova manual, page one, section one, and it's literally the nova-api glow-up πŸ’…


🌸 NAME 🌸

nova-api β€” the server for the OpenStack Compute API service. she's the main character, no cap πŸ‘‘


πŸ¦‹ SYNOPSIS πŸ¦‹

nova-api [<options>...]

πŸ’– DESCRIPTION πŸ’–

so nova-api is a server daemon, right? and she serves the metadata and compute APIs in separate greenthreads. two jobs, one icon, multitasking queen 🧚✨


πŸŽ€ OPTIONS πŸŽ€

πŸ’œ General options

  • --config-dir DIR β€” the path to a config directory to pull *.conf files from. this file set is sorted, so you get a predictable parse order if individual options get over-ridden. the set is parsed after the file(s) you specified with previous --config-file arguments, so over-ridden options in the directory take precedence. heads up: this option must be set from the command-line.
  • --config-file PATH β€” the path to a config file to use. you can specify multiple config files, and values in later files take precedence. defaults to None. also, this one must be set from the command-line.
  • --debug, -d β€” sets the logging level to DEBUG instead of the default INFO level. she's telling you everything πŸ—£οΈ
  • --log-config-append PATH, --log-config PATH, --log_config PATH β€” the name of a logging configuration file. this file is appended to any existing logging configuration files. for deets about logging configuration files, go read the Python logging module documentation. lowkey important note: when logging configuration files are used, all logging configuration is set in the configuration file and the other logging configuration options get ignored (like, log-date-format, for example). sorry bestie πŸ™ˆ
  • --log-date-format DATE_FORMAT β€” defines the format string for %(asctime)s in log records. default: None. this option is ignored if log_config_append is set.
  • --log-dir LOG_DIR, --logdir LOG_DIR β€” (optional) the base directory used for relative log_file paths. also ignored if log_config_append is set.
  • --log-file PATH, --logfile PATH β€” (optional) name of the log file to send logging output to. if no default is set, logging goes to stderr as defined by use_stderr. and yep β€” ignored if log_config_append is set.
  • --nodebug β€” the inverse of --debug.
  • --nouse-journal β€” the inverse of --use-journal.
  • --nouse-json β€” the inverse of --use-json.
  • --nouse-syslog β€” the inverse of --use-syslog.
  • --nowatch-log-file β€” the inverse of --watch-log-file.
  • --syslog-log-facility SYSLOG_LOG_FACILITY β€” the syslog facility to receive log lines. ignored if log_config_append is set.
  • --use-journal β€” enables journald for logging. if you're running in a systemd environment you might wanna turn on journal support 🫢 doing so uses the journal native protocol, which includes structured metadata in addition to log messages. this option is ignored if log_config_append is set.
  • --use-json β€” use JSON formatting for logging. ignored if log_config_append is set.
  • --use-syslog β€” use syslog for logging. > the existing syslog format is DEPRECATED and will be changed later to honor RFC5424. this option is ignored if log_config_append is set.
  • --version β€” show the program's version number and exit. bye ✌️
  • --watch-log-file β€” uses a logging handler designed to watch the file system πŸ‘€ when the log file is moved or removed, this handler opens a new log file with the specified path instantaneously. it only makes sense if the log_file option is specified and you're on a Linux platform. ignored if log_config_append is set.

🌈 Debugger options

  • --remote_debug-host REMOTE_DEBUG_HOST β€” the debug host (IP or name) to connect to. you use this command line parameter when you want to connect to a nova service via a debugger running on a different host. > ngl bestie, using the remote debug option changes how Nova uses the eventlet library to support async IO. that could result in failures that do not occur under normal operation. use at your own risk. πŸ’€
  • --remote_debug-port REMOTE_DEBUG_PORT β€” the debug port to connect to. this command line parameter lets you specify the port you want to use to connect to a nova service via a debugger running on a different host. > same warning, same energy: the remote debug option changes how Nova uses the eventlet library to support async IO, which could cause failures that don't happen in normal operation. use at your own risk. πŸ’€

πŸ“ FILES πŸ“

  • /etc/nova/nova.conf
  • /etc/nova/api-paste.ini
  • /etc/nova/policy.yaml
  • /etc/nova/policy.d/
  • /etc/nova/rootwrap.conf
  • /etc/nova/rootwrap.d/

⭐ SEE ALSO ⭐

nova-api-metadata(1), nova-api-os-compute(1) β€” go read your sisters, they're iconic too πŸ‘‘


πŸ’€ BUGS πŸ’€

  • Nova bugs are managed at Launchpad.

πŸ’Œ AUTHOR πŸ’Œ

openstack@lists.openstack.org


2010-present, OpenStack Foundation


and that's the whole page, bestie!! this was nova version 31.0.0, dated Feb 06, 2026, and honestly she ate. periodt. πŸ’…βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ«Ά

πŸ“¦ where this page comes from