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.
Replace Display Name by Name in volume list.
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.
The network create command now requires the --subnet option when used with Nova-network clouds.
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>.
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.
The project part of the command was pointless.
In favor of: openstack usage list instead.
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.
In favor of: making <type> a positional argument.
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> .
In favor of: Using openstack security group rule delete <rule> .
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.
In favor of: Create multiple images with same name (as glance does).
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.
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.
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.
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.
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.
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.
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.
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> .
In favor of: making <version> <url> <md5hash> optional.
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.
Output of ip floating list command has changed.
If introducing a backwards incompatible change, then add the tag: BackwardsIncompatibleImpact to your git commit message, and if possible, update this file.