Open Stack

We exuberantly announce the release of:

python-openstackclient 3.10.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.10.0
^^^^^^


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

* Add support for Network Flavor Profile commands: "network flavor
  profile create", "network flavor profile delete", "network flavor
  profile list", "network flavor profile show" and "network flavor
  profile set" [Blueprint :oscbp:`neutron-client-flavors`]

* Add "--share", "--no-share", "--project", "--project-domain"
  options to "qos policy list" command. [Blueprint network-commands-
  options (https://blueprints.launchpad.net/python-
  openstackclient/+spec /network-commands-options)]

* Add "quota list" command with "--compute", "--volume" and "--
  network" options. [Blueprint quota-list
  (https://blueprints.launchpad.net/python-openstackclient/+spec
  /neutron-client-quota)]

* Add "server add port" and "server remove port" commands which
  enable to add/remove ports to/from a server [Bug 1678137
  (https://bugs.launchpad.net/python-openstackclient/+bug/1678137)]

* Add "--no-ha" option to the "router create" command [Bug 1675514
  (https://bugs.launchpad.net/python-openstackclient/+bug/1675514)]

* Add "--fixed-ip-address" option to the "server add floating ip"
  command [Bug 1624524 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1624524)]

* Add "--fixed-ip-address" option to the "server add fixed ip"
  command [Bug 1678140 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1678140)]

* Added "extension show" command to display the details of an
  extension. Currently works only for network extensions. [Blueprint
  extension-show (https://blueprints.launchpad.net/python-
  openstackclient/+spec/extension-show)]

* Add network dhcp-agent related commands "network agent add
  network", "network agent remove network", "network agent list
  --network" and "network list --agent" for adding/removing network to
  dhcp agent. [Blueprint :oscbp:`network-dhcp-adv-commands`]

* Add support to add/remove multi users by "group add/remove user"
  command. [Blueprint  :oscbp:`support-multi-add-remove`]

* Add "--private-key" option for "keypair create" command to specify
  the private key file to save when a keypair is created, removing the
  need to copy the output and paste it into a new file. This is a
  convenient way to save private key in OSC interactive mode. [Bug
  1549410 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1549410)]

* Add "--sort" support to "project list" by sorting items in client
  side By default project list will be sorted by name. [Bug 1596818
  (https://bugs.launchpad.net/bugs/1596818)]

* Add "--qos-policy" option to "port create",  "port set" and "port
  unset" commands. [Bug 1612136 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1612136)]

* Add "--network" and "--port" options to "server create" command as
  alternatives to "--nic" option. [Bug 1612898
  (https://bugs.launchpad.net/bugs/1612898)]

* The "project list" command lists all projects when called by an
  admin user.  For non-admin users it will now list projects for the
  authenticated user instead of exiting with an authorization failure.
  The "--my-projects" option has also been added to the "project list"
  command to allow admin users to list their own projects. [Bug
  1627555 (https://bugs.launchpad.net/bugs/1627555)]

* Add "server event list" and "server event show" commands.

  A server event is the event record of actions performed on a server,
  including: event type(create, delete, reboot and so on), event
  result(success, error), start time, finish time and others. [Bug
  1642030 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1642030)]

* Add "floating ip set" and "floating ip unset" commands.
  [:lpbug:`1560297`]

* Add "network flavor add profile" and "network flavor remove
  profile" commands. [Blueprint :oscbp:`neutron-client-flavors`]


Deprecation Notes
*****************

* "volume transfer request accept" has been changed to move the
  "auth- key" positional argument to a requried option "--auth-key".
  This leaves the transfer request ID as the only positional arguemnt,
  as per the OpenStackClient command format.  The old format is still
  functional, but is deprecated and will be removed in the next major
  release.


Bug Fixes
*********

* Fix "volume transfer request accept" to not fail the transfer
  request name/ID lookup for non-admin users as the Volume API does
  not allow non-admin users access to transfers in other projects.
  [Bug 1633582 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1633582)]

* Change the output column order in "volume transfer request list"
  to have "ID" followed by "Name" then the remaining columns.

* Now the positional parameter "<snapshot-name>" of "volume snapshot
  create" command is no longer optional, it should be always present.
  [Bug 1659894 (https://bugs.launchpad.net/bugs/1659894)]

* "security group list" command now can display project IDs in the
  "Project" column of the command output. [Bug 1659967
  (https://bugs.launchpad.net/bugs/1659967)]

* Allow users to create centralized (distributed=False) routers
  using the "--centralized" option in "router create". Without this,
  routers are created based on the default neutron configuration of
  the deployment, which, for example, could be 'distributed'. [Bug
  1664255 (https://bugs.launchpad.net/bugs/1664255)]

* Add "--mac-address" option to "port set" command. [Bug 1670707
  (https://launchpad.net/bugs/1670707)]

* Narrow acceptable negative response codes for "group contains
  user" [Bug 1672634 (https://bugs.launchpad.net/python-
  openstackclient/+bug/1672634)]

* Fix creating a server with a block-device-mapping when volume_size
  is empty. [Bug 1677236 (https://bugs.launchpad.net/bugs/1652827)]

Changes in python-openstackclient 3.9.0..3.10.0
-----------------------------------------------

d930b04 Funcional tests: quota list
346ac9d Nova-net functional tests: aggregates
983cccb Functional tests: Identity v2 and DevStack
1b9cf82 Updated from global requirements
2c5405e Fix volume qos spec list
190711e Nova net functional tests round 3
dd7da49 Nova net functional tests round 2
e0d1af9 Nova net functional tests round 1
589a65c Fix Nova-net netowrk commands
871450a Fix quota functional tests for nova-net
bffc98e Fix server create with nova-net
b38261e Updated from global requirements
d519911 Functional test for subnet_pool
1c49a1f Fix NoneType error for volume snapshot create command
ef99f44 Improve no-auth path
af435ee Remove ipdb installation in tox debug section
6dc17bb Make test_server.py more elegant and simple
db6081f Fix network list functional test
e611aa6 Explicitly set 'builders' option
107cad2 Low-level Compute v2 API: floating ip pool
b2783dc Low-level Compute v2 API: network
6f473be Split network tests
b168f2d Updated from global requirements
e6ea45b Low-level Compute v2 API: floating ip
1bf6706 Low-level Compute v2 API: security group rules
4289ddd Low-level Compute v2 API: security group
a071ff9 Add document about renaming OS_ENDPOINT_TYPE to OS_INTERFACE
09286ad Split floating IP tests
13bba78 Update to tox.ini
8549071 Add --network and --port to server create
3581751 Updated from global requirements
488ca59 Split security group tests
fe59e33 Allow override of distributed router flag
46b8cad Clean up password prompt work-arounds
763c8c5 "floating ip set/unset port" for OSC
5ff2cfd Add "qos-policy" option to "port create" & "port set"
0e42ea3 Structure FindFloatingIP() to work without ip_cache
7f98148 Enable to specify which fixed-ip to add to a vm.
abb2498 Correct flavor associate/disassociate commands in Mapping Guide
1686dc5 Help/docs cleanups: marker, limit, ip-address metavars
9915efd Release notes cleanup for 3.10.0 release
21510ac Enable to add/remove port to/from a server
b51310a Introduce neutron flavor associate, disassociate to OSC
341f075 Add help commands withouth auth in functional
61cde9c Fix block-device-mapping when volume_size is empty
53ba053 Enable to create legacy router
6d259e5 Trivial Fix
c49c125 Updated from global requirements
f45aa90 Use Sphinx 1.5 warning-is-error
7017065 doc: Correct Sphinx warnings
9f471ee doc: Remove local fork of apidoc
1c3cb0a Change noauth strategy for plugin loading
709eac7 Fix volume transfers request commands
c3fee25 Doc: Fix link in network flavors
832b259 OSC Extension Show
535def3 Remove log translations
8e2bc9c Fix Trivial Changes in [1]
ef5a7ca Support to add/remove multi users for "group add/remove user"
82a86d2 Simplify logic around option lists in port set
f552787 Enable to specify which vm fixed-ip to publish
f4fd8f6 Introduce Neutron DHCP agent commands to OSC
be1e6ca docs: Don't include ChangeLog
7ef1e9e OSC Network Flavor Profile
f1345dc Make MAC address of port updatable
49f6032 Non-Admin can't list own projects
ad5b57f Updated from global requirements
853ea5a Narrow expected responses for CheckUserInGroup
9fd3dba Add extra filtering options to qos policy list
429b43a Adds missing flavor information in the server list long command
1a5704d Functional test for ip_availability
58591d3 OSC Quota List
85d598a Fix reference in network flavor create command reference
498d416 Refactor ServerTests and ServerEventTests functional test classes
888022f Fix "security group list" command to display project ID properly
1e739d7 Trivial Fix
289f15a Jsonify meter and meter rule functional tests
3e6356a Fix handling the use_default_subnet_pool attribute
6c1b03b Add sort support to project list
8c6cfb5 Add the bgp agent type to network agent command
73c2a80 Remove py34 tox env and pypi classifier
f4d3810 command list: Move network meter appropriately
c03b9a8 Add server event list and show commands
dee22d8 Add "--private-key" option for "keypair create"
7063ffb Add a validation about options for server migrate command
f8e8ace SDK refactor: Set "is_admin_state_up" for network agent
4f4af3d Switch to use cleanup method in functional test


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

.../command-objects/consistency-group-snapshot.rst |    2 +-
.../command-objects/network-flavor-profile.rst     |  145 ++
.../command-objects/network-service-provider.rst   |    1 +
.../command-objects/volume-transfer-request.rst    |   21 +-
openstackclient/api/compute_v2.py                  |  502 +++++++
openstackclient/common/clientmanager.py            |   19 +-
openstackclient/common/extension.py                |   29 +
openstackclient/common/quota.py                    |  226 +++-
openstackclient/compute/client.py                  |   23 +
openstackclient/compute/v2/flavor.py               |    4 +-
openstackclient/compute/v2/keypair.py              |   31 +-
openstackclient/compute/v2/server.py               |  226 +++-
openstackclient/compute/v2/server_event.py         |  117 ++
openstackclient/compute/v2/service.py              |    5 +-
openstackclient/i18n.py                            |   10 -
openstackclient/identity/v2_0/project.py           |    9 +
openstackclient/identity/v3/group.py               |   83 +-
openstackclient/identity/v3/project.py             |   33 +-
openstackclient/image/v2/image.py                  |    8 +-
openstackclient/network/sdk_utils.py               |   23 +-
openstackclient/network/v2/floating_ip.py          |  135 +-
openstackclient/network/v2/floating_ip_pool.py     |    4 +-
openstackclient/network/v2/meter.py                |  190 ---
openstackclient/network/v2/network.py              |  103 +-
openstackclient/network/v2/network_agent.py        |  126 +-
openstackclient/network/v2/network_flavor.py       |   57 +
.../network/v2/network_flavor_profile.py           |  250 ++++
openstackclient/network/v2/network_meter.py        |  190 +++
openstackclient/network/v2/network_qos_policy.py   |   29 +-
openstackclient/network/v2/port.py                 |  149 ++-
openstackclient/network/v2/router.py               |   25 +-
openstackclient/network/v2/security_group.py       |   84 +-
openstackclient/network/v2/security_group_rule.py  |   58 +-
openstackclient/network/v2/subnet.py               |   14 +-
openstackclient/network/v2/subnet_pool.py          |    2 +-
openstackclient/object/v1/container.py             |    2 +-
openstackclient/object/v1/object.py                |    2 +-
openstackclient/shell.py                           |   24 +-
.../functional/compute/v2/test_server_event.py     |   84 ++
.../functional/network/v2/test_address_scope.py    |   12 +-
.../functional/network/v2/test_floating_ip.py      |  187 ++-
.../functional/network/v2/test_ip_availability.py  |   76 +-
.../functional/network/v2/test_network_agent.py    |  156 ++-
.../functional/network/v2/test_network_flavor.py   |   62 +-
.../network/v2/test_network_flavor_profile.py      |  189 +++
.../functional/network/v2/test_network_meter.py    |  174 +++
.../network/v2/test_network_meter_rule.py          |  126 +-
.../network/v2/test_network_qos_policy.py          |   31 +-
.../functional/network/v2/test_network_qos_rule.py |  164 ++-
.../network/v2/test_network_qos_rule_type.py       |   10 +-
.../functional/network/v2/test_network_rbac.py     |   51 +-
.../functional/network/v2/test_network_segment.py  |   60 +-
.../network/v2/test_network_service_provider.py    |   10 +-
.../functional/network/v2/test_security_group.py   |   47 +-
.../network/v2/test_security_group_rule.py         |   65 +-
.../functional/network/v2/test_subnet_pool.py      |  319 ++++-
.../functional/volume/v1/test_transfer_request.py  |   12 +-
.../functional/volume/v2/test_transfer_request.py  |   12 +-
.../unit/network/v2/test_floating_ip_compute.py    |  265 ++++
.../unit/network/v2/test_floating_ip_network.py    |  734 ++++++++++
.../network/v2/test_floating_ip_pool_compute.py    |   68 +
.../network/v2/test_floating_ip_pool_network.py    |   46 +
.../unit/network/v2/test_network_flavor_profile.py |  448 +++++++
.../unit/network/v2/test_network_qos_policy.py     |   53 +
.../unit/network/v2/test_security_group_compute.py |  405 ++++++
.../unit/network/v2/test_security_group_network.py |  426 ++++++
.../unit/network/v2/test_security_group_rule.py    | 1401 --------------------
.../network/v2/test_security_group_rule_compute.py |  580 ++++++++
.../network/v2/test_security_group_rule_network.py |  866 ++++++++++++
openstackclient/volume/v1/qos_specs.py             |   19 +-
openstackclient/volume/v1/volume.py                |    2 +-
openstackclient/volume/v1/volume_snapshot.py       |    3 +-
.../volume/v1/volume_transfer_request.py           |   75 +-
openstackclient/volume/v2/backup.py                |    4 +-
openstackclient/volume/v2/qos_specs.py             |   19 +-
openstackclient/volume/v2/snapshot.py              |    4 +-
openstackclient/volume/v2/volume.py                |    4 +-
openstackclient/volume/v2/volume_snapshot.py       |    7 +-
.../volume/v2/volume_transfer_request.py           |   75 +-
openstackclient/volume/v2/volume_type.py           |    2 +-
...dd-network-flavor-profile-e7cc5b353c3ed9d9.yaml |    9 +
.../notes/add-no-property-f97e4b2f390cec06.yaml    |    2 +-
...d-qos-policy-list-options-9ba1ae731a88e7ac.yaml |    5 +
.../add-quota-list-command-0d865fac61db2430.yaml   |    6 +
...ow-to-add-remove-vm-ports-273593d7cc1982de.yaml |    6 +
...w-to-create-legacy-router-cb4dcb44dde74684.yaml |    5 +
...-specify-vm-ip-to-publish-85f7207740c0cc8d.yaml |    5 +
.../allow-to-vm-ip-to-add-7721ba64b863fa77.yaml    |    6 +
.../notes/bp-extension-show-6f7e31a27dad0dc9.yaml  |    6 +
...network-dhcp-adv-commands-e61bf8757f46dc93.yaml |    7 +
...-support-multi-add-remove-9516f72cfacea11a.yaml |    5 +
.../notes/bug-1549410-8df3a4b12fe13ffa.yaml        |    8 +
.../notes/bug-1596818-d4cd93dd4d38d3d6.yaml        |    6 +
.../notes/bug-1612136-ec240349a933db12.yaml        |    6 +
.../notes/bug-1612898-bea3b68251d12d81.yaml        |    6 +
.../notes/bug-1627555-3b47eba215e35b3c.yaml        |    9 +
.../notes/bug-1633582-df2bee534c2da7fc.yaml        |   17 +
.../notes/bug-1642030-166b2b28c8adf22e.yaml        |    9 +
.../notes/bug-1659894-4518b10615498ba9.yaml        |    6 +
.../notes/bug-1659967-644a8ee3621c9e81.yaml        |    6 +
.../notes/bug-1664255-f82c5c13d92fed2a.yaml        |    9 +
.../notes/bug-1670707-c4799fbed39ef75b.yaml        |    5 +
.../notes/bug-1672634-ef754cb5109dd0f2.yaml        |    5 +
.../notes/bug-1677236-7de9d11c3f0fb5ed.yaml        |    6 +
...loating-ip-set-unset-port-28e33875937b69cf.yaml |    5 +
.../neutron-client-flavors-81387171f67a3c82.yaml   |    5 +
requirements.txt                                   |   12 +-
setup.cfg                                          |   40 +-
test-requirements.txt                              |    4 +-
tox.ini                                            |    5 +-
200 files changed, 13438 insertions(+), 5927 deletions(-)


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

diff --git a/requirements.txt b/requirements.txt
index 8688e2a..9d3d80d 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -4 +4 @@
-pbr>=2.0.0 # Apache-2.0
+pbr!=2.1.0,>=2.0.0 # Apache-2.0
@@ -7,2 +7,2 @@ six>=1.9.0 # MIT
-Babel>=2.3.4 # BSD
-cliff>=2.3.0 # Apache-2.0
+Babel!=2.4.0,>=2.3.4 # BSD
+cliff>=2.6.0 # Apache-2.0
@@ -10,2 +10,2 @@ keystoneauth1>=2.18.0 # Apache-2.0
-openstacksdk>=0.9.13 # Apache-2.0
-osc-lib>=1.2.0 # Apache-2.0
+openstacksdk>=0.9.14 # Apache-2.0
+osc-lib>=1.5.1 # Apache-2.0
@@ -17 +17 @@ python-novaclient>=7.1.0 # Apache-2.0
-python-cinderclient!=1.7.0,!=1.7.1,>=1.6.0 # Apache-2.0
+python-cinderclient>=2.0.1 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index f6917e3..467b969 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -16 +16 @@ stevedore>=1.20.0 # Apache-2.0
-os-client-config>=1.22.0 # Apache-2.0
+os-client-config>=1.27.0 # Apache-2.0
@@ -34 +34 @@ python-ironic-inspector-client>=1.5.0 # Apache-2.0
-python-mistralclient>=2.0.0 # Apache-2.0
+python-mistralclient>=3.1.0 # Apache-2.0