From 713f3e5b54f41724010ce47f1d8741052ef1d70f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Weing=C3=A4rtner?= Date: Thu, 13 Aug 2020 08:50:26 -0300 Subject: [PATCH] Deprecate 'remote_ip_prefix' parameter in metering label rules The parameter 'remote_ip_prefix' in metering label rules has been deprecated. Its name expresses the opposite of what does when used, and the lack of documentation confuses people. Moreover, an alternative method has been proposed and approved to enable operators to create metering rules using both source and destination IP addresses. The parameter will be removed in future releases. Partially-Implements: https://bugs.launchpad.net/neutron/+bug/1889431 RFE: https://bugs.launchpad.net/neutron/+bug/1889431 Depends-On: https://review.opendev.org/#/c/744702/ Change-Id: I2dc248d816298bee9461a35cacbc498c6452de76 --- api-ref/source/v2/metering.inc | 2 +- api-ref/source/v2/parameters.yaml | 8 +++++--- ...p_prefix-in-metering-label-rules-308b3d430bc213b3.yaml | 8 ++++++++ 3 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 releasenotes/notes/deprecate-remote_ip_prefix-in-metering-label-rules-308b3d430bc213b3.yaml diff --git a/api-ref/source/v2/metering.inc b/api-ref/source/v2/metering.inc index cef0d2914..a570f1cb2 100644 --- a/api-ref/source/v2/metering.inc +++ b/api-ref/source/v2/metering.inc @@ -292,7 +292,7 @@ The response body shows this information for each metering label rule: - The ID for the metering label rule. -- The remote IP prefix. +- The remote IP prefix (deprecated). - The metering label ID for the metering label with which the rule is associated. diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index 69a0255a9..b7a32b1ec 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -734,8 +734,9 @@ metering_label_rule-direction-query: type: string metering_label_rule-remote_ip_prefix-query: description: | - Filter the metering rule list result by the remote IP prefix that - the metering rule associates with. + (deprecated) Filter the metering rule list result by the source IP prefix + that the metering rule associates with. By source IP prefix, we mean, + the internal/private IPs used in OpenStack. in: query required: false type: string @@ -3839,7 +3840,8 @@ metering_label_rule-id: type: string metering_label_rule-remote_ip_prefix: description: | - The remote IP prefix that is matched by this metering rule. + (deprecated) The source IP prefix that is matched by this metering rule. By + source IP prefix, we mean, the internal/private IPs used in OpenStack. in: body required: true type: string diff --git a/releasenotes/notes/deprecate-remote_ip_prefix-in-metering-label-rules-308b3d430bc213b3.yaml b/releasenotes/notes/deprecate-remote_ip_prefix-in-metering-label-rules-308b3d430bc213b3.yaml new file mode 100644 index 000000000..bf1eed45c --- /dev/null +++ b/releasenotes/notes/deprecate-remote_ip_prefix-in-metering-label-rules-308b3d430bc213b3.yaml @@ -0,0 +1,8 @@ +--- +deprecations: + - | + The parameter 'remote_ip_prefix' in metering label rules has been + deprecated. Its name expresses the opposite of what does when used, + and the lack of documentation confuses people. Moreover, an alternative + method has been proposed and approved to enable operators to create + metering rules using both source and destination IP addresses. \ No newline at end of file