Many api configuration options appear undocumented

Bug #1256952 reported by Stuart McLaren
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Glance
Fix Released
Low
Unassigned
openstack-manuals
Fix Released
Medium
Unassigned

Bug Description

I don't see documentation for options marked with a '<<<':

CONF.import_opt('registry_client_protocol', _registry_client)
CONF.import_opt('registry_client_key_file', _registry_client)
CONF.import_opt('registry_client_cert_file', _registry_client)
CONF.import_opt('registry_client_ca_file', _registry_client)
CONF.import_opt('registry_client_insecure', _registry_client)
CONF.import_opt('registry_client_timeout', _registry_client)
CONF.import_opt('use_user_token', _registry_client) <<<
CONF.import_opt('admin_user', _registry_client) <<<
CONF.import_opt('admin_password', _registry_client) <<<
CONF.import_opt('admin_tenant_name', _registry_client) <<<
CONF.import_opt('auth_url', _registry_client) <<<
CONF.import_opt('auth_strategy', _registry_client) <<<
CONF.import_opt('auth_region', _registry_client) <<<
CONF.import_opt('metadata_encryption_key', 'glance.common.config')

The other options seemed to be documented (http://docs.openstack.org/developer/glance/configuring.html)

Revision history for this message
Anne Gentle (annegentle) wrote :

Is there any way to automate the docs for settings in glance-api.conf?

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

These options are in the "registry" section of http://docs.openstack.org/trunk/config-reference/content/ch_configuring-openstack-image-service.html

to move them to the 'api' section needs a change in flagmappings and a re-run of the autodoc tool.

Revision history for this message
Anne Gentle (annegentle) wrote :

Looks like https://review.openstack.org/#/c/60916/ will enable multiple groupings for autodoc.

Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Medium
Revision history for this message
Feilong Wang (flwang) wrote :

Stuart, seems this bug has been fixed based on your patch https://review.openstack.org/#/c/59471/, is it? or partially?

Changed in glance:
status: New → Triaged
importance: Undecided → Low
Revision history for this message
Andreas Jaeger (jaegerandi) wrote :
Changed in openstack-manuals:
status: Confirmed → Fix Released
Changed in glance:
status: Triaged → Fix Released
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.