Bug 1395776

Summary: [DOCS] Document Flannel networking configuration
Product: OpenShift Container Platform Reporter: Eric Rich <erich>
Component: DocumentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED CURRENTRELEASE QA Contact: Yan Du <yadu>
Severity: urgent Docs Contact: Vikram Goyal <vigoyal>
Priority: medium    
Version: 3.3.0CC: aos-bugs, bmeng, erich, jokerman, mmccomas, yadu
Target Milestone: ---Keywords: NeedsTestCase
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: 2017-03-21 03:28:19 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 Eric Rich 2016-11-16 16:03:26 UTC
Document URL: https://docs.openshift.com/container-platform/3.3/install_config/install/advanced_install.html

https://docs.openshift.com/container-platform/3.3/architecture/additional_concepts/sdn.html

Section Number and Name: Install and overview of SDN 

Describe the issue: 

We do not document a 3rd SDN option for customers, where in flannel can be used, to as an alternative to our ovs-subnet option.

We don't document install options for: 

openshift_use_flannel: <bool> 
flannel_interface: <intf>

Suggestions for improvement: Document install options for setting up this configuration and document the pros/cons to this configuration and why you might want it in some deployment scenarios. 

Additional information: 

https://access.redhat.com/articles/2743631
https://access.redhat.com/sites/default/files/attachments/ocp-on-osp.pdf

Comment 2 Dan Macpherson 2017-01-17 06:33:04 UTC
PR for Flannel documentation:
https://github.com/openshift/openshift-docs/pull/3477

Comment 3 Dan Macpherson 2017-01-17 06:34:32 UTC
@eric -- See the PR in comment #2. Was there anything further I should add to the documentation regarding flannel?

Comment 4 Eric Rich 2017-01-17 14:56:22 UTC
(In reply to Dan Macpherson from comment #3)
> @eric -- See the PR in comment #2. Was there anything further I should add
> to the documentation regarding flannel?

Dan, the only problem I see with these docs is that they don't aling with our test case. 

https://tcms.engineering.redhat.com/case/536005/ 

> Setting the `*openshift_use_openshift_sdn*` variable to false disables the default SDN

^^ This is not set in our test cases, so I wonder if the test cases need to be updated as a result?

Comment 5 Dan Macpherson 2017-01-17 16:10:05 UTC
Good question, but probably not one I can answer. From what I understood, the openshift_use_openshift_sdn Ansible variable sets OpenShift to use OVS (and it's set to true by default). If using flannel (via openshift_use_flannel) instead of OVS, my understanding is that you have to disable OVS.

There's an example in the OCP on OSP ref arch PDF. The example is on page 48 in the group_vars file example.

Comment 6 Eric Rich 2017-01-17 19:01:26 UTC
(In reply to Dan Macpherson from comment #5)
> Good question, but probably not one I can answer. From what I understood,
> the openshift_use_openshift_sdn Ansible variable sets OpenShift to use OVS
> (and it's set to true by default). If using flannel (via
> openshift_use_flannel) instead of OVS, my understanding is that you have to
> disable OVS.
> 
> There's an example in the OCP on OSP ref arch PDF. The example is on page 48
> in the group_vars file example.

I think what we have in our docs is good/better than what QE is using in the test case. So I don't want to suggest us changing that! 

However out docs and QE test cases should align (as much as possible), and as such we really should work with QE on this to make sure the configuration we are documenting is correct.

Comment 7 Dan Macpherson 2017-01-18 02:50:51 UTC
Is there someone on the QE team we should speak to about testing it?

Comment 8 Meng Bo 2017-01-18 03:18:32 UTC
(In reply to Dan Macpherson from comment #7)
> Is there someone on the QE team we should speak to about testing it?

Assigned this bug to @yadu

Comment 17 Vikram Goyal 2017-03-16 06:53:04 UTC
The original requirement of this bug has been fulfilled. I am going to put this on release pending and it will be live next week.

https://github.com/openshift/openshift-docs/pull/3477
and
https://github.com/openshift/openshift-docs/pull/3743

Please open a new bug if further discussions are required.