← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1775736] [NEW] misleading documentation of filesystem_store_metadata_file config opt

 

Public bug reported:

In glance:

The short discussion of the filesystem_store_metadata_file option in
doc/source/admin/manage-images.rst is misleading on two counts:

(1) It makes it sound like the location metadata is dynamically pulled
from the file and returned in the image-show response for any image.  In
fact, the way this works is that glance will use the info in the file
when it writes the image location--so you will only see this metadata
for images created *after* the option has been set.

(2) The example is misleading in that it uses the same UUID for the
mountpoint and for the image_id, which I suppose would work, but it
makes it look like the two fields are related.

See discussion about this in the glance channel log:
http://eavesdrop.openstack.org/irclogs/%23openstack-glance/%23openstack-
glance.2018-06-01.log.html#t2018-06-01T20:26:28 to about 21:05


In glance_store:

The help text for this option is a bit vague; could stand a rewrite
based on the improvements made in the glance docs.

See
https://github.com/openstack/glance_store/blob/cc97b949033f892d6675692cbc8a24df3ce0e15e/glance_store/_drivers/filesystem.py#L109-L125

** Affects: glance
     Importance: Low
         Status: Triaged

** Affects: glance-store
     Importance: Low
         Status: Triaged

** Also affects: glance-store
   Importance: Undecided
       Status: New

** Changed in: glance-store
       Status: New => Triaged

** Changed in: glance-store
   Importance: Undecided => Low

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

Title:
  misleading documentation of filesystem_store_metadata_file config opt

Status in Glance:
  Triaged
Status in glance_store:
  Triaged

Bug description:
  In glance:

  The short discussion of the filesystem_store_metadata_file option in
  doc/source/admin/manage-images.rst is misleading on two counts:

  (1) It makes it sound like the location metadata is dynamically pulled
  from the file and returned in the image-show response for any image.
  In fact, the way this works is that glance will use the info in the
  file when it writes the image location--so you will only see this
  metadata for images created *after* the option has been set.

  (2) The example is misleading in that it uses the same UUID for the
  mountpoint and for the image_id, which I suppose would work, but it
  makes it look like the two fields are related.

  See discussion about this in the glance channel log:
  http://eavesdrop.openstack.org/irclogs/%23openstack-glance
  /%23openstack-glance.2018-06-01.log.html#t2018-06-01T20:26:28 to about
  21:05

  
  In glance_store:

  The help text for this option is a bit vague; could stand a rewrite
  based on the improvements made in the glance docs.

  See
  https://github.com/openstack/glance_store/blob/cc97b949033f892d6675692cbc8a24df3ce0e15e/glance_store/_drivers/filesystem.py#L109-L125

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


Follow ups