yahoo-eng-team team mailing list archive

[Brian Rosmaita <rosmaita.fossdev@xxxxxxxxx>]

Public bug reported:

An operator can modify /etc/schema-image.json to include arbitrary
properties (which was that file's original purpose) and assign them JSON
types other than 'string'.

The type is enforced by image create/update but an end-user making a
call that sets a value on one of these gets a 500.  This is because
everything in the image_properties table must be a string in the
database.  The API, however, won't accept a string value when the schema
says it's boolean or some other non-string JSON data type).  We should
document:

(1) these things *must* be strings

(2) recommend that operators not delete items from the default schema-
image.json file, because this will affect interoperability

(3) maybe recommend using metadefs instead of modifying the image
schema?

** Affects: glance
     Importance: Undecided
         Status: Triaged


** Tags: documentation low-hanging-fruit

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

Title:
  docs: image schema customization restrictions

Status in Glance:
  Triaged

Bug description:
  An operator can modify /etc/schema-image.json to include arbitrary
  properties (which was that file's original purpose) and assign them
  JSON types other than 'string'.

  The type is enforced by image create/update but an end-user making a
  call that sets a value on one of these gets a 500.  This is because
  everything in the image_properties table must be a string in the
  database.  The API, however, won't accept a string value when the
  schema says it's boolean or some other non-string JSON data type).  We
  should document:

  (1) these things *must* be strings

  (2) recommend that operators not delete items from the default schema-
  image.json file, because this will affect interoperability

  (3) maybe recommend using metadefs instead of modifying the image
  schema?

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