Re: [openstack-dev] [nova] Flavor extra-spec and image metadata documentation
On Wed, Feb 11, 2015 at 5:15 AM, Daniel P. Berrange berra...@redhat.com wrote: On Wed, Feb 11, 2015 at 12:03:58PM +0100, Pasquale Porreca wrote: Thank you for all answers. I know that meta data tags are free to use with any key/value, still there are some specific values that triggers pieces of code in nova (or maybe even in other components). In particular I am working on one of these key/value, in my case it should enable the bios rebootTimeout=value/ parameter in libvirt. Anyway even if my code is merged, no one will know about it (except myself and the reviewers) if it is not documented somewhere. A DocImpact flag was added to the commit message, but I still don't know how to proper document it. I may create/update existing wiki pages, but I would have preferred an official documentation: I was not able to find the wiki page proposed by Daniel Berrange, even if I had been searching exactly to something similar :( It is very good that there is a work to objectify image meta, anyway is there any recommendation how to document it in the meanwhile? For people submitting patches to nova the expectation is simply that they add DocImpact and have a commit message that describes the usage of the new property. The docs team work from this data. Technically, DocImpact creates a doc bug for the Launchpad project indicated in a configuration file. It's not always an indicator for the doc team to work from, it is the responsibility of each project to take care of their impactful doc bugs. For example, there were over 50 new bugs logged last week, and no way for a centralized doc team to keep up with the incoming DocImpact requests, not even to triage. So please, spread the word wide and far that DocImpact is merely a mechanism to track that further doc work is needed for the feature to be completed. Thanks, Anne There's no current formal docs that I'd expect you to be editing/updating. I would also know if there is any naming convention for image meta and flavor extra-spec keys: in my case I used hw_reboot_timeoutand hw:reboot_timeout respectively, but it is more a bios than hardware feature and they are handled in nova/virt/libvirt/driver.py rather than nova/virt/hardware.py so maybe the name choice was not so good. In terms of image metadata, broadly speaking, we're aiming to standardize on 3 name prefixes in Nova 'hw' - stuff that affects guest hardware configuration (this includes the BIOS settings, since that's hardware firmware) 'os' - stuff that affects the guest operating system setup 'img' - stuff Nova uses related to managing images So, your choice of 'hw_reboot_timeout' for image and 'hw:reboot_timeout' for the flavour is correct. Regards, Daniel -- |: http://berrange.com -o-http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :| __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev -- Anne Gentle annegen...@justwriteclick.com __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [nova] Flavor extra-spec and image metadata documentation
On Wed, Feb 11, 2015 at 10:23:54AM +0100, Pasquale Porreca wrote: Hello I am working on a little patch that introduce a new flavor extra-spec and image metadata key-value pair https://review.openstack.org/#/c/153607/ I am wondering how an openstack admin can be aware that a specific value of a flavor extra-spec or image metadata provides a feature he may desire, in other words is there a place where the flavor extra-specs and/or image metadata key-value pairs are documented? I found plenty of documentation on how to list, create, delete, etc. flavor extra-spec and image metadata, but the only place where I found a list (is that complete?) of the accepted (i.e. that trigger specific feature in nova) key-value pairs is in horizon dashboard, when logged with admin credential. I am a bit confused on how someone working to add a new key/value pair should proceed. There is some adhoc info about a handful of the image metadata properties in glance documentation IIRC, but nothing comprehensive documented in Nova. A year ago I created a wiki page listing all the props I could find in the source at that time but this is out of date now https://wiki.openstack.org/wiki/VirtDriverImageProperties I'm also working on creating an object to represent image metadata properties, so we'll have strict definition of them all in the code https://review.openstack.org/#/c/146601/ Regards, Daniel -- |: http://berrange.com -o-http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :| __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [nova] Flavor extra-spec and image metadata documentation
On Wed, Feb 11, 2015 at 10:23:54AM +0100, Pasquale Porreca wrote: Hello I am working on a little patch that introduce a new flavor extra-spec and image metadata key-value pair https://review.openstack.org/#/c/153607/ I am wondering how an openstack admin can be aware that a specific value of a flavor extra-spec or image metadata provides a feature he may desire, in other words is there a place where the flavor extra-specs and/or image metadata key-value pairs are documented? Unfortunately, there's none as of now. I found this the hard way that you cannot trivially find all possible 'extra_spec' key values that can be set by `nova flavor-key` I did gross things like this: $ grep hw\: nova/virt/hardware.py nova/tests/unit/virt/test_hardware.py | sort | uniq And, obviously the above will only find you 'hw' properties. Daniel Berrangé once suggested that image properties and flavor extra specs need to be 'objectified' to alleviate this. I found plenty of documentation on how to list, create, delete, etc. flavor extra-spec and image metadata, but the only place where I found a list (is that complete?) of the accepted (i.e. that trigger specific feature in nova) key-value pairs is in horizon dashboard, when logged with admin credential. I am a bit confused on how someone working to add a new key/value pair should proceed. -- /kashyap __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [nova] Flavor extra-spec and image metadata documentation
Pasquale Porreca, The flexibility/ freedom to create meta data tags for images and Nova flavor extra specs can be confusing. Even allows one to make typographical errors that may be hard to detect. As Daniel mentions, some tags have a definite meaning/semantics, others can be totally random. Tags with semantic significance will typically be handled by special purpose filters, look in Nova/filters directory, /opt/stack/nova/nova/scheduler/filters The filters documentation in Nova admin guide may help too. All the rest are just matched as strings. Hope that helps. Regards Malini -Original Message- From: Kashyap Chamarthy [mailto:kcham...@redhat.com] Sent: Wednesday, February 11, 2015 2:14 AM To: OpenStack Development Mailing List (not for usage questions) Subject: Re: [openstack-dev] [nova] Flavor extra-spec and image metadata documentation On Wed, Feb 11, 2015 at 10:23:54AM +0100, Pasquale Porreca wrote: Hello I am working on a little patch that introduce a new flavor extra-spec and image metadata key-value pair https://review.openstack.org/#/c/153607/ I am wondering how an openstack admin can be aware that a specific value of a flavor extra-spec or image metadata provides a feature he may desire, in other words is there a place where the flavor extra-specs and/or image metadata key-value pairs are documented? Unfortunately, there's none as of now. I found this the hard way that you cannot trivially find all possible 'extra_spec' key values that can be set by `nova flavor-key` I did gross things like this: $ grep hw\: nova/virt/hardware.py nova/tests/unit/virt/test_hardware.py | sort | uniq And, obviously the above will only find you 'hw' properties. Daniel Berrangé once suggested that image properties and flavor extra specs need to be 'objectified' to alleviate this. I found plenty of documentation on how to list, create, delete, etc. flavor extra-spec and image metadata, but the only place where I found a list (is that complete?) of the accepted (i.e. that trigger specific feature in nova) key-value pairs is in horizon dashboard, when logged with admin credential. I am a bit confused on how someone working to add a new key/value pair should proceed. -- /kashyap __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [nova] Flavor extra-spec and image metadata documentation
Thank you for all answers. I know that meta data tags are free to use with any key/value, still there are some specific values that triggers pieces of code in nova (or maybe even in other components). In particular I am working on one of these key/value, in my case it should enable the bios rebootTimeout=value/ parameter in libvirt. Anyway even if my code is merged, no one will know about it (except myself and the reviewers) if it is not documented somewhere. A DocImpact flag was added to the commit message, but I still don't know how to proper document it. I may create/update existing wiki pages, but I would have preferred an official documentation: I was not able to find the wiki page proposed by Daniel Berrange, even if I had been searching exactly to something similar :( It is very good that there is a work to objectify image meta, anyway is there any recommendation how to document it in the meanwhile? I would also know if there is any naming convention for image meta and flavor extra-spec keys: in my case I used hw_reboot_timeoutand hw:reboot_timeout respectively, but it is more a bios than hardware feature and they are handled in nova/virt/libvirt/driver.py rather than nova/virt/hardware.py so maybe the name choice was not so good. On 02/11/15 11:25, Bhandaru, Malini K wrote: Pasquale Porreca, The flexibility/ freedom to create meta data tags for images and Nova flavor extra specs can be confusing. Even allows one to make typographical errors that may be hard to detect. As Daniel mentions, some tags have a definite meaning/semantics, others can be totally random. Tags with semantic significance will typically be handled by special purpose filters, look in Nova/filters directory, /opt/stack/nova/nova/scheduler/filters The filters documentation in Nova admin guide may help too. All the rest are just matched as strings. Hope that helps. Regards Malini -Original Message- From: Kashyap Chamarthy [mailto:kcham...@redhat.com] Sent: Wednesday, February 11, 2015 2:14 AM To: OpenStack Development Mailing List (not for usage questions) Subject: Re: [openstack-dev] [nova] Flavor extra-spec and image metadata documentation On Wed, Feb 11, 2015 at 10:23:54AM +0100, Pasquale Porreca wrote: Hello I am working on a little patch that introduce a new flavor extra-spec and image metadata key-value pair https://review.openstack.org/#/c/153607/ I am wondering how an openstack admin can be aware that a specific value of a flavor extra-spec or image metadata provides a feature he may desire, in other words is there a place where the flavor extra-specs and/or image metadata key-value pairs are documented? Unfortunately, there's none as of now. I found this the hard way that you cannot trivially find all possible 'extra_spec' key values that can be set by `nova flavor-key` I did gross things like this: $ grep hw\: nova/virt/hardware.py nova/tests/unit/virt/test_hardware.py | sort | uniq And, obviously the above will only find you 'hw' properties. Daniel Berrangé once suggested that image properties and flavor extra specs need to be 'objectified' to alleviate this. I found plenty of documentation on how to list, create, delete, etc. flavor extra-spec and image metadata, but the only place where I found a list (is that complete?) of the accepted (i.e. that trigger specific feature in nova) key-value pairs is in horizon dashboard, when logged with admin credential. I am a bit confused on how someone working to add a new key/value pair should proceed. -- /kashyap __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev -- Pasquale Porreca DEK Technologies Via dei Castelli Romani, 22 00040 Pomezia (Roma) Mobile +39 3394823805 Skype paskporr __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Re: [openstack-dev] [nova] Flavor extra-spec and image metadata documentation
Thank you very much for the clarification :) On 02/11/15 12:15, Daniel P. Berrange wrote: On Wed, Feb 11, 2015 at 12:03:58PM +0100, Pasquale Porreca wrote: Thank you for all answers. I know that meta data tags are free to use with any key/value, still there are some specific values that triggers pieces of code in nova (or maybe even in other components). In particular I am working on one of these key/value, in my case it should enable the bios rebootTimeout=value/ parameter in libvirt. Anyway even if my code is merged, no one will know about it (except myself and the reviewers) if it is not documented somewhere. A DocImpact flag was added to the commit message, but I still don't know how to proper document it. I may create/update existing wiki pages, but I would have preferred an official documentation: I was not able to find the wiki page proposed by Daniel Berrange, even if I had been searching exactly to something similar :( It is very good that there is a work to objectify image meta, anyway is there any recommendation how to document it in the meanwhile? For people submitting patches to nova the expectation is simply that they add DocImpact and have a commit message that describes the usage of the new property. The docs team work from this data. There's no current formal docs that I'd expect you to be editing/updating. I would also know if there is any naming convention for image meta and flavor extra-spec keys: in my case I used hw_reboot_timeoutand hw:reboot_timeout respectively, but it is more a bios than hardware feature and they are handled in nova/virt/libvirt/driver.py rather than nova/virt/hardware.py so maybe the name choice was not so good. In terms of image metadata, broadly speaking, we're aiming to standardize on 3 name prefixes in Nova 'hw' - stuff that affects guest hardware configuration (this includes the BIOS settings, since that's hardware firmware) 'os' - stuff that affects the guest operating system setup 'img' - stuff Nova uses related to managing images So, your choice of 'hw_reboot_timeout' for image and 'hw:reboot_timeout' for the flavour is correct. Regards, Daniel -- Pasquale Porreca DEK Technologies Via dei Castelli Romani, 22 00040 Pomezia (Roma) Mobile +39 3394823805 Skype paskporr __ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
