Bug 1893600

Summary:	Static IP address assignment in vSphere and /var filesystem in RHCOS 4.6
Product:	OpenShift Container Platform	Reporter:	Avinash Bodhe <abodhe>
Component:	Documentation	Assignee:	Bob Furu <bfuru>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Michael Nguyen <mnguyen>
Severity:	high	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	high
Version:	4.6	CC:	agudi, aos-bugs, bfuru, jokerman, oarribas, rh-container, vigoyal
Target Milestone:	---	Keywords:	Reopened
Target Release:	4.6.z	Flags:	abodhe: needinfo+
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:	2021-01-20 22:01:18 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 Avinash Bodhe 2020-11-02 05:01:01 UTC

Document URL: 
[1]: https://docs.openshift.com/container-platform/4.6/release_notes/ocp-4-6-release-notes.html#ocp-4-6-static-ip-config-with-ova


Section Number and Name: 


Describe the issue: 
I found the documentation[1] for Static IP configuration for vSphere and also it is mentioned that the /var partitions now supported in RHCOS 4.6. Below details are available in the release notes page rather than a particular section of the component.

~~~
	export IPCFG="ip=<ip>::<gateway>:<netmask>:<hostname>:<iface>:none nameserver=srv1 [nameserver=srv2 [nameserver=srv3 [...]]]"

	govc vm.change -vm "<vm_name>" -e "guestinfo.afterburn.initrd.network-kargs=${IPCFG}"
~~~


Suggestions for improvement: 
Can we put the static IP and details of /var filesystem in the vsphere chapters rather than release notes?

Why do you put a general disk topic (separate /var) ONLY into the bare metal chapter? This applies to ALL platforms!

The documentation of the "separate /var" feature is unclear about whether or not it is possible to add more than one disk/partition to RHCOS.
Sometimes the doc is talking about partitions, in other parts about disks. We should make clearer what is possible and what isn't.


Additional information: 
This is the customer's request to update the documentation properly as it makes confusion with the exact information.

Comment 3 Bob Furu 2020-12-02 22:07:18 UTC

Hello Avinash,

Thank you for raising this concern. Since the time that this bug was reported, we have begun addressing the most critical aspect in regards to documenting the Static IP config details in vSphere docs and not just 4.6 release notes. This work is in final review and should be merged soon via https://github.com/openshift/openshift-docs/pull/27394.

I have also created a separate PR (https://github.com/openshift/openshift-docs/pull/27810) with a small attempt to clarify partitions/nodes where I thought it might help. I'm uncertain whether OCP supports adding more than one disk/partition to RHCOS with separate /var partitioning, so I'm awaiting SME feedback.

Lastly, it is asked: "Why do you put a general disk topic (separate /var) ONLY into the bare metal chapter? This applies to ALL platforms!"

My understanding is that this feature is recommended only for bare metal installs but I'm also seeking SME feedback on this question.

Moving to ON_QA.

Comment 9 Bob Furu 2020-12-07 19:18:28 UTC

PR has been approved by Dev/QE, waiting for peer review before merging.

Comment 10 Bob Furu 2020-12-07 22:16:28 UTC

https://github.com/openshift/openshift-docs/pull/27810 has been merged and cherry-picked to OCP 4.6, 4.7. Waiting to resolve a question in https://github.com/openshift/openshift-docs/pull/27394 before I merge and close this BZ and related https://bugzilla.redhat.com/show_bug.cgi?id=1898275.

Comment 11 Bob Furu 2020-12-09 18:54:28 UTC

https://github.com/openshift/openshift-docs/pull/27394 merged and CP'ed to 4.6, 4.7. Waiting to confirm changes are live on docs.openshift.com before closing this BZ. Also, closed related BZ https://bugzilla.redhat.com/show_bug.cgi?id=1898275.

Comment 12 Bob Furu 2020-12-09 20:10:39 UTC

Docs verified live on docs.openshift.com. 

vSphere UPI install docs:
- https://docs.openshift.com/container-platform/4.6/installing/installing_vsphere/installing-vsphere.html#installation-vsphere-machines_installing-vsphere
- https://docs.openshift.com/container-platform/4.6/installing/installing_vsphere/installing-vsphere-network-customizations.html#installation-vsphere-machines_installing-vsphere-network-customizations
- https://docs.openshift.com/container-platform/4.6/installing/installing_vsphere/installing-restricted-networks-vsphere.html#installation-vsphere-machines_installing-restricted-networks-vsphere

Bare metal install docs:
- https://docs.openshift.com/container-platform/4.6/installing/installing_bare_metal/installing-bare-metal.html#installation-user-infra-machines-iso_installing-bare-metal
- https://docs.openshift.com/container-platform/4.6/installing/installing_bare_metal/installing-bare-metal-network-customizations.html#installation-user-infra-machines-iso_installing-bare-metal-network-customizations
- https://docs.openshift.com/container-platform/4.6/installing/installing_bare_metal/installing-restricted-networks-bare-metal.html#installation-user-infra-machines-iso_installing-restricted-networks-bare-metal

Closing BZ.

Comment 13 Bob Furu 2021-01-04 18:37:11 UTC

Reopening this BZ as I have been asked to also provide the instructions for creating a separate /var partition in other UPI install docs:

- CloudFormation templates for AWS: 
https://docs.openshift.com/container-platform/4.6/installing/installing_aws/installing-aws-user-infra.html
10:57

- ARM templates for Azure https://docs.openshift.com/container-platform/4.6/installing/installing_azure/installing-azure-user-infra.html
10:57

- Deployment Manager templates for GCP: 
https://docs.openshift.com/container-platform/4.6/installing/installing_gcp/installing-gcp-user-infra.html

Cc: @agudi

Comment 14 Bob Furu 2021-01-04 19:39:44 UTC

Created https://github.com/openshift/openshift-docs/pull/28329 to add the /var partitioning procedure to UPI cloud provider docs.

Comment 15 Bob Furu 2021-01-20 18:14:10 UTC

 SME/QE and peer reviewed. Merging content and cherrypicking to 4.6, 4.7.

Comment 16 Bob Furu 2021-01-20 22:01:18 UTC

Published on docs.openshift.com in UPI cloud provider docs in 4.6, 4.7. For example:
https://docs.openshift.com/container-platform/4.7/installing/installing_aws/installing-aws-user-infra.html#installation-disk-partitioning-upi-templates_installing-aws-user-infra
https://docs.openshift.com/container-platform/4.6/installing/installing_aws/installing-aws-user-infra.html#installation-disk-partitioning-upi-templates_installing-aws-user-infra

Closing BZ.