openstack/neutron-lib
Code Issues Proposed changes

Deprecate 'remote_ip_prefix' parameter in metering label rules

Browse Source 
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
This commit is contained in:
Rafael Weingärtner 2020-08-13 08:50:26 -03:00
parent 96e1d028b8
commit 713f3e5b54
3 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/v2/metering.inc
View File

@ -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.

8
api-ref/source/v2/parameters.yaml
View File

@ -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

8
releasenotes/notes/deprecate-remote_ip_prefix-in-metering-label-rules-308b3d430bc213b3.yaml Normal file
View File

@ -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.