← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 2064708] [NEW] Neutron documentation using real IP addresses and AS numbers instead of example values

 

Public bug reported:

While Neutron seems to generally be using the properly reserved IP
ranges and BGP AS numbers for documentation purposes ([4],[5],[6],[7],
...) at places like [3], there are some docs that contain non-reserved
(read: other people's) AS numbers or IP addresses. See [1], [2] for some
examples, there likely are some more.

Since people tend to use documentation, especially about complex
concepts quite literally to setup their own systems I suggest to run a
sweep through the documentation and replace all occurrences of IP
addresses or AS numbers with the proper example values ([4],[5],[6],[7],
...)



[1] https://docs.openstack.org/neutron/latest/admin/config-bgp-dynamic-routing.html
[2] https://docs.openstack.org/neutron/latest/admin/config-bgp-floating-ip-over-l2-segmented-network.html

[3] https://docs.openstack.org/neutron/latest/admin/config-address-
scopes.html

[4] https://datatracker.ietf.org/doc/rfc5398
[5] https://datatracker.ietf.org/doc/rfc6996

[6] https://datatracker.ietf.org/doc/rfc5737
[7] https://datatracker.ietf.org/doc/rfc3849

** Affects: neutron
     Importance: Undecided
         Status: New

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

Title:
  Neutron documentation using real IP addresses and AS numbers instead
  of example values

Status in neutron:
  New

Bug description:
  While Neutron seems to generally be using the properly reserved IP
  ranges and BGP AS numbers for documentation purposes ([4],[5],[6],[7],
  ...) at places like [3], there are some docs that contain non-reserved
  (read: other people's) AS numbers or IP addresses. See [1], [2] for
  some examples, there likely are some more.

  Since people tend to use documentation, especially about complex
  concepts quite literally to setup their own systems I suggest to run a
  sweep through the documentation and replace all occurrences of IP
  addresses or AS numbers with the proper example values
  ([4],[5],[6],[7], ...)



  
  [1] https://docs.openstack.org/neutron/latest/admin/config-bgp-dynamic-routing.html
  [2] https://docs.openstack.org/neutron/latest/admin/config-bgp-floating-ip-over-l2-segmented-network.html

  [3] https://docs.openstack.org/neutron/latest/admin/config-address-
  scopes.html

  [4] https://datatracker.ietf.org/doc/rfc5398
  [5] https://datatracker.ietf.org/doc/rfc6996

  [6] https://datatracker.ietf.org/doc/rfc5737
  [7] https://datatracker.ietf.org/doc/rfc3849

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