There is no "[vnc]" option group in nova.conf.sample
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack Compute (nova) |
Fix Released
|
Low
|
shunya kitada | ||
Liberty |
Fix Released
|
Undecided
|
Dirk Mueller |
Bug Description
I try to generate the sample nova.conf file, run the following.
$ tox -egenconfig
But, there is no "[vnc]" option group nova.conf.sample.
"[vnc]" option group is defined in "vnc/__init__.py",
but "nova.vnc" namespace is not defined in "etc/nova/
vnc/__init__.py
```
vnc_opts = [
cfg.
...
]
CONF = cfg.CONF
CONF.register_
```
I resolved this, following 3 steps.
Not sure if this is the correct fix or not.
1. Define "nova.vnc" namespace in "etc/nova/
```
[DEFAULT]
output_file = etc/nova/
...
namespace = nova.virt
> namespace = nova.vnc
namespace = nova.openstack.
...
```
2. Define "nova.vnc" entry_point in setup.cfg.
```
[entry_points]
oslo.config.opts =
nova = nova.opts:list_opts
nova.api = nova.api.
nova.cells = nova.cells.
nova.compute = nova.compute.
nova.network = nova.network.
nova.virt = nova.virt.
> nova.vnc = nova.vnc.
...
```
3. Create "nova/vnc/opts.py".
```
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy
# of the License at
#
# http://
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import nova.vnc
def list_opts():
return [
('vnc', nova.vnc.vnc_opts),
]
```
Changed in nova: | |
assignee: | nobody → shunya kitada (skitada) |
I think this got introduced with [1]+[2] in Liberty => CONFIRMED.
For this current release (Mitaka) it could be sufficient to move the "nova.vnc.vnc_opts" in "nova/nova/opts.py" away from the "default" group
to its own "vnc" group (like "rdp" and "spice")[3].
The "nova.conf.sample" in looks like this:
[DEFAULT]
[...]
# Enable VNC related features (boolean value) /vnc_enabled
# Deprecated group/name - [DEFAULT]
#enabled = true
which doesn't make any sense because the "[vnc]" section is missing.
The fix should be backported to Liberty too. The manual "configuration
reference guide" will show the wrong content too if this isn't fixed
which means the docs team should be pinged when this fix lands, so that
they can trigger the update of the guide. As the cloud operators will
have a wrong documentation, I consider this as a high prio bug.
References: /git.openstack. org/cgit/ openstack/ nova/commit/ ?id=3b38ae48421 b689fbbf96d0a43 c98585a6659e4f generator instead of generate_ sample. sh": /git.openstack. org/cgit/ openstack/ nova/commit/ nova?id= 6f3448bdbff15c2 68cc5b5f9f07855 23b09c6507 /git.openstack. org/cgit/ openstack/ nova/tree/ nova/opts. py?id=20fc24114 d47fcbaf0687bdc 70c3f9edb6b2bed 2#n102
[1]"Register the vnc config options under group 'vnc'":
https:/
[2] "Use oslo-config-
https:/
[3] https:/