Open Stack

We are gleeful to announce the release of:

python-openstackclient 3.12.0: OpenStack Command-line Client

This release is part of the pike release series.

The source is available from:

    https://git.openstack.org/cgit/openstack/python-openstackclient

Download the package from:

    https://pypi.python.org/pypi/python-openstackclient

Please report issues through launchpad:

    https://bugs.launchpad.net/python-openstackclient

For more details, please see below.

3.12.0
^^^^^^


New Features
************

* Add "--default"  and "--no-default" options to "network qos policy
  create" and "network qos policy set" comamnds. [Bug 1639220
  (https://bugs.launchpad.net/bugs/1639220)]

* The "virtio-forwarder" VNIC type has been added as another option
  for setting the "--vnic-type" property on the "port set" and "port
  create" commands. This requests a low-latency virtio port inside the
  instance, likely backed by hardware acceleration. Currently the
  Agilio OVS external plugin provides support for this, with support
  from other vendors following soon.

* Add  "network agent add router" and "network agent remove router"
  commands for adding/removing routers to network l3 agents.
  [Blueprint :oscbp:`network-l3-commands`]

* Add "--router" option to "network agent list" to filter by router,
  and "--agent" option to "router list" command to filter by agent.
  [Blueprint :oscbp:`network-l3-commands`]

* Added support for "tags" to the following resources: "network",
  "subnet", "port", "router" and "subnet pool". [Blueprint :oscbp
  :`neutron-client-tag`]

  * Add "--tag" and "--no-tag" options to corresponding "create"
    commands.

  * Add "--tag" and "--no-tag" options to corresponding "set"
    commands.

  * Add "--tag" and "--all-tag" options to corresponding "unset"
    commands. ("network unset" command is introduced to support the
    tag operation)

  * Add "--tags", "--any-tags", "--not-tags" and "--not-any-tags"
    options to corresponding "list" commands.

* Add command "openstack project purge" to clean a project's
  resources. [Bug 1584596 (https://bugs.launchpad.net/bugs/1584596)]

* Added "--egress" and "--ingress" options to "network qos rule
  create" and "network qos rule set" commands. This adds
  directionality to Network QoS "bandwidth-limit" rule type. [Bug
  1614121 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1614121)]

* Add "--human-readable" option to "image show" to display image
  size in human readable format (such as K, M, G, T,..) [Bug 1640086
  (https://bugs.launchpad.net/bugs/1640086)]

* Add "--default-quota" option to "subnet pool create" and "subnet
  pool set" commands. [Bug 1667294 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1667294)]

* Add "--data-plane-status" option to "port set" and "port unset"
  commands. [Bug 1684989 (https://bugs.launchpad.net/bugs/1684989)]

* Added the "--domain" option to the "identity provider create"
  command to associate an existing domain with an identity provider on
  its creation.

  [Bug 1698390 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1698390)]

* Add "--name" and "--status" options to "image list" command to
  filter images based on name and status respectively. [Bug 1698742
  (https://bugs.launchpad.net/bugs/1698742)]

* Add "--user" and "--type" option to "credential list" command to
  filter list result by different user or type.

* Add support for streaming Swift objects to stdout when using the
  "object save" command by specifying "-" as a file name: "--filename
  -".

* Add "--no-name-lookup" option to "server list" command to skip the
  lookup of flavor and image names.  This can save a significant
  amount of time on clouds with a large number of images.  "-n" is an
  alias for this option.


Bug Fixes
*********

* Change column name "Display Name" to "Name" in "volume list"
  output. Current "volume list --name" command uses "display_name" as
  search_opts to send to cinder API, and show the result table with
  "Display Name" as column title. Replace all "Display Name" by "Name"
  to be consistent with other list commands.

  Support a mapping for volume list -c "Display Name" (Volume v1 and
  v2) and volume create/show -c "display_name" (Volume v1) to maintain
  backward compatibility until the next major release. [Bug 1657956
  (https://bugs.launchpad.net/python-openstackclient/+bug/1657956)]

* Make the "role assignment list" command callable without
  administrator permissions if restricted to the user's own project
  with the "--project" option. [Bug 1658189
  (https://bugs.launchpad.net/python-openstackclient/+bug/1658189)]

* Clarify the "--block-device-mapping" option of the "server create"
  command: fix ValueError when the "--block-device-mapping" option's
  argument is in the wrong format; support creating a block device
  from a snapshot; add details to the help output about the option
  format. [Bug 1667266 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1667266)]

* Allow the "--security-group" option from the "server create"
  command to be specified by name or ID.  This also checks that the
  security group exist before creating the server. [Bug 1687814
  (https://bugs.launchpad.net/python-openstackclient/+bug/1687814)]

* Raise exact exception when extension don't exist in "extension
  show" command, and keep the column display order consist in
  "extension list" with and without "--long" option. [Bug 1689233
  (https://bugs.launchpad.net/python-openstackclient/+bug/1689233)]

* Fixed an issue where a trust could not be created if multiple
  roles had the same name. A role's ID is now sent to the identity
  service instead. [Bug 1696111
  (https://bugs.launchpad.net/keystone/+bug/1696111)]

* Fix an issue with the "--domain" option when used with the
  "project show", "user show" and "user set" commands.  The domain
  filter did not work when the login user's project name or user name
  is the same as the requested resource name in the specified domain.
  [Bug 1704097 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1704097)]

* Add "--community" and "--shared" options to the "image create" and
  "image set" commands to allow image owners to share images across
  multiple projects without explicitly creating image members.
  “Community images” will not appear in user’s default image listings.

* Remove "--transparent-vlan" and "--no-transparent-vlan" from
  "network set", because updating "vlan-transparent" is not supported
  in Neutron. [Bug 1691776 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1691776)]

Changes in python-openstackclient 3.11.0..3.12.0
------------------------------------------------

470a1f1a Add optional parameter "user_id" and "type" to list credentials
78a83244 network tag UT: avoid using mix-in test class
92577656 wrong values in openstack quota show command
57e58407 Network tag support
45d0809b Updated from global requirements
1f2295cf Release note cleanup for 3.12.0
bb59353e Updated from global requirements
199c13c8 Updated from global requirements
77ff011c Add domain parameter to Identity Provider
9cfa12df Start using 'cliff.sphinxext'
26ec06e2 Updated from global requirements
f1d32dbe Clean up the changes of os.environ in functional tests
b43b1f8f Minor followup to network agent docs
8d7ee8da Fix dynamic names in network functional tests
99a502b2 Disable karborclient until a fixed version is released
cf5dfa77 Add support for virtio-forwarder VNIC type
a01bf55d Fix 'domain' filter not work well in some commands
2689984b Fix column names for server list --no-name-lookup
db7d0723 Updated from global requirements
bca8d57e image-list should support filters 'name','status'
1ae904a4 Add 'data_plane_status' option to Port classes
3cba09e7 Fix unit test failures related to new os-client-config and osc-lib
18c53237 Network L3 Router Commands for OSC
2c57f7bf Add server list -n and --no-name-lookup arguments
faf6e161 Use openstackdocstheme in release note
eb19c167 Add the other commands for karbor osc plugin
ae35a291 Allow objects to be streamed to stdout
c17819ab Add new parameter "is_default" to Network QoS policy.
79b992b5 Fix man page build
2e83c987 Add missing barbican commands
3468ea1c Added 'openstack image set --visibility'
2bd12473 Add python-octaviaclient plugin
2b7cb155 Remove inaccurate mapping of 'host-meta' in csv
ca4b9be8 Updated from global requirements
1405818b Updated from global requirements
cf60df42 switch to openstackdocstheme
6eb15515 Use identity auth v3 the README examples
c0719c36 Updated from global requirements
0ddda620 update the docs URLs in the readme
e7807bc0 move auto-generated api docs into contributor tree
9599ffe6 reorganize existing documentation according to the new standard layout
20c23d8c Enable some off-by-default checks
fcafd987 Now OSC server create check keys in --nic
da53c2b3 When creating a trust, send role_ids instead or role_names
ccb743cf Add direction field to QoS bandwidth limit.
4c2eb2bd Show neutron tags in OSC network show
7653cff5 Add support for Karbor Plugin
227d4c64 Add project purge command to osc
2b66c71a Don't show hint about vlan transparent in network set
eb793dc8 Add default-quota to subnet pool commands
e54fcd0a Updated from global requirements
40adedf6 Fix Mapping Guide Error
f403ff9e Updated from global requirements
eeb614c4 volume functest: ensure snapshots deleted when volume delete
c912717e Updated from global requirements
adac738f Updated from global requirements
16eedeb9 Updated from global requirements
d034b980 Updated from global requirements
b52bbe1e Trivial fix typos
6aceca21 Replace "Display Name" by "Name" in volume list
6425fc30 JSON-ify image functional tests
0ad6b6b2 Use _get_token_resource in role assignment list
5df961a1 Updated from global requirements
45496fee Create server with security group ID and name
acc2d106 Refactor Extension show and list command
411cda72 Updated from global requirements
332671f9 Convert image functional tests into JSON format
62c793c7 Convert volume functional tests into JSON format
7a7bb063 Make block-device-mapping more stable and clear
3896d28d Correct the "extra spec" command openstack
0181de38 Updated from global requirements
e8f3103c Ignore more exceptions in quota list
6f31634f Rework floating ip functional tests
35dc8582 Revert "Fix port command for SDK >0.9.10"
6962cc96 To display image size in human friendly format
9f297853 Add functional test for volume service


Diffstat (except docs and test files)
-------------------------------------

.gitignore                                         |   2 +-
README.rst                                         |  12 +-
.../{ => cli}/command-objects/access-token.rst     |   0
.../{ => cli}/command-objects/address-scope.rst    |   0
.../command-objects/availability-zone.rst          |   0
.../{ => cli}/command-objects/compute-agent.rst    |   0
.../{ => cli}/command-objects/compute-service.rst  |   0
.../{ => cli}/command-objects/configuration.rst    |   2 +
.../command-objects/consistency-group-snapshot.rst |   0
.../command-objects/consistency-group.rst          |   0
.../{ => cli}/command-objects/console-log.rst      |   0
.../{ => cli}/command-objects/console-url.rst      |   0
.../{ => cli}/command-objects/credential.rst       |  19 +-
.../{ => cli}/command-objects/ec2-credentials.rst  |   0
.../command-objects/federation-protocol.rst        |   0
.../{ => cli}/command-objects/floating-ip-pool.rst |   0
.../{ => cli}/command-objects/floating-ip.rst      |   0
.../{ => cli}/command-objects/hypervisor-stats.rst |   0
.../{ => cli}/command-objects/hypervisor.rst       |   0
.../command-objects/identity-provider.rst          |   6 +
.../{ => cli}/command-objects/ip-availability.rst  |   0
.../{ => cli}/command-objects/ip-floating-pool.rst |   0
.../{ => cli}/command-objects/ip-floating.rst      |   0
.../{ => cli}/command-objects/network-agent.rst    | 123 ++-
.../network-auto-allocated-topology.rst            |   0
.../command-objects/network-flavor-profile.rst     |   0
.../{ => cli}/command-objects/network-flavor.rst   |   0
.../command-objects/network-meter-rule.rst         |   0
.../{ => cli}/command-objects/network-meter.rst    |   0
.../command-objects/network-qos-policy.rst         |  18 +
.../command-objects/network-qos-rule-type.rst      |   0
.../{ => cli}/command-objects/network-qos-rule.rst |   0
.../{ => cli}/command-objects/network-rbac.rst     |   0
.../{ => cli}/command-objects/network-segment.rst  |   0
.../command-objects/network-service-provider.rst   |   0
.../command-objects/object-store-account.rst       |   0
.../{ => cli}/command-objects/request-token.rst    |   0
.../{ => cli}/command-objects/role-assignment.rst  |   0
.../command-objects/security-group-rule.rst        |   0
.../{ => cli}/command-objects/security-group.rst   |   0
.../{ => cli}/command-objects/server-backup.rst    |   0
.../{ => cli}/command-objects/server-event.rst     |   0
.../{ => cli}/command-objects/server-group.rst     |   0
.../{ => cli}/command-objects/server-image.rst     |   0
.../{ => cli}/command-objects/service-provider.rst |   0
.../{ => cli}/command-objects/subnet-pool.rst      |  61 +-
.../{ => cli}/command-objects/volume-backup.rst    |   0
.../{ => cli}/command-objects/volume-host.rst      |   0
.../{ => cli}/command-objects/volume-qos.rst       |   0
.../{ => cli}/command-objects/volume-service.rst   |   0
.../{ => cli}/command-objects/volume-snapshot.rst  |   0
.../command-objects/volume-transfer-request.rst    |   0
.../{ => cli}/command-objects/volume-type.rst      |   0
.../{configuration.rst => configuration/index.rst} |   8 +-
.../{ => contributor}/humaninterfaceguide.rst      |   4 +-
.../specs/command-objects/example.rst              |   0
.../{ => contributor}/specs/network-topology.rst   |   0
openstackclient/api/compute_v2.py                  |   2 +-
openstackclient/api/object_store_v1.py             |  15 +-
openstackclient/common/extension.py                |  49 +-
openstackclient/common/project_purge.py            | 168 ++++
openstackclient/common/quota.py                    |  31 +-
openstackclient/compute/v2/server.py               | 206 +++--
openstackclient/identity/common.py                 |   8 +-
openstackclient/identity/v3/credential.py          |  37 +-
openstackclient/identity/v3/identity_provider.py   |  17 +-
openstackclient/identity/v3/project.py             |   3 +-
openstackclient/identity/v3/role_assignment.py     |   3 +-
openstackclient/identity/v3/trust.py               |  12 +-
openstackclient/identity/v3/user.py                |   6 +-
openstackclient/image/v1/image.py                  |   9 +
openstackclient/image/v2/image.py                  |  58 +-
openstackclient/network/v2/_tag.py                 | 134 +++
openstackclient/network/v2/network.py              |  75 +-
openstackclient/network/v2/network_agent.py        | 121 ++-
openstackclient/network/v2/network_qos_policy.py   |  44 +-
openstackclient/network/v2/network_qos_rule.py     |  32 +-
openstackclient/network/v2/port.py                 |  53 +-
openstackclient/network/v2/router.py               |  51 +-
openstackclient/network/v2/subnet.py               |  21 +-
openstackclient/network/v2/subnet_pool.py          |  35 +-
openstackclient/object/v1/object.py                |   3 +-
.../functional/network/v2/test_floating_ip.py      | 334 +++----
.../functional/network/v2/test_ip_availability.py  |  28 +-
.../functional/network/v2/test_network_agent.py    |  36 +
.../network/v2/test_network_meter_rule.py          |  19 +-
.../network/v2/test_network_qos_policy.py          |  33 +-
.../functional/network/v2/test_network_qos_rule.py |  84 +-
.../functional/network/v2/test_network_rbac.py     |  28 +-
.../functional/network/v2/test_network_segment.py  |  22 +-
.../functional/network/v2/test_security_group.py   |  36 +-
.../network/v2/test_security_group_rule.py         |  31 +-
.../functional/network/v2/test_subnet_pool.py      |  47 +-
.../functional/volume/v1/test_transfer_request.py  |  63 +-
.../functional/volume/v2/test_transfer_request.py  |  66 +-
.../functional/volume/v3/test_transfer_request.py  |   9 +-
.../unit/identity/v3/test_identity_provider.py     |  81 +-
.../unit/network/v2/test_network_qos_policy.py     |  42 +-
openstackclient/volume/v1/volume.py                |  24 +-
openstackclient/volume/v2/volume.py                |   6 +-
...ult-to-network-qos-policy-89b11d4df032a789.yaml |   7 +
...irtio-forwarder-vnic-type-bad939c6a868b9e9.yaml |   9 +
...p-network-l3-adv-commands-cc1df715a184f1b2.yaml |  10 +
.../bp-neutron-client-tag-ff24d13e5c70e052.yaml    |  13 +
.../notes/bug-1584596-5b3109487b451bec.yaml        |   5 +
.../notes/bug-1614121-a3c5b6892074d5ae.yaml        |   7 +
.../notes/bug-1640086-21d7e5f2ce18f53c.yaml        |   6 +
.../notes/bug-1657956-977a615f01775288.yaml        |  13 +
.../notes/bug-1658189-d2b390ad74c96c79.yaml        |   6 +
.../notes/bug-1667266-6497727abc2af9a5.yaml        |   8 +
.../notes/bug-1667294-f92efa49627eb00a.yaml        |   6 +
.../notes/bug-1684989-3bda158a822d2f73.yaml        |   5 +
.../notes/bug-1687814-743ad8418923d5e3.yaml        |   7 +
.../notes/bug-1689233-c3f98e159c75374e.yaml        |   7 +
.../notes/bug-1696111-e2cf9233fa872eb7.yaml        |   6 +
.../notes/bug-1698390-0df8f0ec4fe354de.yaml        |   7 +
.../notes/bug-1698742-66d9d4e6c7ad274a.yaml        |   6 +
.../notes/bug-1704097-8ff1ce1444b81b04.yaml        |   8 +
...credential_list_user_type-c809e5b8014d6275.yaml |   5 +
.../image_set_visibility-babf4ff2f687d465.yaml     |   7 +
.../notes/object-stdout-db76cc500948b0e8.yaml      |   5 +
...rted-set-vlan-transparent-eeff412264ae7c09.yaml |   7 +
.../notes/skip-name-lookups-9f499927173c1eee.yaml  |   6 +
releasenotes/source/conf.py                        |  14 +-
requirements.txt                                   |  16 +-
setup.cfg                                          |   5 +
test-requirements.txt                              |  20 +-
tox.ini                                            |   2 +
257 files changed, 6334 insertions(+), 2256 deletions(-)


Requirements updates
--------------------

diff --git a/requirements.txt b/requirements.txt
index faf34c0a..24e46723 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -8,5 +8,5 @@ Babel!=2.4.0,>=2.3.4 # BSD
-cliff>=2.6.0 # Apache-2.0
-keystoneauth1>=2.20.0 # Apache-2.0
-openstacksdk>=0.9.14 # Apache-2.0
-osc-lib>=1.5.1 # Apache-2.0
-oslo.i18n>=2.1.0 # Apache-2.0
+cliff>=2.8.0 # Apache-2.0
+keystoneauth1>=3.0.1 # Apache-2.0
+openstacksdk>=0.9.17 # Apache-2.0
+osc-lib>=1.7.0 # Apache-2.0
+oslo.i18n!=3.15.2,>=2.1.0 # Apache-2.0
@@ -14 +14 @@ oslo.utils>=3.20.0 # Apache-2.0
-python-glanceclient>=2.5.0 # Apache-2.0
+python-glanceclient>=2.7.0 # Apache-2.0
@@ -16,2 +16,2 @@ python-keystoneclient>=3.8.0 # Apache-2.0
-python-novaclient>=7.1.0 # Apache-2.0
-python-cinderclient>=2.0.1 # Apache-2.0
+python-novaclient>=9.0.0 # Apache-2.0
+python-cinderclient>=3.0.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index 467b9695..e3848618 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6 +6 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
-coverage>=4.0 # Apache-2.0
+coverage!=4.4,>=4.0 # Apache-2.0
@@ -9 +9 @@ mock>=2.0 # BSD
-oslosphinx>=4.7.0 # Apache-2.0
+openstackdocstheme>=1.11.0 # Apache-2.0
@@ -11,2 +11,2 @@ oslotest>=1.10.0 # Apache-2.0
-reno>=1.8.0 # Apache-2.0
-requests!=2.12.2,!=2.13.0,>=2.10.0 # Apache-2.0
+reno!=2.3.1,>=1.8.0 # Apache-2.0
+requests>=2.14.2 # Apache-2.0
@@ -14 +14 @@ requests-mock>=1.1 # Apache-2.0
-sphinx>=1.5.1 # BSD
+sphinx>=1.6.2 # BSD
@@ -16 +16 @@ stevedore>=1.20.0 # Apache-2.0
-os-client-config>=1.27.0 # Apache-2.0
+os-client-config>=1.28.0 # Apache-2.0
@@ -20 +20 @@ testtools>=1.4.0 # MIT
-tempest>=14.0.0 # Apache-2.0
+tempest>=16.1.0 # Apache-2.0
@@ -32 +32 @@ python-heatclient>=1.6.1 # Apache-2.0
-python-ironicclient>=1.11.0 # Apache-2.0
+python-ironicclient>=1.14.0 # Apache-2.0
@@ -33,0 +34 @@ python-ironic-inspector-client>=1.5.0 # Apache-2.0
+python-karborclient>=0.2.0 # Apache-2.0
@@ -36 +37,2 @@ python-muranoclient>=0.8.2 # Apache-2.0
-python-neutronclient>=5.1.0 # Apache-2.0
+python-neutronclient>=6.3.0 # Apache-2.0
+python-octaviaclient>=1.0.0 # Apache-2.0