Add/consume general description/notes field in image properties

[David Lyle]

Some images we have been uploading to OpenStack require a little bit of tailoring before it can get going. For example we have added AlienVaults OSSIM 4.2 which upon installation requires a static IP address. After launching, the user must change the IP address to the IP that OpenStack his given via DHCP.

I think it would be beneficial for us to be able add notes/descriptions to the image file. When a user is on his way to create a new instance, he will be displayed the notes about the image.

I could write things like
1 - Configure IP Address
2 - Restart OSSIM Services
3 - Login to webgui with admin/admin

This would avoid them having to ask ME for instructions getting them setup. For times where you just can't launch an instance without extra configuration.

Hopefully this is something that can be done!

Thanks

[David Lyle (david-lyle)]

The glance API supports a metadata being attached in to images in a field called properties. The description of the properties field is a from form key/value pair mapping. Right now, Horizon looks for specific properties in that properties field, like Kernel ID, Ramdisk ID and architecture. So theoretically Horizon could look for all fields in properties and show all, potentially messy and untranslatable. So another field could be added to the image properties by Horizon and then consumed by horizon. This would allow for translating the field label. The content however would remain untranslated.

[Rizz Patel (zstar69)]

So...does this mean I can do that right now?

I was really thinking of a "notes" text box that I can input instructions
as I am uploading the image through glance. (I actually use he horizon gui
to create new images..create them first and upload thru there instead of
with glance image-create)..

It would be sweet if ther3 was a notes/description field there. So when
someone goes to launch an instance, they will see the notes either
somewhere in the "Flavors" screen or in the instances screen.

A simple text box..we dont really need to slip that stuff into the metadata
for this. ...
On May 16, 2013 11:35 AM, "David Lyle" <email address hidden> wrote:

> The glance API supports a metadata being attached in to images in a
> field called properties. The description of the properties field is a
> from form key/value pair mapping. Right now, Horizon looks for specific
> properties in that properties field, like Kernel ID, Ramdisk ID and
> architecture. So theoretically Horizon could look for all fields in
> properties and show all, potentially messy and untranslatable. So
> another field could be added to the image properties by Horizon and then
> consumed by horizon. This would allow for translating the field label.
> The content however would remain untranslated.
>
> --
> You received this bug notification because you are subscribed to the bug
> report.
> https://bugs.launchpad.net/bugs/1180861
>
> Title:
> Add/consume general description/notes field in image properties
>
> Status in OpenStack Dashboard (Horizon):
> New
>
> Bug description:
> Some images we have been uploading to OpenStack require a little bit
> of tailoring before it can get going. For example we have added
> AlienVaults OSSIM 4.2 which upon installation requires a static IP
> address. After launching, the user must change the IP address to the
> IP that OpenStack his given via DHCP.
>
> I think it would be beneficial for us to be able add
> notes/descriptions to the image file. When a user is on his way to
> create a new instance, he will be displayed the notes about the image.
>
> I could write things like
> 1 - Configure IP Address
> 2 - Restart OSSIM Services
> 3 - Login to webgui with admin/admin
>
> This would avoid them having to ask ME for instructions getting them
> setup. For times where you just can't launch an instance without extra
> configuration.
>
> Hopefully this is something that can be done!
>
> Thanks
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/horizon/+bug/1180861/+subscriptions
>

[David Lyle (david-lyle)]

Not right away. It requires a change to horizon. The data needs to be stored in the images metadata or it will be lost. But if you look at the edit image dialog now, you will see a Kernel ID field. The Notes field would also have to be added to the form, packaged as part of the image update call to glance. Then when horizon read the image details it would look for the specific metadata fields it added as part of the update. The fields have the format x-image-meta-property-notes.

This is more of an enhancement request than a bug, but if should not be too much effort. I am not a glance expert though and I am relying on my interpretation of the documentation.

[Rizz Patel (zstar69)]

Ok awesome David

I understand what you are saying now. I guess I was thinking more of
something that was stored in Horizon itself (like an HTML frame..or
something, lol.)

But I see how it all ties in now. Thanks for that, I hope down the line we
will see this added!

On Thu, May 16, 2013 at 3:58 PM, David Lyle <email address hidden> wrote:

> Not right away. It requires a change to horizon. The data needs to be
> stored in the images metadata or it will be lost. But if you look at
> the edit image dialog now, you will see a Kernel ID field. The Notes
> field would also have to be added to the form, packaged as part of the
> image update call to glance. Then when horizon read the image details
> it would look for the specific metadata fields it added as part of the
> update. The fields have the format x-image-meta-property-notes.
>
> This is more of an enhancement request than a bug, but if should not be
> too much effort. I am not a glance expert though and I am relying on my
> interpretation of the documentation.
>
> --
> You received this bug notification because you are subscribed to the bug
> report.
> https://bugs.launchpad.net/bugs/1180861
>
> Title:
> Add/consume general description/notes field in image properties
>
> Status in OpenStack Dashboard (Horizon):
> New
>
> Bug description:
> Some images we have been uploading to OpenStack require a little bit
> of tailoring before it can get going. For example we have added
> AlienVaults OSSIM 4.2 which upon installation requires a static IP
> address. After launching, the user must change the IP address to the
> IP that OpenStack his given via DHCP.
>
> I think it would be beneficial for us to be able add
> notes/descriptions to the image file. When a user is on his way to
> create a new instance, he will be displayed the notes about the image.
>
> I could write things like
> 1 - Configure IP Address
> 2 - Restart OSSIM Services
> 3 - Login to webgui with admin/admin
>
> This would avoid them having to ask ME for instructions getting them
> setup. For times where you just can't launch an instance without extra
> configuration.
>
> Hopefully this is something that can be done!
>
> Thanks
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/horizon/+bug/1180861/+subscriptions
>

[Gabriel Hurley (gabriel-hurley)]

I'm open to adding a field for this specific metadata, though I'd love to see us solve the arbitrary metadata problem too.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/31919

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/31919
Committed: http://github.com/openstack/horizon/commit/8ded0be73d9668e68d7862a31645b15b377b90c7
Submitter: Jenkins
Branch: master

commit 8ded0be73d9668e68d7862a31645b15b377b90c7
Author: Zhenguo Niu <email address hidden>
Date: Thu Jun 6 14:04:25 2013 +0800

    Add general description field in image properties

    It would be beneficial for us to be able to add descriptions to the
    image file.

    Change-Id: I8e5f9ce423f1bc76e559ffb437f255fd9717902e
    Fixes: bug #1180861