Network address translation in Neutron wrong RFC in documentation

[John-Paul Robinson]

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] This doc is inaccurate in this way:

Shouldn't it be RFC1918 which defines private IP address ranges on networks instead of RFC5737 which defines private ranges for use in documentation?

RFC 5737 reserves the following three subnets as private addresses:

    192.0.2.0/24
    198.51.100.0/24
    203.0.113.0/24

- [ ] This is a doc addition request.
- [x] I have a fix to the document that I can paste below including example:

RFC 1918 reserves the following three subnets as private addresses:

     10.0.0.0/8
     172.16.0.0/12
     192.168.0.0/16

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

-----------------------------------
Release: 11.0.6.dev66 on 2018-08-13 11:52
SHA: b87eb4814a1a936844a0dbd726e7cd9a0de5b492
Source: https://git.openstack.org/cgit/openstack/neutron/tree/doc/source/admin/intro-nat.rst
URL: https://docs.openstack.org/neutron/pike/admin/intro-nat.html

[John-Paul Robinson (jprorama)]

Tried to submit a patch via gerrit but kept getting

neutron$ git review
fatal: remote error: access denied or repository not exported: /openstack/neutron

Here's the patch for the proposed change:

diff --git a/doc/source/admin/intro-nat.rst b/doc/source/admin/intro-nat.rst
index d700a1d..186f695 100644
--- a/doc/source/admin/intro-nat.rst
+++ b/doc/source/admin/intro-nat.rst
@@ -27,12 +27,12 @@ address of the sender in IP packets. SNAT is commonly used to enable
 hosts with *private addresses* to communicate with servers on the
 public Internet.

-`RFC 5737 <https://tools.ietf.org/rfc/rfc5737>`_
+`RFC 1918 <https://tools.ietf.org/rfc/rfc1918>`_
 reserves the following three subnets as private addresses:

-* ``192.0.2.0/24``
-* ``198.51.100.0/24``
-* ``203.0.113.0/24``
+* ``10.0.0.0/8``
+* ``172.16.0.0/12``
+* ``192.168.0.0/16``

 These IP addresses are not publicly routable, meaning that a host on the public
 Internet can not send an IP packet to any of these addresses. Private IP

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/596495

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/596495
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=3e1512873ad1fa7ad60a295ef86cefd3ac8c25f8
Submitter: Zuul
Branch: master

commit 3e1512873ad1fa7ad60a295ef86cefd3ac8c25f8
Author: John-Paul Robinson <email address hidden>
Date: Fri Aug 24 15:18:56 2018 -0500

    Fix the RFC and private internet network address

    It seems the RFC should be 1918 which defines IP addresses for private
    networks.

    The existing RFC 5737 actually defines private IP ranges for use in
    documentation.

    Change-Id: Ic794585e636bb9a9c915347a801c8a4f0baa9012
    Closes-Bug: 1788936

[OpenStack Infra (hudson-openstack)]

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

[Andreas Jaeger (jaegerandi)]

André Luis Penteado, why do you think openstack-manuals is affected as well?

[André Luis Penteado (alpente)]

You can see the bug at
Neutron's documentation [1]
  -> OpenStack Networking Guide
  -> Introduction
  -> Network address translation [2]
  -> "SNAT"

It's in the documentation so I thought openstack-manuals was the right choice.

[1] https://docs.openstack.org/neutron/rocky/index.html
[2] https://docs.openstack.org/neutron/rocky/admin/intro-nat.html