← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1850818] Re: [RFE][floatingip port_forwarding] Add description field

 

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


** Changed in: neutron
       Status: In Progress => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1850818

Title:
  [RFE][floatingip port_forwarding] Add description field

Status in neutron:
  Fix Released

Bug description:
  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"
     }
  }

To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1850818/+subscriptions


References