← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1793285] [NEW] Networking API v2.0 in neutron-lib: incorrect ''port_range_max" description for ICMP protocol

 

Public bug reported:

The current 'port_range_max' attribute description for security group
rules is misaligned with the implementation, when the protocol is ICMP.

It currently states 'If the protocol is ICMP, this value must be an ICMP
type', when the neutron implementation uses the 'port_range_max'
security group rules attribute as ICMP code.

This claim can be verified below:

https://github.com/openstack/neutron/blob/master/neutron/agent/linux/openvswitch_firewall/rules.py#L275

This bug tracker is for errors with the documentation, use the following
as a template and remove or add fields as you see fit. Convert [ ] into
[x] to check boxes:

- [x] I have a fix to the document that I can paste below including
example: input and output.

Update from:
  'If the protocol is ICMP, this value must be an ICMP type'
To:
  'If the protocol is ICMP, this value must be an ICMP code'

-----------------------------------
Release: 1.18.1.dev58 on 2018-09-19 01:14
SHA: bede7826300884fba1a64aae3b807ccbb419b5ca
Source: https://git.openstack.org/cgit/openstack/neutron-lib/tree/api-ref/source/v2/index.rst
URL: https://developer.openstack.org/api-ref/network/v2/

** Affects: neutron
     Importance: Undecided
         Status: New


** Tags: api-ref

** Description changed:

  The current 'port_range_max' attribute description for security group
  rules is misaligned with the implementation, when the protocol is ICMP.
  
  It currently states 'If the protocol is ICMP, this value must be an ICMP
  type', when the neutron implementation uses the 'port_range_max'
  security group rules attribute as ICMP code.
  
  This claim can be verified below:
  
  https://github.com/openstack/neutron/blob/master/neutron/agent/linux/openvswitch_firewall/rules.py#L275
  
  This bug tracker is for errors with the documentation, use the following
  as a template and remove or add fields as you see fit. Convert [ ] into
  [x] to check boxes:
  
- - [ ] This doc is inaccurate in this way: ______
- - [ ] This is a doc addition request.
- - [x] I have a fix to the document that I can paste below including example: input and output. 
+ - [x] I have a fix to the document that I can paste below including
+ example: input and output.
  
  Update from:
-   'If the protocol is ICMP, this value must be an ICMP type'
+   'If the protocol is ICMP, this value must be an ICMP type'
  To:
-   'If the protocol is ICMP, this value must be an ICMP code'
- 
- If you have a troubleshooting or support issue, use the following
- resources:
- 
-  - Ask OpenStack: http://ask.openstack.org
-  - The mailing list: http://lists.openstack.org
-  - IRC: 'openstack' channel on Freenode
+   'If the protocol is ICMP, this value must be an ICMP code'
  
  -----------------------------------
  Release: 1.18.1.dev58 on 2018-09-19 01:14
  SHA: bede7826300884fba1a64aae3b807ccbb419b5ca
  Source: https://git.openstack.org/cgit/openstack/neutron-lib/tree/api-ref/source/v2/index.rst
  URL: https://developer.openstack.org/api-ref/network/v2/

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

Title:
  Networking API v2.0 in neutron-lib: incorrect ''port_range_max"
  description  for ICMP protocol

Status in neutron:
  New

Bug description:
  The current 'port_range_max' attribute description for security group
  rules is misaligned with the implementation, when the protocol is
  ICMP.

  It currently states 'If the protocol is ICMP, this value must be an
  ICMP type', when the neutron implementation uses the 'port_range_max'
  security group rules attribute as ICMP code.

  This claim can be verified below:

  https://github.com/openstack/neutron/blob/master/neutron/agent/linux/openvswitch_firewall/rules.py#L275

  This bug tracker is for errors with the documentation, use the
  following as a template and remove or add fields as you see fit.
  Convert [ ] into [x] to check boxes:

  - [x] I have a fix to the document that I can paste below including
  example: input and output.

  Update from:
    'If the protocol is ICMP, this value must be an ICMP type'
  To:
    'If the protocol is ICMP, this value must be an ICMP code'

  -----------------------------------
  Release: 1.18.1.dev58 on 2018-09-19 01:14
  SHA: bede7826300884fba1a64aae3b807ccbb419b5ca
  Source: https://git.openstack.org/cgit/openstack/neutron-lib/tree/api-ref/source/v2/index.rst
  URL: https://developer.openstack.org/api-ref/network/v2/

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


Follow ups