Bug 1381292

Summary: [DOCS] Add a disclaimer to avoid configuring services network as 172.17.0.1/16
Product: OpenShift Container Platform Reporter: Eduardo Minguez <eminguez>
Component: DocumentationAssignee: brice <bfallonf>
Status: CLOSED CURRENTRELEASE QA Contact: Eduardo Minguez <eminguez>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: low    
Version: 3.3.0CC: aos-bugs, eminguez, jokerman, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-10-28 00:05:14 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Eduardo Minguez 2016-10-03 15:24:35 UTC
Document URL: https://docs.openshift.com/container-platform/3.3/install_config/install/advanced_install.html#configuring-cluster-variables

Section Number and Name: Advanced installation / Configuring Cluster Variables

Describe the issue: The default docker0 bridge uses the 172.17.0.1/16 network by default, so if you configure OCP to use that address, the installation fails when spinning up the SDN

Suggestions for improvement: Just add a note about not using that address or how to modify docker to use other network address.

Additional information: https://docs.docker.com/engine/userguide/networking/

Comment 1 brice 2016-10-06 05:35:21 UTC
Eduardo,

I've added a note box to the suggested section:

https://github.com/openshift/openshift-docs/pull/3004

Is the problem with a specific variable? I feel like it would be better placed within the table. Do you think there's a possible better placement for the note box?

Thanks!

Comment 2 Eduardo Minguez 2016-10-06 07:00:36 UTC
The variable is "openshift_master_portal_net", so I'd say it would be better to move it where the variable description is.
Any case, the box should say that by default, the docker0 network is that ip, but you can change it if you want but that's unsupported (in case it is) or the procedure to do it.

Thx!

Comment 3 brice 2016-10-11 06:25:09 UTC
Eduardo,

Turns out there was something similar in the varible space already. I tweaked it to mention what you wanted included.

Can I get an ack that this fulfills this BZ?

https://github.com/openshift/openshift-docs/pull/3004/files

Thanks!

Comment 4 Eduardo Minguez 2016-10-11 07:23:22 UTC
The thing is, the default docker0 network is the 172.17.0.1/16. I'd say:

+xref:../../architecture/additional_concepts/sdn.adoc#architecture-additional-concepts-sdn[{product-title}
+SDN]. This network block should be private and must not conflict with any
+existing network blocks in your infrastructure to which pods, nodes, or the
+master may require access to, or the installation will fail. Defaults to
+*172.30.0.0/16*, and *cannot* be re-configured after deployment.
+Please note that the *docker0* network bridge uses 172.16.0.0/16 by default,
+and you should avoid that too, or modify the docker0 network.

Cheers

Comment 5 brice 2016-10-12 03:02:41 UTC
Eduardo,

Oops sorry. I'm a writer, so it might go without saying that all numbers look that same to me..

I've fixed to pretty much your suggestion, with a little rewording. WDYT?

https://github.com/openshift/openshift-docs/pull/3004/files

Comment 6 Eduardo Minguez 2016-10-13 09:11:52 UTC
LGTM. Thx Brice!

Comment 7 openshift-github-bot 2016-10-17 01:27:17 UTC
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/3a39584afb19353a437a6186b665c363b6f89ff8
Merge pull request #3004 from bfallonf/network_138192

Bug 1381292 added note box to advanced install