novncproxy missed the vnc section in cli options

[Allen Gao]

$ nova-novncproxy --help
usage: nova-novncproxy [-h] [--cert CERT] [--config-dir DIR]
                       [--config-file PATH] [--daemon] [--debug] [--key KEY]
                       [--log-config-append PATH]
                       [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
                       [--log-file PATH] [--nodaemon] [--nodebug] [--norecord]
                       [--nosource_is_ipv6] [--nossl_only] [--nouse-syslog]
                       [--noverbose] [--nowatch-log-file] [--record]
                       [--source_is_ipv6] [--ssl_only]
                       [--syslog-log-facility SYSLOG_LOG_FACILITY]
                       [--use-syslog] [--verbose] [--version]
                       [--watch-log-file] [--web WEB]
                       [--remote_debug-host REMOTE_DEBUG_HOST]
                       [--remote_debug-port REMOTE_DEBUG_PORT]

optional arguments:
  -h, --help show this help message and exit
  --cert CERT SSL certificate file
  --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.
  --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.
  --daemon Become a daemon (background process)
  --debug, -d If set to true, the logging level will be set to DEBUG
                        instead of the default INFO level.
  --key KEY SSL key file (if separate from cert)
  --log-config-append 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, logging_context_format_string).
  --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. This option is ignored if
                        log_config_append is set.
  --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.
  --nodaemon The inverse of --daemon
  --nodebug The inverse of --debug
  --norecord The inverse of --record
  --nosource_is_ipv6 The inverse of --source_is_ipv6
  --nossl_only The inverse of --ssl_only
  --nouse-syslog The inverse of --use-syslog
  --noverbose The inverse of --verbose
  --nowatch-log-file The inverse of --watch-log-file
  --record Record sessions to FILE.[session_number]
  --source_is_ipv6 Source is ipv6
  --ssl_only Disallow non-encrypted connections
  --syslog-log-facility SYSLOG_LOG_FACILITY
                        Syslog facility to receive log lines. This option is
                        ignored if log_config_append is set.
  --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.
  --verbose, -v If set to false, the logging level will be set to
                        WARNING instead of the default INFO level.
  --version show program's version number and exit
  --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.
  --web WEB Run webserver on same port. Serve files from DIR.

remote_debug options:
  --remote_debug-host REMOTE_DEBUG_HOST
                        Debug host (IP or name) to connect. 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.
  --remote_debug-port REMOTE_DEBUG_PORT
                        Debug port to connect. 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.

The right options with vnc section should be like following:
$ nova-novncproxy --help
Option "novncproxy_host" from group "DEFAULT" is deprecated. Use option "novncproxy_host" from group "vnc".
usage: nova-novncproxy [-h] [--remote_debug-host REMOTE_DEBUG_HOST]
                       [--remote_debug-port REMOTE_DEBUG_PORT] [--cert CERT]
                       [--config-dir DIR] [--config-file PATH] [--daemon]
                       [--debug] [--key KEY] [--log-config-append PATH]
                       [--log-date-format DATE_FORMAT] [--log-dir LOG_DIR]
                       [--log-file PATH] [--nodaemon] [--nodebug]
                       [--nosource_is_ipv6] [--nossl_only] [--nouse-syslog]
                       [--noverbose] [--nowatch-log-file] [--record RECORD]
                       [--source_is_ipv6] [--ssl_only]
                       [--syslog-log-facility SYSLOG_LOG_FACILITY]
                       [--use-syslog] [--verbose] [--version]
                       [--watch-log-file] [--web WEB]
                       [--vnc-novncproxy_host VNC_NOVNCPROXY_HOST]
                       [--vnc-novncproxy_port VNC_NOVNCPROXY_PORT]

optional arguments:
  -h, --help show this help message and exit
  --cert CERT SSL certificate file
  --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.
  --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.
  --daemon Become a daemon (background process)
  --debug, -d If set to true, the logging level will be set to DEBUG
                        instead of the default INFO level.
  --key KEY SSL key file (if separate from cert)
  --log-config-append 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, logging_context_format_string).
  --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. This option is ignored if
                        log_config_append is set.
  --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.
  --nodaemon The inverse of --daemon
  --nodebug The inverse of --debug
  --nosource_is_ipv6 The inverse of --source_is_ipv6
  --nossl_only The inverse of --ssl_only
  --nouse-syslog The inverse of --use-syslog
  --noverbose The inverse of --verbose
  --nowatch-log-file The inverse of --watch-log-file
  --record RECORD This is the 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 (default), no recording will be done.
  --source_is_ipv6 Source is ipv6
  --ssl_only Disallow non-encrypted connections
  --syslog-log-facility SYSLOG_LOG_FACILITY
                        Syslog facility to receive log lines. This option is
                        ignored if log_config_append is set.
  --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.
  --verbose, -v If set to false, the logging level will be set to
                        WARNING instead of the default INFO level.
  --version show program's version number and exit
  --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.
  --web WEB Run webserver on same port. Serve files from DIR.

VNC options:
  Virtual Network Computer (VNC) can be used to provide remote desktop
  console access to instances for tenants and/or administrators.

  --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. Possible values: * An IP
                        address Services which consume this: * ``nova-
                        compute`` Related options: * novncproxy_port *
                        novncproxy_base_url
  --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. Possible values: * A port number
                        Services which consume this: * ``nova-compute``
                        Related options: * novncproxy_host *
                        novncproxy_base_url

debugger options:
  --remote_debug-host REMOTE_DEBUG_HOST
                        Debug host (IP or name) to connect. 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.
  --remote_debug-port REMOTE_DEBUG_PORT
                        Debug port to connect. 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.

[Markus Zoeller (markus_z) (mzoeller)]

@Allen: After the change [1] is merged, please backport it to stable/mitaka too. Thanks for spotting that issue!

References:
[1] https://review.openstack.org/#/c/300736/2

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/300736
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=2fe96e87fe857635c1007075e6c8b04b9514fe7e
Submitter: Jenkins
Branch: master

commit 2fe96e87fe857635c1007075e6c8b04b9514fe7e
Author: Allen Gao <email address hidden>
Date: Sat Apr 2 21:56:16 2016 +0800

    config options: fix the missed cli options of novncproxy

    Commit I5da0ad8cd42ef8b969ec05c07c497238e92f1f41 moved the
    'vnc' section to 'nova/conf/vnc.py', but forgot to register
    cli options of 'novncproxy'.

    Change-Id: I3732f237a110d33e51a0b7e31cd557ca45840af1
    Implements: blueprint centralize-config-options-newton
    Closes-Bug: #1565698

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/mitaka
Review: https://review.openstack.org/301349

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/301349
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=825d0f04dc5411049d1c5f08d6e8ae809567ef08
Submitter: Jenkins
Branch: stable/mitaka

commit 825d0f04dc5411049d1c5f08d6e8ae809567ef08
Author: Allen Gao <email address hidden>
Date: Sat Apr 2 21:56:16 2016 +0800

    config options: fix the missed cli options of novncproxy

    Commit I5da0ad8cd42ef8b969ec05c07c497238e92f1f41 moved the
    'vnc' section to 'nova/conf/vnc.py', but forgot to register
    cli options of 'novncproxy'.

    Change-Id: I3732f237a110d33e51a0b7e31cd557ca45840af1
    Closes-Bug: #1565698
    (cherry picked from commit 2fe96e87fe857635c1007075e6c8b04b9514fe7e)

[Davanum Srinivas (DIMS) (dims-v)]

This issue was fixed in the openstack/nova 14.0.0.0b1 development milestone.

[Doug Hellmann (doug-hellmann)]

This issue was fixed in the openstack/nova 13.1.0 release.