[openstack-dev] [ironic] OpenStack client default ironic API version
dtantsur at redhat.com
Wed Mar 8 12:40:37 UTC 2017
On 03/07/2017 04:59 PM, Loo, Ruby wrote:
> On 2017-03-06, 3:46 PM, "Mario Villaplana" <mario.villaplana at gmail.com> wrote:
> Hi ironic,
> At the PTG, an issue regarding the default version of the ironic API
> used in our python-openstackclient plugin was discussed.  In short,
> the issue is that we default to a very old API version when the user
> doesn't otherwise specify it. This limits discoverability of new
> features and makes the client more difficult to use for deployments
> running the latest version of the code.
> We came to the following consensus:
> 1. For a deprecation period, we should log a warning whenever the user
> doesn't specify an API version, informing them of this change.
> 2. After the deprecation period:
> a) OSC baremetal plugin will default to the latest available version
> I think OSC and ironic CLI have the same behaviour -- are we only interested in OSC or are we interested in both, except that we also want to at some point soon perhaps, deprecate ironic CLI?
I think we should only touch OSC, because of planned deprecation you mention.
> Also, by 'latest available version', the OSC plugin knows (or thinks it knows) what the latest version is . Will you be using that, or 'latest'?
It will pass "latest" to the API, so it may end up with a version the client
side does not know about. This is intended, I think. It does have some
consequences if we make breaking changes like removing parameters. As we're not
overly keen on breaking changes anyway, this may not be a huge concern.
> b) Specifying just macroversion will default to latest microversion
> within that macroversion (example: --os-baremetal-api-version=1 would
> default to 1.31 if 1.31 is the last microversion with 1 macroversion,
> even if we have API 2.2 supported)
> I have a patch up for review with the deprecation warning:
> Do you have an RFE? I'd like a spec for this too please.
Dunno if this change really requires a spec, but if you want one - let's have one :)
We should have an RFE anyway, obviously.
> Please comment on that patch with any concerns.
> We also still have yet to decide what a suitable deprecation period is
> for this change, as far as I'm aware. Please respond to this email
> with any suggestions on the deprecation period.
>  https://etherpad.openstack.org/p/ironic-pike-ptg-operations L30
> Thank YOU!
>  https://github.com/openstack/python-ironicclient/blob/f242c6af3b295051019aeabb4ec7cf82eb085874/ironicclient/osc/plugin.py#L29
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
More information about the OpenStack-dev