Bug 1893600 - Static IP address assignment in vSphere and /var filesystem in RHCOS 4.6
Summary: Static IP address assignment in vSphere and /var filesystem in RHCOS 4.6
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 4.6.z
Assignee: Bob Furu
QA Contact: Michael Nguyen
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-11-02 05:01 UTC by Avinash Bodhe
Modified: 2024-03-25 16:53 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-01-20 22:01:18 UTC
Target Upstream Version:
Embargoed:
abodhe: needinfo+


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1755047 0 low CLOSED [DOCS] vSphere & baremetal UPI documentation mentions static IP address without more details 2021-02-22 00:41:40 UTC
Red Hat Bugzilla 1819833 0 low CLOSED [DOCS] 4.3 UPI vmware setting static IP documentation 2023-12-15 17:36:37 UTC
Red Hat Bugzilla 1898275 0 high CLOSED [DOC] Improve the documentation for creating a separate /var partition 2024-12-20 19:23:40 UTC
Red Hat Knowledge Base (Solution) 4952011 0 None None None 2021-05-18 16:35:47 UTC

Internal Links: 1819833 1898275

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 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.


Note You need to log in before you can comment on or make changes to this bug.