docs: Document options for remaining nova-* commands

Most of these share the same collection of oslo.config and oslo.log
options so it makes sense to group them together. The only exception is
nova-rootwrap, which is a wrapper around the 'oslo_rootwrap.cmd.main'
module, which curiously does not use argparse and doesn't have any
options.

Change-Id: I393ff162be58700956fbab29ff6b9ba3cf5860a6
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

doc/source/cli/nova-api-metadata.rst

@@ -22,7 +22,13 @@ so there are some considerations about using this in a
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/nova-api-os-compute.rst

@@ -20,7 +20,13 @@ OpenStack Compute API.
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/nova-api.rst

@@ -20,7 +20,13 @@ APIs in separate greenthreads.
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/nova-compute.rst

@@ -22,7 +22,13 @@ instance's state, attaching persistent storage, and terminating the instance.
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/nova-conductor.rst

@@ -20,7 +20,13 @@ service, which provides coordination and database query support for nova.
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/nova-novncproxy.rst

@@ -21,7 +21,60 @@ with OpenStack Nova noVNC consoles.
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Websockify options
+
+.. include:: opts/websockify.rst
+
+.. rubric:: VNC options
+
+.. option:: --vnc-auth_schemes VNC_AUTH_SCHEMES
+
+    The authentication schemes to use with the compute node. Control what RFB
+    authentication schemes are permitted for connections between the proxy and
+    the compute host. If multiple schemes are enabled, the first matching
+    scheme will be used, thus the strongest schemes should be listed first.
+
+.. option:: --vnc-novncproxy_host VNC_NOVNCPROXY_HOST
+
+    IP address that the noVNC console proxy should bind to. The VNC proxy is an
+    OpenStack component that enables compute service users to access their
+    instances through VNC clients. noVNC provides VNC support through a
+    websocket-based client. This option sets the private address to which the
+    noVNC console proxy service should bind to.
+
+.. option:: --vnc-novncproxy_port VNC_NOVNCPROXY_PORT
+
+    Port that the noVNC console proxy should bind to. The VNC proxy is an
+    OpenStack component that enables compute service users to access their
+    instances through VNC clients. noVNC provides VNC support through a
+    websocket-based client. This option sets the private port to which the
+    noVNC console proxy service should bind to.
+
+.. option:: --vnc-vencrypt_ca_certs VNC_VENCRYPT_CA_CERTS
+
+    The path to the CA certificate PEM file The fully qualified path to a PEM
+    file containing one or more x509 certificates for the certificate
+    authorities used by the compute node VNC server.
+
+.. option:: --vnc-vencrypt_client_cert VNC_VENCRYPT_CLIENT_CERT
+
+    The path to the client key file (for x509) The fully qualified path to a
+    PEM file containing the x509 certificate which the VNC proxy server
+    presents to the compute node during VNC authentication.
+
+.. option:: --vnc-vencrypt_client_key VNC_VENCRYPT_CLIENT_KEY
+
+    The path to the client certificate PEM file (for x509) The fully qualified
+    path to a PEM file containing the private key which the VNC proxy server
+    presents to the compute node during VNC authentication.
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/nova-rootwrap.rst

@@ -9,7 +9,7 @@ Synopsis
 
 ::
 
-  nova-rootwrap [<options>...]
+  nova-rootwrap CONFIG_FILE COMMMAND
 
 Description
 ===========
@@ -35,11 +35,6 @@ To make allowed commands node-specific, your packaging should only install
    :program:`nova-rootwrap` is being slowly deprecated and replaced by
    ``oslo.privsep``, and will eventually be removed.
 
-Options
-=======
-
-**General options**
-
 Files
 =====
 

doc/source/cli/nova-scheduler.rst

@@ -21,7 +21,13 @@ instance on.
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/nova-serialproxy.rst

@@ -21,7 +21,33 @@ with OpenStack Nova serial ports.
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Websockify options
+
+.. include:: opts/websockify.rst
+
+.. rubric:: Serial options
+
+.. option:: --serial_console-serialproxy_host SERIAL_CONSOLE_SERIALPROXY_HOST
+
+    The IP address which is used by the ``nova-serialproxy`` service to listen
+    for incoming requests.  The ``nova-serialproxy`` service listens on this IP
+    address for incoming connection requests to instances which expose serial
+    console.
+
+.. option:: --serial_console-serialproxy_port SERIAL_CONSOLE_SERIALPROXY_PORT
+
+    The port number which is used by the ``nova-serialproxy`` service to
+    listen for incoming requests. The ``nova-serialproxy`` service listens on
+    this port number for incoming connection requests to instances which expose
+    serial console.
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/nova-spicehtml5proxy.rst

@@ -21,7 +21,34 @@ compatible with OpenStack Nova SPICE HTML5 consoles.
 Options
 =======
 
-**General options**
+.. rubric:: General options
+
+.. include:: opts/common.rst
+
+.. rubric:: Websockify options
+
+.. include:: opts/websockify.rst
+
+.. rubric:: Spice options
+
+.. option:: --spice-html5proxy_host SPICE_HTML5PROXY_HOST
+
+    IP address or a hostname on which the ``nova-spicehtml5proxy`` service
+    listens for incoming requests. This option depends on the ``[spice]
+    html5proxy_base_url`` option in ``nova.conf``. The ``nova-spicehtml5proxy``
+    service must be listening on a host that is accessible from the HTML5
+    client.
+
+.. option:: --spice-html5proxy_port SPICE_HTML5PROXY_PORT
+
+    Port on which the ``nova-spicehtml5proxy`` service listens for incoming
+    requests. This option depends on the ``[spice] html5proxy_base_url`` option
+    in ``nova.conf``.  The ``nova-spicehtml5proxy`` service must be listening
+    on a port that is accessible from the HTML5 client.
+
+.. rubric:: Debugger options
+
+.. include:: opts/debugger.rst
 
 Files
 =====

doc/source/cli/opts/common.rst

@@ -0,0 +1,96 @@
+.. option:: --config-dir DIR
+
+    Path to a config directory to pull `*.conf` files from. This file set is
+    sorted, so as to provide a predictable parse order if individual options
+    are over-ridden. The set is parsed after the file(s) specified via previous
+    --config-file, arguments hence over-ridden options in the directory take
+    precedence.  This option must be set from the command-line.
+
+.. option:: --config-file PATH
+
+    Path to a config file to use. Multiple config files can be specified, with
+    values in later files taking precedence. Defaults to None. This option must
+    be set from the command-line.
+
+.. option:: --debug, -d
+
+    Set the logging level to DEBUG instead of the default INFO level.
+
+.. option:: --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 details about logging
+    configuration files, see the Python logging module documentation. Note that
+    when logging configuration files are used then all logging configuration is
+    set in the configuration file and other logging configuration options are
+    ignored (for example, log-date-format).
+
+.. option:: --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.
+
+.. option:: --log-dir LOG_DIR, --logdir LOG_DIR
+
+    (Optional) The base directory used for relative log_file paths. This option
+    is ignored if log_config_append is set.
+
+.. option:: --log-file PATH, --logfile PATH
+
+    (Optional) Name of log file to send logging output to.  If no default is
+    set, logging will go to stderr as defined by use_stderr. This option is
+    ignored if log_config_append is set.
+
+.. option:: --nodebug
+
+    The inverse of :option:`--debug`.
+
+.. option:: --nouse-journal
+
+    The inverse of :option:`--use-journal`.
+
+.. option:: --nouse-json
+
+    The inverse of :option:`--use-json`.
+
+.. option:: --nouse-syslog
+
+    The inverse of :option:`--use-syslog`.
+
+.. option:: --nowatch-log-file
+
+    The inverse of :option:`--watch-log-file`.
+
+.. option:: --syslog-log-facility SYSLOG_LOG_FACILITY
+
+    Syslog facility to receive log lines. This option is ignored if
+    log_config_append is set.
+
+.. option:: --use-journal
+
+    Enable journald for logging. If running in a systemd environment you may
+    wish to enable journal support.  Doing so will use the journal native
+    protocol which includes structured metadata in addition to log
+    messages.This option is ignored if log_config_append is set.
+
+.. option:: --use-json
+
+    Use JSON formatting for logging. This option is ignored if
+    log_config_append is set.
+
+.. option:: --use-syslog
+
+    Use syslog for logging. Existing syslog format is DEPRECATED and will be
+    changed later to honor RFC5424.  This option is ignored if
+    log_config_append is set.
+
+.. option:: --version
+
+    Show program's version number and exit
+
+.. option:: --watch-log-file
+
+    Uses logging handler designed to watch file system.  When log file is moved
+    or removed this handler will open a new log file with specified path
+    instantaneously. It makes sense only if log_file option is specified and
+    Linux platform is used. This option is ignored if log_config_append is set.

doc/source/cli/opts/debugger.rst

@@ -0,0 +1,15 @@
+.. option:: --remote_debug-host REMOTE_DEBUG_HOST
+
+    Debug host (IP or name) to connect to. This command line parameter is used
+    when you want to connect to a nova service via a debugger running on a
+    different host. Note that using the remote debug option changes how Nova
+    uses the eventlet library to support async IO. This could result in
+    failures that do not occur under normal operation. Use at your own risk.
+
+.. option:: --remote_debug-port REMOTE_DEBUG_PORT
+
+    Debug port to connect to. This command line parameter allows you to specify
+    the port you want to use to connect to a nova service via a debugger
+    running on different host. Note that using the remote debug option changes
+    how Nova uses the eventlet library to support async IO. This could result
+    in failures that do not occur under normal operation. Use at your own risk.

doc/source/cli/opts/websockify.rst

@@ -0,0 +1,41 @@
+.. option:: --cert CERT
+
+    Path to SSL certificate file.
+
+.. option:: --daemon
+
+    Run as a background process.
+
+.. option:: --key KEY
+
+    SSL key file (if separate from cert).
+
+.. option:: --nodaemon
+
+    The inverse of :option:`--daemon`.
+
+.. option:: --nosource_is_ipv6
+
+    The inverse of :option:`--source_is_ipv6`.
+
+.. option:: --nossl_only
+
+    The inverse of :option:`--ssl_only`.
+
+.. option:: --record RECORD
+
+    Filename that will be used for storing websocket frames received and sent
+    by a proxy service (like VNC, spice, serial) running on this host. If this
+    is not set, no recording will be done.
+
+.. option:: --source_is_ipv6
+
+    Set to True if source host is addressed with IPv6.
+
+.. option:: --ssl_only
+
+    Disallow non-encrypted connections.
+
+.. option:: --web WEB
+
+    Path to directory with content which will be served by a web server.