Files
neutron-lib/neutron_lib/api/definitions/fip_pf_description.py
pedro a37378e8d5 Add description field in port forwarding API
Problem Description
===================

As users create and update theirs floating ip rules, the reason
behind those rules might get lost throughout time. Moreover, in
an environment with many people writing rules, it is important
to track down the reason behind each one of the rules
created/added in a floating IP port forwarding configuration.
The addition of a description field would allow operators to
determine the reason why a rule was created and help the users
to know if the existence of a rule is still reasonable.

Proposed Change
===============

To address the described scenario, we propose to create a new
“description” field in the Neutron’s Floating IP port forwarding
rules API JSON. This new field will be a nullable String
containing the description/reason why this new port forwarding
rule is being created.

Change-Id: If98a70011b187d2143a660f1f281ab197d21eb4d
Implements: blueprint portforwarding-description
Closes-Bug: #1850818
2019-11-27 08:47:58 -03:00

42 lines
1.6 KiB
Python

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from neutron_lib.api.definitions import floating_ip_port_forwarding as pfw
from neutron_lib.db import constants as db_const
DESCRIPTION_FIELD = "description"
ALIAS = 'floating-ip-port-forwarding-description'
IS_SHIM_EXTENSION = False
IS_STANDARD_ATTR_EXTENSION = False
NAME = 'Floating IP Port Forwarding new attribute description'
DESCRIPTION = 'Add a description field to Port Forwarding rules'
UPDATED_TIMESTAMP = '2019-11-01T10:00:00-00:00'
RESOURCE_ATTRIBUTE_MAP = {
pfw.COLLECTION_NAME: {
DESCRIPTION_FIELD: {'allow_post': True,
'allow_put': True,
'validate': {
'type:string':
db_const.LONG_DESCRIPTION_FIELD_SIZE},
'is_visible': True,
'is_sort_key': False,
'is_filter': True,
'default': ''}
}
}
SUB_RESOURCE_ATTRIBUTE_MAP = {}
ACTION_MAP = {}
REQUIRED_EXTENSIONS = [pfw.ALIAS]
OPTIONAL_EXTENSIONS = []
ACTION_STATUS = {}