<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">2015-06-12 7:52 GMT+08:00 Rochelle Grober <span dir="ltr"><<a href="mailto:rochelle.grober@huawei.com" target="_blank">rochelle.grober@huawei.com</a>></span>:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<div lang="EN-US" link="blue" vlink="purple">
<div>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Just want to add that for logging purposes, consistency, as Devananda explains and Adrian and Sean agree, is really important. The number of fields in a header
response should be consistent. If the field is not always used, a placeholder should be put in (usually a “-“ in logs). Makes parsing these things much easier.</span></p></div></div></blockquote><div><br></div><div>Do you mean if <span style="color:rgb(31,73,125);font-family:Calibri,sans-serif;font-size:14px">X-OpenStack-Nova-API-Version is not in the response, the server should return "</span><span style="color:rgb(31,73,125);font-family:Calibri,sans-serif;font-size:14px">X-OpenStack-Nova-API-Version: -"</span></div><div><span style="color:rgb(31,73,125);font-family:Calibri,sans-serif;font-size:14px">or you mean if experimental flag is not in the response, the servers should return </span><span style="color:rgb(31,73,125);font-family:Calibri,sans-serif;font-size:14px">"</span><span style="color:rgb(31,73,125);font-family:Calibri,sans-serif;font-size:14px">X-OpenStack-Nova-API-Version: 2.2,-"</span></div><div><span style="color:rgb(31,73,125);font-family:Calibri,sans-serif;font-size:14px"><br></span></div><div><span style="color:rgb(31,73,125);font-family:Calibri,sans-serif;font-size:14px">BTW, is this described in http rfc?</span></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="blue" vlink="purple"><div><p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Thanks for both consistency and for specific instance related info in the message bodies. The operators also appreciate this.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">--Rocky<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u> <u></u></span></p>
<div>
<div style="border-style:solid none none;border-top-color:rgb(181,196,223);border-top-width:1pt;padding:3pt 0in 0in">
<p class="MsoNormal"><b><span style="font-size:10pt;font-family:Tahoma,sans-serif">From:</span></b><span style="font-size:10pt;font-family:Tahoma,sans-serif"> Xu, Hejie [mailto:<a href="mailto:hejie.xu@intel.com" target="_blank">hejie.xu@intel.com</a>]
<br>
<b>Sent:</b> Thursday, June 11, 2015 02:10</span></p><div><div class="h5"><br>
<b>To:</b> OpenStack Development Mailing List (not for usage questions)<br>
<b>Subject:</b> Re: [openstack-dev] [api] [Nova] [Ironic] [Magnum] Microversion guideline in API-WG<u></u><u></u></div></div><p></p>
</div>
</div><div><div class="h5">
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Salvatore, thanks for the info, will try to review as soon as possible. Hope we get consistent implementation.<u></u><u></u></span></p>
<p class="MsoNormal"><a name="14de50aac1552fee__MailEndCompose"></a><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u> <u></u></span></p>
<div style="border-style:none none none solid;border-left-color:blue;border-left-width:1.5pt;padding:0in 0in 0in 4pt">
<div>
<div style="border-style:solid none none;border-top-color:rgb(225,225,225);border-top-width:1pt;padding:3pt 0in 0in">
<p class="MsoNormal"><b><span style="font-size:11pt;font-family:Calibri,sans-serif">From:</span></b><span style="font-size:11pt;font-family:Calibri,sans-serif"> Salvatore Orlando [mailto:<a href="mailto:sorlando@nicira.com" target="_blank">sorlando@nicira.com</a>]
<br>
<b>Sent:</b> Wednesday, June 10, 2015 4:51 PM<br>
<b>To:</b> OpenStack Development Mailing List (not for usage questions)<br>
<b>Subject:</b> Re: [openstack-dev] [api] [Nova] [Ironic] [Magnum] Microversion guideline in API-WG<u></u><u></u></span></p>
</div>
</div>
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<p class="MsoNormal">As a further data point, Neutron has been trying to introduce microversioning for a while, without success so far.<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Given the sheer amount of backends the management layer integrates with, and the constant need for the various subteams to "experiment" with the API, the proposal [1] has probably some differences with the proposed guideline.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Since the proposal is not yet approved nor implemented, perhaps it would be worth looking at those differences, and get your advice on whether it might be better if neutron adheres to the current guideline proposal or whether it might be
the case to include Neutron's requirements in the current guideline proposal.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Salvatore<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">[1] <a href="https://review.openstack.org/#/c/136760/" target="_blank">https://review.openstack.org/#/c/136760/</a><u></u><u></u></p>
</div>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<p class="MsoNormal">On 10 June 2015 at 06:28, Xu, Hejie <<a href="mailto:hejie.xu@intel.com" target="_blank">hejie.xu@intel.com</a>> wrote:<u></u><u></u></p>
<blockquote style="border-style:none none none solid;border-left-color:rgb(204,204,204);border-left-width:1pt;padding:0in 0in 0in 6pt;margin:5pt 0in 5pt 4.8pt">
<div>
<div>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">I updated the Microversion specification in API-WG
<a href="https://review.openstack.org/187112" target="_blank">https://review.openstack.org/187112</a></span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">The new patchset adds min/max version headers as Ironic used:</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">X-Openstack-[PROJECT]-API-Minimum-Version</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">X-Openstack-[PROJECT]-API-Maximum-Version</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">And new response body for invalid version request.</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> {</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "versionFault": {</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "max_version": "5.2",</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "min_version": "2.1",</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "description": "Version 5.3 is not supported by the API. \</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> Minimum is 2.1 and maximum is 5.2."</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> }</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> }</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Which for backward compatible can add the existed fields in the response also. For example, the nova
response is</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> {</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "versionFault": {</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "max_version": "5.2",</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "min_version": "2.1",</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "description": "Version 5.3 is not supported by the API. \</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> Minimum is 2.1 and maximum is 5.2."</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> },</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "computeFault": {</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "message": "Version 5.3 is not supported by the API. \</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> Minimum is 2.1 and maximum is 5.2.",</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> "code": 406</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> }</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> }</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">The “computeFault” fields is included by current implementation, we can still add here, hope deprecated
in the future.</span><u></u><u></u></p>
<p class="MsoNormal"><a name="14de50aac1552fee_14ddbf4c49ad6f71__MailEndCompose"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span></a><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">And the “experimental” flag in the X-OpenStack-Nova-API-Version header was deleted. It mentioned
in the nova-spec but</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">It didn’t implement. And I didn’t saw the same thing in the ironic. For current all the things satisfied
all the cases. If we</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">“experimental” flag still usefull, we can propose separately.</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Thanks</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Alex</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:10.5pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<div style="border-style:none none none solid;border-left-color:blue;border-left-width:1.5pt;padding:0in 0in 0in 4pt">
<div>
<div style="border-style:solid none none;border-top-color:rgb(225,225,225);border-top-width:1pt;padding:3pt 0in 0in">
<p class="MsoNormal"><b><span style="font-size:11pt;font-family:Calibri,sans-serif">From:</span></b><span style="font-size:11pt;font-family:Calibri,sans-serif"> Devananda van der Veen [mailto:<a href="mailto:devananda.vdv@gmail.com" target="_blank">devananda.vdv@gmail.com</a>]
<br>
<b>Sent:</b> Monday, June 8, 2015 1:59 AM<br>
<b>To:</b> OpenStack Development Mailing List<br>
<b>Subject:</b> Re: [openstack-dev] [api] [Nova] [Ironic] [Magnum] Microversion guideline in API-WG</span><u></u><u></u></p>
</div>
</div>
<p class="MsoNormal"> <u></u><u></u></p>
<p><u></u> <u></u></p>
<div>
<div>
<p class="MsoNormal">On Jun 5, 2015 4:36 AM, "Sean Dague" <<a href="mailto:sean@dague.net" target="_blank">sean@dague.net</a>> wrote:<br>
><br>
> On 06/05/2015 01:28 AM, Adrian Otto wrote:<br>
> ><br>
> >> On Jun 4, 2015, at 11:03 AM, Devananda van der Veen<br>
> >> <<a href="mailto:devananda.vdv@gmail.com" target="_blank">devananda.vdv@gmail.com</a> <mailto:<a href="mailto:devananda.vdv@gmail.com" target="_blank">devananda.vdv@gmail.com</a>>> wrote:<br>
> >><br>
> >><br>
> >> On Jun 4, 2015 12:00 AM, "Xu, Hejie" <<a href="mailto:hejie.xu@intel.com" target="_blank">hejie.xu@intel.com</a><br>
> >> <mailto:<a href="mailto:hejie.xu@intel.com" target="_blank">hejie.xu@intel.com</a>>> wrote:<br>
> >> ><br>
> >> > Hi, guys,<br>
> >> ><br>
> >> > I<span lang="ZH-CN">’</span>m working on adding Microversion into the API-WG<span lang="ZH-CN">’</span>s guideline which<br>
> >> make sure we have consistent Microversion behavior in the API for user.<br>
> >> > The Nova and Ironic already have Microversion implementation, and as<br>
> >> I know Magnum <a href="https://review.openstack.org/#/c/184975/" target="_blank">
https://review.openstack.org/#/c/184975/</a> is going to<br>
> >> implement Microversion also.<br>
> >> ><br>
> >> > Hope all the projects which support( or plan to) Microversion can<br>
> >> join the review of guideline.<br>
> >> ><br>
> >> > The Mircoversion specification(this almost copy from nova-specs):<br>
> >> <a href="https://review.openstack.org/#/c/187112" target="_blank">https://review.openstack.org/#/c/187112</a><br>
> >> > And another guideline for when we should bump Mircoversion<br>
> >> <a href="https://review.openstack.org/#/c/187896/" target="_blank">https://review.openstack.org/#/c/187896/</a><br>
> >> ><br>
> >> > As I know, there already have a little different between Nova and<br>
> >> Ironic<span lang="ZH-CN">’</span>s implementation. Ironic return min/max version when the requested<br>
> >> > version doesn<span lang="ZH-CN">’</span>t support in server by http-headers. There isn<span lang="ZH-CN">’</span>t such<br>
> >> thing in nova. But that is something for version negotiation we need<br>
> >> for nova also.<br>
> >> > Sean have pointed out we should use response body instead of http<br>
> >> headers, the body can includes error message. Really hope ironic team<br>
> >> can take a<br>
> >> > look at if you guys have compelling reason for using http headers.<br>
> >> ><br>
> >> > And if we think return body instead of http headers, we probably<br>
> >> need think about back-compatible also. Because Microversion itself<br>
> >> isn<span lang="ZH-CN">’</span>t versioned.<br>
> >> > So I think we should keep those header for a while, does make sense?<br>
> >> ><br>
> >> > Hope we have good guideline for Microversion, because we only can<br>
> >> change Mircoversion itself by back-compatible way.<br>
> >><br>
> >> Ironic returns the min/max/current API version in the http headers for<br>
> >> every request.<br>
> >><br>
> >> Why would it return this information in a header on success and in the<br>
> >> body on failure? (How would this inconsistency benefit users?)<br>
> >><br>
> >> To be clear, I'm not opposed to *also* having a useful error message<br>
> >> in the body, but while writing the client side of api versioning,<br>
> >> parsing the range consistently from the response header is, IMO,<br>
> >> better than requiring a conditional.<br>
> >><br>
> > +1. I fully agree with Devananda on this point. Use the headers<br>
> > consistently, and add helpful errors into the body only as an addition<br>
> > to that behavior, not a substitute.<br>
><br>
> I think the difference between Nova and Ironic here is that Nova doesn't<br>
> send all the headers all the time in the final implementation (that part<br>
> of the spec evolved out I think). Part of that was pressure about Header<br>
> bloat that people were concerned about, as that impacts caching layers.<br>
><br>
> I would a agree that if Ironic is sending all the headers all the time,<br>
> that's fine. However, for consistency it would be great to also put a<br>
> real body that explains the issue as well, <u></u><u></u></p>
</div>
</div>
<div>
<div>
<p>Agreed.<u></u><u></u></p>
<p>> as headers are not the first<br>
> place people look when things go wrong, and are often not logged by<br>
> client side tools on errors (where the body would be).<br>
><br>
> -Sean<br>
><br>
> --<br>
> Sean Dague<br>
> <a href="http://dague.net" target="_blank">http://dague.net</a><br>
><br>
> __________________________________________________________________________<br>
> OpenStack Development Mailing List (not for usage questions)<br>
> Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" target="_blank">
OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a><br>
> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><u></u><u></u></p>
</div>
</div>
</div>
</div>
</div>
<p class="MsoNormal" style="margin-bottom:12pt"><br>
__________________________________________________________________________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" target="_blank">
OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><u></u><u></u></p>
</blockquote>
</div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
</div>
</div></div></div>
</div>
<br>__________________________________________________________________________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div><br></div></div>