openstack/nova
Code Issues Proposed changes

Help text for the mks options

Browse Source 
The previous commit moved mks options to a central location.
This commit adds additional help text to those options.

Blueprint centralize-config-options-newton

Change-Id: I278375706c81ae61290ea7120960303f8354dc00
This commit is contained in:
Sivasathurappan Radhakrishnan 2016-05-31 22:16:52 +00:00
parent 9d04ed7a83
commit 2f374ff1b3
1 changed files with 29 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
nova/conf/mks.py
View File

@ -1,10 +1,3 @@
# needs:fix_opt_description
# needs:check_deprecation_status
# needs:check_opt_group_and_type
# needs:fix_opt_description_indentation
# needs:fix_opt_registration_consistency
# Copyright 2016 OpenStack Foundation
# All Rights Reserved.
#
@ -23,25 +16,45 @@
from oslo_config import cfg
mks_group = cfg.OptGroup('mks', title='MKS Options')
mks_group = cfg.OptGroup('mks',
title='MKS Options',
help="""
Nova compute node uses WebMKS, a desktop sharing protocol to provide
instance console access to VM's created by VMware hypervisors.
Related options:
Following options must be set to provide console access.
* mksproxy_base_url
* enabled
""")
mks_opts = [
cfg.StrOpt('mksproxy_base_url',
default='http://127.0.0.1:6090/',
help='Location of MKS web console proxy, in the form '
'"http://127.0.0.1:6090/"'),
help="""
Location of MKS web console proxy
The URL in the response points to a WebMKS proxy which
starts proxying between client and corresponding vCenter
server where instance runs. In order to use the web based
console access, WebMKS proxy should be installed and configured
Possible values:
* Must be a valid URL of the form:``http://host:port/``
"""),
cfg.BoolOpt('enabled',
default=False,
help='Enable MKS related features'),
]
ALL_MKS_OPTS = mks_opts
help="""
Enables graphical console access for virtual machines.
"""),
]
def register_opts(conf):
conf.register_group(mks_group)
conf.register_opts(ALL_MKS_OPTS, group=mks_group)
conf.register_opts(mks_opts, group=mks_group)
def list_opts():
return {mks_group: ALL_MKS_OPTS}
return {mks_group: mks_opts}