config drive table force_config_drive parameter values do not match Impl

Bug #1430365 reported by Andreas Scheuring
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Invalid
Undecided
Unassigned
openstack-manuals
Invalid
Medium
Unassigned

Bug Description

The config drive table [1] describes for the force_config_drive parameter the following options:
Default: None
Other Options: always

But looking at the code [2], only the following values are allowed:
always, True, False

What does the current default 'None' mean? Is it really a value? Or desribes it the abscense of the parameter? I could not configure it for the force_config_drive option. The abscense of the parameter is the same as 'False', so I guess that's the correct default, isn't it?

The docs should be updated accordingly.

[1] https://github.com/openstack/openstack-manuals/blob/master/doc/common/tables/nova-configdrive.xml
[2] https://github.com/openstack/nova/blob/master/nova/virt/configdrive.py

Tom Fifield (fifieldt)
Changed in openstack-manuals:
milestone: none → kilo
Revision history for this message
Tom Fifield (fifieldt) wrote :

It looks like the force_config_drive parameter was updated about a month ago (https://github.com/openstack/nova/commit/c12a78b35dc910fa97df888960ef2b9a64557254)

These tables are updated automatically, but the script that does the updates needs to be run by humans. The nova tables haven't been updated since Jan 1. As the release is coming up, they will be updated more frequently.

Revision history for this message
Tom Fifield (fifieldt) wrote :

This has still not been updated

tags: added: autogenerate-config-docs nova
Changed in openstack-manuals:
importance: Undecided → Medium
status: New → Confirmed
Revision history for this message
Gauvain Pocentek (gpocentek) wrote :

Our tools don't generate the list of possible values for options implementing specific choices. We need to patch autohelp.py if we want this to happen.

Also, the option doesn't have a default value, leading to a 'None' value in our docs. This should probably be modified in nova.

Tom Fifield (fifieldt)
Changed in openstack-manuals:
milestone: kilo → liberty
tags: added: doc-tools
Revision history for this message
Sylvain Bauza (sylvain-bauza) wrote :

Not sure something needs to be fixed on Nova. Please change the status back to New if you think yes and explain why.

Changed in nova:
status: New → Invalid
Lana (loquacity)
Changed in openstack-manuals:
status: Confirmed → Invalid
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.