← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1993483] [NEW] Glance Install Guide & Config Ref Docs Need Updates/Enhancements

 

Public bug reported:

The Install Guide for Glance (Zed) is:

1) outdated; still using configuration fields "stores" and "default_store" in the [glance_store] config group 
 (which are deprecated - removed in Rocky) and does not show good examples of how to properly use the newer "enabled_backends" field under the [DEFAULT] config group.  Unfortunately the Glance Configuration Reference also doesn't supply enough information on how to use the "enabled_backends" field.  For example, what syntax is expected for the dictionary?,  is the dictionary a string:string key value pair?  What kinds of "type" "values" are acceptable and how are they used elsewhere (it says the key is used later in the "default_backend" field, but the value is never explained, or illustrated with a good example in the documents.

2) should be improved to explain what "MY_SERVICE", "MY_PASSWORD" and
"ENTRYPOINT_ID" should be changed to in the [oslo_limit] config group
values being assigned to the various config fields.  I eventually
figured these should be the "glance" user and user password set earlier
but I'm still guessing really.  And as far as the ENTRYPOINT_ID I
figured it was the hash ID of the glance service.  Again, another guess.
And if so, why not use the glance service name? Those terms, MY_SERVICE
etc etc are not explained/referenced anywhere else in the Glance install
document (really confusing since they appear out of nowhere).  They look
to be simply copy pasted from some of the oslo documentation found
elsewhere I think.

** Affects: glance
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to Glance.
https://bugs.launchpad.net/bugs/1993483

Title:
  Glance Install Guide & Config Ref Docs Need Updates/Enhancements

Status in Glance:
  New

Bug description:
  The Install Guide for Glance (Zed) is:

  1) outdated; still using configuration fields "stores" and "default_store" in the [glance_store] config group 
   (which are deprecated - removed in Rocky) and does not show good examples of how to properly use the newer "enabled_backends" field under the [DEFAULT] config group.  Unfortunately the Glance Configuration Reference also doesn't supply enough information on how to use the "enabled_backends" field.  For example, what syntax is expected for the dictionary?,  is the dictionary a string:string key value pair?  What kinds of "type" "values" are acceptable and how are they used elsewhere (it says the key is used later in the "default_backend" field, but the value is never explained, or illustrated with a good example in the documents.

  2) should be improved to explain what "MY_SERVICE", "MY_PASSWORD" and
  "ENTRYPOINT_ID" should be changed to in the [oslo_limit] config group
  values being assigned to the various config fields.  I eventually
  figured these should be the "glance" user and user password set
  earlier but I'm still guessing really.  And as far as the
  ENTRYPOINT_ID I figured it was the hash ID of the glance service.
  Again, another guess. And if so, why not use the glance service name?
  Those terms, MY_SERVICE etc etc are not explained/referenced anywhere
  else in the Glance install document (really confusing since they
  appear out of nowhere).  They look to be simply copy pasted from some
  of the oslo documentation found elsewhere I think.

To manage notifications about this bug go to:
https://bugs.launchpad.net/glance/+bug/1993483/+subscriptions



Follow ups