[RFE][floatingip port_forwarding] Add description field

[Pedro Henrique Pereira Martins]

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.

Example of a modified JSON:

{
   "port_forwarding":{
      "protocol":"tcp",
      "internal_ip_address":"172.16.0.7",
      "internal_port":2230,
      "internal_port_id":"b67a7746-dc69-45b4-9b84-bb229fe198a0",
      "external_port":2230,
      "description":"Some description"
   }
}

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/692580

[Slawek Kaplonski (slaweq)]

Thx for reporting this rfe. I think this is pretty clear and is ready to be discussed on drivers team meeting.
One thing, did You consider to just add Standard Attributes to this resource? See https://github.com/openstack/neutron-lib/blob/master/neutron_lib/db/standard_attr.py for details

[Pedro Henrique Pereira Martins (pedrohpmartins)]

Hi Slawek, thx for the reply.

Could you tell me when the drivers team meeting will occur?

[Rodolfo Alonso (rodolfo-alonso-hernandez)]

http://eavesdrop.openstack.org/#Neutron_drivers_Meeting

But maybe this Friday this meeting will be cancelled due to the OpenStack PTG.

[Slawek Kaplonski (slaweq)]

Yes, this week meeting is cancelled. See http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010470.html
We will resume this meetings on November 15th

[Slawek Kaplonski (slaweq)]

Hi,

We discussed this RFE on today's drivers meeting (http://eavesdrop.openstack.org/meetings/neutron_drivers/2019/neutron_drivers.2019-11-15-14.01.log.html#l-95) and we approved it. So feel free to continue work on implementation of this RFE in Neutron :)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/692580
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=a37378e8d50e074667a55784758790b2929d75a6
Submitter: Zuul
Branch: master

commit a37378e8d50e074667a55784758790b2929d75a6
Author: pedro <email address hidden>
Date: Thu Oct 31 17:09:14 2019 -0300

    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

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron-lib 1.30.0 release.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/670930
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=06e43dd95d39af5c77f60bf7c89fee762c1afa13
Submitter: Zuul
Branch: master

commit 06e43dd95d39af5c77f60bf7c89fee762c1afa13
Author: Pedro Henrique <email address hidden>
Date: Sun Jul 14 17:51:09 2019 -0300

    Add description field to portforwarding NAT rules

    Add the `description` field to `PortForwardings`
    using the standard attributes like in the
    `FloatingIPs`.

    Depends-On: https://review.opendev.org/#/c/692580/
    Depends-On: https://review.opendev.org/#/c/698662/
    Implements: blueprint portforwarding-description
    Closes-Bug: #1850818
    Change-Id: Ibac91d24da2b82cdce72165d1295fa5d4475ffd3
    Signed-off-by: Pedro Martins <email address hidden>

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron 16.0.0.0b1 development milestone.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstacksdk 0.44.0 release.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/train
Review: https://review.opendev.org/750650

[OpenStack Infra (hudson-openstack)]

Change abandoned by Flavio Fernandes (<email address hidden>) on branch: stable/train
Review: https://review.opendev.org/750650