Backwards Incompatible Changes

Despite our best efforts, sometimes the OpenStackClient team may introduce a backwards incompatible change. For user convenience we are tracking any such changes here (as of the 1.0.0 release).

Should positional arguments for a command need to change, the OpenStackClient team attempts to make the transition as painless as possible. Look for deprecation warnings that indicate the new commands (or options) to use.

Commands labeled as a beta according to Command Beta are exempt from this backwards incompatible change handling.

Backwards Incompatible Changes

Release 4.0

  1. Remove ip fixed add|remove commands.

    Use server add|remove fixed ip commands instead.

  2. Remove ip floating add|remove commands.

    Use server add|remove floating ip commands instead.

  3. Remove service create option --type. Service type is a positional argument.

  4. Remove role list options --project and --user.

    Use role assignment list options --project and --user instead.

  5. Remove user role list command.

    Use role assignment list options --project and --user instead.

  6. Remove image create|set option --owner.

    Use --project option instead.

  7. Remove port create|set options --device-id and --host-id.

    Use --device and --host instead.

  8. Remove router set option --clear-routes.

    Use no-route option instead.

  9. Remove security group rule create options --src-ip and --src-group.

    Use --remote-ip and --remote-group options instead.

  10. Remove backup commands.

    Use volume backup commands instead.

  11. Remove snapshot commands. Use volume snapshot commands instead.

  12. Remove volume create options --project, --user, --multi-attach.

  13. Change volume transfer request accept to use new option --auth-key rather than a second positional argument.

  14. Remove ‘Token/Endpoint’ auth plugin support (type token_endpoint).

    This remained as a compatibility for the admin_token auth type to support the --url global option. That option is also now removed, use --endpoint instead.

Release 3.12

  1. Replace Display Name by Name in volume list.

    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.

Release 3.10

  1. The network create command now requires the --subnet option when used with nova-network clouds.

  2. The positional argument <snapshot-name> of the volume snapshot create command is no longer optional.

    Previously when the --volume option was present <snapshot-name> defaulted to the --volume value. When the --volume option is not present now it defaults to the value of <snapshot-name>.

Release 3.0

  1. Remove the osc_password authentication plugin.

    This was the ‘last-resort’ plugin default that worked around an old default Keystone configuration for the admin_endpoint and public_endpoint.

Releases Before 3.0

  1. Rename command openstack project usage list

    The project part of the command was pointless.

  2. <type> should not be optional for command openstack service create

    Previously, the command was openstack service create <name> –type <type>, whereas now it is: openstack service create <type> –name <name>. This bug also affected python-keystoneclient, and keystone.

  3. Command openstack security group rule delete now requires rule id

    Previously, the command was openstack security group rule delete –proto <proto> [–src-ip <ip-address> –dst-port <port-range>] <group>, whereas now it is: openstack security group rule delete <rule>.

  4. Command openstack image create does not update already existing image

    Previously, the image create command updated already existing image if it had same name. It disabled possibility to create multiple images with same name and lead to potentially unwanted update of existing images by image create command. Now, update code was moved from create action to set action.

  5. Command openstack network list –dhcp has been removed

    The –dhcp option to network list is not a logical use case of listing networks, it lists agents. Another command should be added in the future to provide this functionality. It is highly unlikely anyone uses this feature as we don’t support any other agent commands. Use neutron dhcp-agent-list-hosting-net command instead.

  6. Plugin interface change for default API versions

    Previously, the default version was set in the parsed arguments, but this makes it impossible to tell what has been passed in at the command line, set in an environment variable or is just the default. Now, the module should have a DEFAULT_API_VERSION that contains the value and it will be set after command line argument, environment and OCC file processing.

  7. image set commands will no longer return the modified resource

    Previously, modifying an image would result in the new image being displayed to the user. To keep things consistent with other set commands, we will no longer be showing the modified resource.

    • In favor of: Use set then show

    • As of: NA

    • Removed in: NA

    • Bug: NA

    • Commit: NA

  8. region commands no longer support url

    The Keystone team removed support for the url attribute from the client and server side. Changes to the create, set and list commands for regions have been affected.

  9. flavor set/unset commands will no longer return the modified resource

    Previously, modifying a flavor would result in the new flavor being displayed to the user. To keep things consistent with other set/unset commands, we will no longer be showing the modified resource.

  10. security group set commands will no longer return the modified resource

    Previously, modifying a security group would result in the new security group being displayed to the user. To keep things consistent with other set commands, we will no longer be showing the modified resource.

  11. compute agent set commands will no longer return the modified resource

    Previously, modifying an agent would result in the new agent being displayed to the user. To keep things consistent with other set commands, we will no longer be showing the modified resource.

  12. <version> <url> <md5hash> should be optional for command openstack compute agent set

    Previously, the command was openstack compute agent set <id> <version> <url> <md5hash>, whereas now it is: openstack compute agent set <id> –version <version> –url <url> –md5hash <md5hash>.

  13. aggregate set commands will no longer return the modified resource

    Previously, modifying an aggregate would result in the new aggregate being displayed to the user. To keep things consistent with other set commands, we will no longer be showing the modified resource.

  14. Output of ip floating list command has changed.

    When using Compute v2, the original output is:

    # ip floating list

+----+--------+------------+----------+-------------+
| ID | Pool   | IP         | Fixed IP | Instance ID |
+----+--------+-----------------------+-------------+
|  1 | public | 172.24.4.1 | None     | None        |
+----+--------+------------+----------+-------------+

    Now it changes to:

    # ip floating list

+----+---------------------+------------------+-----------+--------+
| ID | Floating IP Address | Fixed IP Address | Server ID | Pool   |
+----+---------------------+------------------+-----------+--------+
|  1 | 172.24.4.1          | None             | None      | public |
+----+---------------------+------------------+-----------+--------+

    When using Network v2, which is different from Compute v2. The output is:

    # ip floating list

+--------------------------------------+---------------------+------------------+------+
| ID                                   | Floating IP Address | Fixed IP Address | Port |
+--------------------------------------+---------------------+------------------+------+
| 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3          | None             | None |
+--------------------------------------+---------------------+------------------+------+

For Developers

If introducing a backwards incompatible change, then add the tag: BackwardsIncompatibleImpact to your git commit message, and if possible, update this file.

To review all changes that are affected, use the following query:

https://review.opendev.org/#/q/project:openstack/python-openstackclient+AND+message:BackwardsIncompatibleImpact,n,z