1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
==============================
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.
List of Backwards Incompatible Changes
======================================
1. Rename command `openstack project usage list`
The `project` part of the command was pointless.
* In favor of: `openstack usage list` instead.
* As of: 1.0.2
* Removed in: TBD
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1406654
* Commit: https://review.openstack.org/#/c/147379/
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.
* In favor of: making <type> a positional argument.
* As of: 1.0.2
* Removed in: TBD
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1404073
* Commit: https://review.openstack.org/#/c/143242/
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>`.
* In favor of: Using `openstack security group rule delete <rule>`.
* As of: 1.2.1
* Removed in: NA
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1450872
* Commit: https://review.openstack.org/#/c/179446/
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.
* In favor of: Create multiple images with same name (as glance does).
* As of: 1.5.0
* Removed in: NA
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1461817
* Commit: https://review.openstack.org/#/c/194654/
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.
* In favor of: Create network agent list command in the future
* As of: 1.6.0
* Removed in: NA
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/472613
* Commit: https://review.openstack.org/#/c/194654/
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.
* In favor of: DEFAULT_API_VERSION
* As of: 1.2.1
* Removed in: NA
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1453229
* Commit: https://review.openstack.org/#/c/181514/
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 thr `url` attribute from the client
and server side. Changes to the `create`, `set` and `list` commands for
regions have been affected.
* In favor of: NA
* As of 1.9.0
* Removed in: NA
* Bug: https://launchpad.net/bugs/1506841
* Commit: https://review.openstack.org/#/c/236736/
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.
* In favor of: Use `set/unset` then `show`
* As of: NA
* Removed in: NA
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
* Commit: https://review.openstack.org/#/c/280663/
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.
* In favor of: Use `set` then `show`
* As of: NA
* Removed in: NA
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
* Commit: https://review.openstack.org/#/c/281087/
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.
* In favor of: Use `set` then `show`
* As of: NA
* Removed in: NA
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
* Commit: https://review.openstack.org/#/c/281088/
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.
* In favor of: Use `set` then `show`
* As of: NA
* Removed in: NA
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
* Commit: https://review.openstack.org/#/c/281089/
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.openstack.org/#/q/project:openstack/python-openstackclient+AND+message:BackwardsIncompatibleImpact,n,z
|
