openstack/python-ironicclient
Code Issues Proposed changes

Update release notes

Browse Source 
This updates the release notes to:
- indicate that we changed the default API version from '1.9' to 'latest'
- use the term 'Bare Metal API version' as opposed to 'ironic API version'

Change-Id: Idf22673d8b73643393e2f15fa7bd9d8bd39368e5
This commit is contained in:
Ruby Loo 2017-11-08 11:03:49 -05:00
parent 12371e0f90
commit 9ab4193ea3
5 changed files with 24 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
releasenotes/notes/ironic-cli-version-a5cdec73d585444d.yaml
View File

@ -1,12 +1,14 @@
---
upgrade:
- |
The default API version for the ``ironic`` command is now "latest", which
is the maximum version understood by both the client and the server.
The default API version for the ``ironic`` command changed from ``1.9``
to ``latest``. ``latest`` is the maximum version understood by both
the client and the server.
This change makes the CLI automatically pull in new features and changes
(including potentially breaking), when talking to new servers.
Scripts that rely on some specific API behavior should set the
Scripts that used the previous default API version, or that rely on
some specific API behavior, should set the
``IRONIC_API_VERSION`` environment variable or use the
``--ironic-api-version`` CLI argument.
@ -20,6 +22,6 @@ features:
fixes:
- |
Users of the ``ironic`` command no longer have to specify an explicit
API version to use the latest features. The default API version is now
"latest", which is the maximum version understood by both the client
and the server.
API version to use the latest features. The default API version changed
from ``1.9`` to ``latest``, which is the maximum version understood by
both the client and the server.

12
releasenotes/notes/latest-default-41fdcc49701c4d70.yaml
View File

@ -2,12 +2,14 @@
upgrade:
- |
The default API version for the bare metal OSC client (``openstack
baremetal`` commands) is now "latest", which is the maximum version
understood by both the client and the server. This change makes the CLI
baremetal`` commands) changed from ``1.9`` to ``latest``. ``latest``
is the maximum version understood by both the client and the server.
This change makes the CLI
automatically pull in new features and changes (including potentially
breaking), when talking to new servers.
Scripts that rely on some specific API behavior should set the
Scripts that used the previous default API version, or that rely on
some specific API behavior, should set the
``OS_BAREMETAL_API_VERSION`` environment variable or use the
``--os-baremetal-api-version`` CLI argument.
@ -22,5 +24,5 @@ fixes:
- |
Users of the ``openstack baremetal`` commands no longer have to specify
an explicit API version to use the latest features. The default API version
is now "latest", which is the maximum version understood by both the client
and the server.
changed from ``1.9`` to ``latest``, which is the maximum version
understood by both the client and the server.

7
releasenotes/notes/latest-renegotiation-55daa01b3fc261be.yaml
View File

@ -1,8 +1,9 @@
---
fixes:
- |
When using ``--os-baremetal-api-version=latest``, the resulting API version
When using ``--os-baremetal-api-version=latest`` (for ``openstack
baremetal`` CLI) or ``--ironic-api-version=latest`` (for ``ironic`` CLI),
the resulting API version
is now the maximum API version supported by both the client and the server.
Previously, the maximum API version supported by the client was used,
which prevented ``--os-baremetal-api-version=latest`` from working with
older servers.
which prevented ``latest`` from working with older servers.

2
releasenotes/notes/osc-node-rebuild-configdrive-8979d5b1373e8d5f.yaml
View File

@ -4,4 +4,4 @@ features:
Adds the ability to specify a configuration drive when
rebuilding a node, via the ``--config-drive`` option to the
``openstack baremetal node rebuild`` command. This is available starting
with ironic API version 1.35.
with Bare Metal API version 1.35.

8
releasenotes/notes/prelude-2-0-release-ee44150902d3d399.yaml
View File

@ -3,10 +3,10 @@ prelude: |
The 2.0 release has three major changes:
* The default API version for the ``openstack baremetal`` and
``ironic`` commands is ``latest``, the maximum version
understood by both the client and the server. This change makes
the CLI automatically pull in new features and changes
(including potentially breaking), from servers.
``ironic`` commands changed from ``1.9`` to ``latest``. ``latest``
is the maximum version understood by both the client and the server.
This change makes the CLI automatically pull in new features
and changes (including potentially breaking), from servers.
* The ``python-ironicclient`` package no longer includes the
``python-openstackclient`` (OSC) package as a requirement.