Deprecate configurable Hide Server Address Feature

This commit deprecates the config option and policy
for hide server address. They are marked for removal.

Implement blueprint remove-configurable-hide-server-address-feature

Depends-On: I6aed4909b0e7efe9c95d1f7398db613eca05e5ce
Change-Id: I6040e8c2b3e132b0dfd09f82ae041b4786a63483
This commit is contained in:
ghanshyam 2017-12-07 10:12:35 +03:00 committed by Ghanshyam Mann
parent 1f29d4283a
commit 3e329e73e7
3 changed files with 26 additions and 1 deletions

View File

@ -283,6 +283,14 @@ osapi_hide_opts = [
default=[BUILDING],
deprecated_group="DEFAULT",
deprecated_name="osapi_hide_server_address_states",
deprecated_for_removal=True,
deprecated_since="17.0.0",
deprecated_reason="This option hide the server address in server "
"representation for configured server states. "
"Which makes GET server API controlled by this "
"config options. Due to this config options, user "
"would not be able to discover the API behavior on "
"different clouds which leads to the interop issue.",
help="""
This option is a list of all instance states for which network address
information should not be returned from the API.

View File

@ -38,7 +38,14 @@ By default 'addresses' is hidden only when the server is in
'method': 'GET',
'path': '/servers/detail'
}
]),
],
deprecated_for_removal=True,
deprecated_reason=(
'Capability of configuring the server states to hide the '
'address has been deprecated for removal. Now this policy is '
'not needed to control the server address'
),
deprecated_since='17.0.0'),
]

View File

@ -0,0 +1,10 @@
---
deprecations:
- |
The ``hide_server_address_states`` configuration option is now
deprecated for removal. In future, there will be hard coded
server state ``building`` for which server address will be hidden.
The policy 'os_compute_api:os-hide-server-addresses' also is deprecated
for removal. More details `here`_
.. _here: https://specs.openstack.org/openstack/nova-specs/specs/queens/approved/remove-configurable-hide-server-address-feature.html