Bug 1373234

Summary:	[DOCS] Enhancement / Amendment required for OSE Documentation (Ramp node)
Product:	OpenShift Container Platform	Reporter:	Brendan Mchugh <bmchugh>
Component:	Documentation	Assignee:	brice <bfallonf>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Brendan Mchugh <bmchugh>
Severity:	low	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	medium
Version:	3.2.0	CC:	akokshar, aos-bugs, bmchugh, erich, jokerman, mmccomas, rchopra
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-10 01:04: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 Brendan Mchugh 2016-09-05 14:47:47 UTC

Document URL: 
https://docs.openshift.com/enterprise/3.2/install_config/routing_from_edge_lb.html#establishing-a-tunnel-using-a-ramp-node


Section Number and Name: 
Establishing a Tunnel Using a Ramp Node: On the ramp node


Describe the issue: 
Enhancement / Amendment required for OSE Documentation (Ramp node)

The steps which are described for setting the tunnel on the ramp node (https://docs.openshift.com/enterprise/3.2/install_config/routing_from_edge_lb.html#establishing-a-tunnel-using-a-ramp-node) are incomplete and can lead clients to surprises.

Indeed, it is not mentioned anywhere that the sections 3,4 and 5 will not persist a reboot and therefore some manual interventions are required to bring the ramp node back on an operational level. 


Suggestions for improvement: 
It will be wise to amend the documentation worth so as to mention it and also provide an example of using interface configuration files (/etc/sysconfig/network-scripts/ifcfg-tunx). As the system boots, it uses these files to determine what interfaces to bring up and how to configure them.


Additional information:

Comment 2 brice 2016-09-15 04:12:38 UTC

PR made for this:

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

Brendan, could I please get an ack that this fulfills this BZ?

Thanks, much!

Comment 3 Rajat Chopra 2016-09-15 23:34:57 UTC

We probably want to execute this setup script in entirety to have the ramp node come alive properly after a reboot: https://github.com/ramr/openshift-f5-env-setup/blob/master/setup-ramp-node-sdn

Comment 4 Brendan Mchugh 2016-09-26 09:04:07 UTC

Hi,

The doc states to change the /etc/sysconfig/network-scripts/ifcfg-tun<N> file, but then the tunnel is created with "ip".

Shouldn't there be an example of what to put in the ifcfg-tun<N> file?

Regards,

Comment 5 brice 2016-09-26 23:49:54 UTC

Brendan

I did send you an email about this BZ saying that the PR was incorrect and that I'd be following up with an email to sme list. Maybe I should have put the information in here instead.

Rajat and Ram have a script that makes the steps persist. It's going to be written into a KB article. Once it is, we can see what we want to put into the docs. Should be done within the next week.

Comment 6 Eric Rich 2016-09-27 11:01:57 UTC

https://github.com/rajatchopra/f5rampnodekb/blob/master/README.md

Is a detailed write-up of how to persist ramp node configuration changes.

Comment 7 brice 2016-10-10 01:04:14 UTC

With the addition of the KBase article (which I think is OK and I don't think I can add anything to), and the knowledge that this will be fixed by OCP 3.4, I don't think anything needs to be added to the docs. Putting a link into the KBase article will bring up the conversation about putting the procedure into the docs again, so I don't think it's necessary.

I'll put this to closed, and close my PR from above.

Anyone, feel free to let me know if you disagree.

Comment 8 brice 2017-01-10 01:33:15 UTC

*** Bug 1409554 has been marked as a duplicate of this bug. ***