Bug 1591941 Added footnotes about cidr range for egress_source value

[bfallonf]

For: https://bugzilla.redhat.com/show_bug.cgi?id=1591941

Will verify in the BZ.

[danwinship]

I think it would probably be better to change the examples to use the CIDR form, because it's not really that hard for the user to do, and it results in fewer surprises.

So change the EGRESS_SOURCE value above in the yaml to 192.168.12.99/24, and then change the footnote here to something like:

IP address from the physical network that the node is on and is reserved by the cluster administrator for use by this pod. For best results, the IP address should include the subnet length (eg, the /24 here) so that a proper route to the local subnet can be set up. (If you do not include a subnet length then the egress router will not be able to access other hosts on its subnet, besides the EGRESS_GATEWAY host.)

Then in the following examples that don't currently have EGRESS_SOURCE footnotes, just add the /24, and in the ones that do have EGRESS_SOURCE footnotes, copy the same text as you put here

[bfallonf]

Thanks, @danwinship . I've updated to your suggestion, with a bit of rewording (mainly to get away from the brackets and to highlight the optional-but-recommended-ness of it). If you have more thoughts, please let me know.

@openshift/team-documentation PTAL

[kalexand-rh]

A couple of style picks and suggestions, including one for a line you didn't actually change (sorry!). This sounds good. :)

[kalexand-rh]

I'd s/and is reserved/and that is reserved

[kalexand-rh]

To avoid parentheses, s/length (the /24)/length, the /24 suffix,
s/set up/set

[kalexand-rh]

s/host/host that is
no comma

[kalexand-rh]

same here :)

[kalexand-rh]

I might move the annotation up to the same line as EGRESS_DESTINATION and say something like "<2> Provide EGRESS_DESTINATION values as multi-line YAML string. Use the following formats:
ul goes here"

[bfallonf]

/cherrypick enterprise-3.10

[openshift-cherrypick-robot]

@bfallonf: new pull request created: #10764

Details

In response to this:

/cherrypick enterprise-3.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[bfallonf]

/cherrypick enterprise-3.9

[openshift-cherrypick-robot]

@bfallonf: #10591 failed to apply on top of branch "enterprise-3.9":

error: Failed to merge in the changes.
Using index info to reconstruct a base tree...
M	admin_guide/managing_networking.adoc
Falling back to patching base and 3-way merge...
Auto-merging admin_guide/managing_networking.adoc
CONFLICT (content): Merge conflict in admin_guide/managing_networking.adoc
Patch failed at 0001 added footnotes about cidr range for egress_source value

Details

In response to this:

/cherrypick enterprise-3.9

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.