Bug 1870710

Summary:	Understanding Networking topic content is incomplete
Product:	OpenShift Container Platform	Reporter:	Kirsten Newcomer <knewcome>
Component:	Documentation	Assignee:	Jason Boxman <jboxman>
Status:	CLOSED DEFERRED	QA Contact:	Xiaoli Tian <xtian>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	4.8	CC:	aos-bugs, jboxman
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:	2023-03-09 00:59:01 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:
Embargoed:

Description Kirsten Newcomer 2020-08-20 16:07:35 UTC

Document URL: https://docs.openshift.com/container-platform/4.5/networking/understanding-networking.html

Section Number and Name: Understanding Networking

Describe the issue: content is incomplete

Suggestions for improvement: Love that we have this top level topic. However, more topics need to be added. Currently it mentions that pods need to talk to each other and describes OCP DNS. But it doesn't mention that all kube clusters require an SDN. It doesn't mention Kube CNII and it doesn't mention anything about cluster ingress or egress. We have detailed content in additional topics. The Undertanding Networking page should have a high level intro to all major elements of OCP networking, with links to the detailed pages. 

Additional information:

Comment 1 Jason Boxman 2020-09-15 01:46:23 UTC

I couldn't agree more; I've been mulling over this for quite some time, but always there is the new feature documentation work to contend with. I'd like to tackle this during the 4.7 timeframe, if possible.

Comment 2 Jason Boxman 2020-11-06 20:57:56 UTC

I've created a Google doc that begins to assemble this information, but as of yet it is far from complete.

Comment 6 Shiftzilla 2023-03-09 00:59:01 UTC

OpenShift has moved to Jira for its defect tracking! This bug can now be found in the OCPBUGS project in Jira.

https://issues.redhat.com/browse/OCPBUGS-8792