sample config for host is unclear

Bug #1669746 reported by John Garbutt
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Medium
Stephen Finucane

Bug Description

When we default the host and my_ip setting using oslo_config we end up reporting the details of the infra worker that generated the docs. We should make use of the sample default to add some text that looks better in the docs.

In addition the description of host doesn't mention this is used as the oslo.messaging queue name for nova-compute worker. It is also used for the neutron bind host, so should match the host config of the neutorn agent. It is also used for the cinder host attachment information.

For context, here is the current rendering of the conf:

#
# Hostname, FQDN or IP address of this host. Must be valid within AMQP key.
#
# Possible values:
#
# * String with hostname, FQDN or IP address. Default is hostname of this host.
# (string value)
#host = ubuntu-xenial-osic-cloud1-disk-7584065

Note there are other ones needing sample default to be set:

#
# The IP address which the host is using to connect to the management network.
#
# Possible values:
#
# * String with valid IP address. Default is IPv4 address of this host.
#
# Related options:
#
# * metadata_host
# * my_block_storage_ip
# * routing_source_ip
# * vpn_ip
# (string value)
#my_ip = 10.29.14.104

Tags: doc
tags: added: doc
Changed in nova:
importance: Undecided → Medium
Changed in nova:
assignee: nobody → Maciej Szankin (mszankin)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.openstack.org/441210

Changed in nova:
assignee: Maciej Szankin (mszankin) → nobody
status: In Progress → Confirmed
Sean Dague (sdague)
Changed in nova:
assignee: nobody → Maciej Szankin (mszankin)
status: Confirmed → In Progress
Changed in nova:
assignee: Maciej Szankin (mszankin) → Stephen Finucane (stephenfinucane)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/441210
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=80b5ad046da7e633b88bbec687745e03691841cd
Submitter: Jenkins
Branch: master

commit 80b5ad046da7e633b88bbec687745e03691841cd
Author: Stephen Finucane <email address hidden>
Date: Fri Jun 30 14:58:06 2017 +0100

    conf: fix netconf, my_ip and host are unclear

    Default values set for my_ip and host config opts in the netconf file
    are reporting the details of the infra worker, thus making it unclear
    what the real default value should be. Also, help text for the host opt
    did not mention its relevance to the cinder and neutron settings.

    Change-Id: I69e3953fa46766ea2818bd01c4de949fd43938b0
    Closes-Bug: 1669746
    Implements: blueprint centralize-config-options-pike

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 16.0.0.0b3

This issue was fixed in the openstack/nova 16.0.0.0b3 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.