OSDOCS-1496 - Advanced networking tables #25656

bobfuru · 2020-09-22T00:22:14Z

OSDOCS-1496 - Updates the advanced networking table (https://docs.openshift.com/container-platform/4.5/installing/installing_bare_metal/installing-bare-metal-network-customizations.html#installation-user-infra-machines-static-network_installing-bare-metal-network-customizations) to show options that can be added to the live installer boot prompt or the coreos-installer command line.

PREVIEW LINK: Configure advanced networking

Relates to #25709

modules/installation-user-infra-machines-static-network.adoc

openshift-docs-preview-bot · 2020-09-22T00:25:22Z

The preview will be available shortly at:

https://OSDOCS-1496--ocpdocs.netlify.com/

modules/installation-user-infra-machines-static-network.adoc

chrisnegus

LGTM. Thanks Bob!

modules/installation-user-infra-machines-static-network.adoc

sheriff-rh

Nice tables! LGTM! 🎉 🌮 🥇

bobfuru · 2020-09-25T22:36:53Z

This will be merged to master and CP'ed to 4.6 so that it can be viewed and reviewed in the context of it's parent assembly, #25709.

Note that this PR 25656 has been reviewed by @chrisnegus but not reviewed by any other RHCOS SMEs.

bobfuru · 2020-09-25T22:37:18Z

/cherrypick enterprise-4.6

openshift-cherrypick-robot · 2020-09-25T22:37:42Z

@bobfuru: new pull request created: #25813

Details

In response to this:

/cherrypick enterprise-4.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

jlebon · 2020-09-28T14:01:25Z

modules/installation-user-infra-machines-static-network.adoc

+
+a|`coreos.inst.ignition_url`
+
+a|Optional: The URL of the Ignition config. If no URL is specified, no Ignition config will be embedded.


How about

a|Optional: The URL of the Ignition config to embed into the installed system. If no URL is specified, no Ignition config will be embedded.

? To make it clear it's not the Ignition config of the live boot itself.

jlebon · 2020-09-28T14:06:04Z

modules/installation-user-infra-machines-static-network.adoc

+
+a|`coreos.inst.image_url`
+
+a|Optional: Download and install the specified {op-system} image, overriding `coreos.inst.stream`.


Hmm, I'm not sure if it's worth mentioning coreos.inst.stream here since it's not in the table itself, and it's not relevant to RHCOS/OCP. (Possibly OKD... though not sure there either.)

If we want to keep it, maybe let's make it clear that it overrides the default "built-in" image. E.g.

a|Optional: Download and install the specified {op-system} image instead of the one embedded in the live media.

?

Good point. I missed this mention of coreos.inst.stream and agree that it makes sense to remove it here.

jlebon · 2020-09-28T14:09:25Z

modules/installation-user-infra-machines-static-network.adoc

+
+* This argument should not be used in production environments and is intended for debugging purposes only.
+
+* You must use this option if you were already using the previous `coreos-installer`.


You must use this option if you were already using the previous coreos-installer.

I'm wondering if we even need to mention this. Aren't these docs versioned to the OCP version already?

As long as there's nothing that an existing user must actually do here when they upgrade from a previous version of OCP, then I agree it should be left out. Removed.

jlebon · 2020-09-28T14:24:13Z

modules/installation-user-infra-machines-static-network.adoc

+
+a|`coreos.inst.platform_id`
+
+a| Optional: The Ignition platform ID of the platform the {op-system} image is being installed on. Default is bare metal. This option determines whether or not to request an Ignition config from the cloud provider, such as AWS or WMware. For example: `coreos.inst.platform_id=vmware`.


I'm debating whether we should include this at all. It's really a corner-case users shouldn't normally hit. Maybe let's put it near the bottom instead? /cc @bgilbert WDYT?

Also "Default is bare metal" -> "Default is metal" . And WMware -> VMware. I'd also drop the AWS example since it's not relevant for this.

Ack. Fixed the spelling errors and moved to the bottom of the table.

VMware UPI should set this, so I'm +1 to leaving it in the doc.

modules/installation-user-infra-machines-static-network.adoc

bobfuru · 2020-09-30T20:09:11Z

@jlebon Thanks for the review and feedback! This PR had already been merged by the time you submitted your review, so I've addressed your comments in a new PR: #26004. I'm going to get that new PR merged so that the changes are picked up by the overarching coreos-installer assembly in #25709. 🎉

Fixes to PR #25656 - applies SME feedback

…-26004-to-enterprise-4.6 [enterprise-4.6] Fixes to PR #25656 - applies SME feedback

bgilbert

Apologies for the late review.

modules/installation-user-infra-machines-static-network.adoc

bobfuru added the branch/enterprise-4.6 label Sep 22, 2020

bobfuru added this to the Future Release milestone Sep 22, 2020

bobfuru requested a review from chrisnegus September 22, 2020 00:22

openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 22, 2020

bobfuru commented Sep 22, 2020

View reviewed changes

modules/installation-user-infra-machines-static-network.adoc Outdated Show resolved Hide resolved

bobfuru commented Sep 22, 2020

View reviewed changes

modules/installation-user-infra-machines-static-network.adoc Outdated Show resolved Hide resolved

bobfuru commented Sep 22, 2020

View reviewed changes

modules/installation-user-infra-machines-static-network.adoc Outdated Show resolved Hide resolved

bobfuru commented Sep 22, 2020

View reviewed changes

modules/installation-user-infra-machines-static-network.adoc Outdated Show resolved Hide resolved

bobfuru commented Sep 22, 2020

View reviewed changes

modules/installation-user-infra-machines-static-network.adoc Outdated Show resolved Hide resolved

bobfuru commented Sep 22, 2020

View reviewed changes

modules/installation-user-infra-machines-static-network.adoc Outdated Show resolved Hide resolved

bobfuru force-pushed the OSDOCS-1496 branch 11 times, most recently from e043d05 to 93e9005 Compare September 25, 2020 14:45

chrisnegus reviewed Sep 25, 2020

View reviewed changes

modules/installation-user-infra-machines-static-network.adoc Outdated Show resolved Hide resolved

modules/installation-user-infra-machines-static-network.adoc Outdated Show resolved Hide resolved

bobfuru force-pushed the OSDOCS-1496 branch from 93e9005 to 5561264 Compare September 25, 2020 16:06

bobfuru requested review from bgilbert, codyhoag, jlebon and miabbott September 25, 2020 16:17

OSDOCS-1496 - Advanced networking tables

281f70f

bobfuru force-pushed the OSDOCS-1496 branch from 5561264 to 281f70f Compare September 25, 2020 17:37

bobfuru added the peer-review-needed Signifies that the peer review team needs to review this PR label Sep 25, 2020

bobfuru removed request for bgilbert, codyhoag, jlebon and miabbott September 25, 2020 17:43

sheriff-rh approved these changes Sep 25, 2020

View reviewed changes

sheriff-rh added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Sep 25, 2020

bobfuru merged commit c661a85 into openshift:master Sep 25, 2020

bobfuru deleted the OSDOCS-1496 branch September 25, 2020 22:37

openshift-cherrypick-robot mentioned this pull request Sep 25, 2020

[enterprise-4.6] OSDOCS-1496 - Advanced networking tables #25813

Merged

jlebon reviewed Sep 28, 2020

View reviewed changes

bobfuru mentioned this pull request Sep 30, 2020

Fixes to PR #25656 - applies SME feedback #26004

Merged

bobfuru pushed a commit to bobfuru/openshift-docs that referenced this pull request Sep 30, 2020

Fixes to PR openshift#25656 - applies SME feedback

d753b3c

bobfuru pushed a commit that referenced this pull request Sep 30, 2020

Merge pull request #26004 from bobfuru/OSDOCS-1496-v2

bea6d6b

Fixes to PR #25656 - applies SME feedback

openshift-cherrypick-robot pushed a commit to openshift-cherrypick-robot/openshift-docs that referenced this pull request Sep 30, 2020

Fixes to PR openshift#25656 - applies SME feedback

b95ae88

bobfuru pushed a commit that referenced this pull request Sep 30, 2020

Merge pull request #26007 from openshift-cherrypick-robot/cherry-pick…

4eceb77

…-26004-to-enterprise-4.6 [enterprise-4.6] Fixes to PR #25656 - applies SME feedback

bgilbert reviewed Oct 1, 2020

View reviewed changes

bobfuru mentioned this pull request Oct 1, 2020

Fix merge conflict and apply SME feedback #26070

Merged

vikram-redhat modified the milestones: Future Release, OCP 4.6 GA Oct 27, 2020

yuvalk mentioned this pull request Mar 18, 2021

cnf 4.6 references #30640

Closed


		a\|`coreos.inst.ignition_url`

		a\|Optional: The URL of the Ignition config. If no URL is specified, no Ignition config will be embedded.


		a\|`coreos.inst.image_url`

		a\|Optional: Download and install the specified {op-system} image, overriding `coreos.inst.stream`.


		* This argument should not be used in production environments and is intended for debugging purposes only.

		* You must use this option if you were already using the previous `coreos-installer`.


		a\|`coreos.inst.platform_id`

		a\| Optional: The Ignition platform ID of the platform the {op-system} image is being installed on. Default is bare metal. This option determines whether or not to request an Ignition config from the cloud provider, such as AWS or WMware. For example: `coreos.inst.platform_id=vmware`.

OSDOCS-1496 - Advanced networking tables #25656

OSDOCS-1496 - Advanced networking tables #25656

Uh oh!

Conversation

bobfuru commented Sep 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

openshift-docs-preview-bot commented Sep 22, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrisnegus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sheriff-rh left a comment

Choose a reason for hiding this comment

Uh oh!

bobfuru commented Sep 25, 2020

Uh oh!

bobfuru commented Sep 25, 2020

Uh oh!

openshift-cherrypick-robot commented Sep 25, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bobfuru commented Sep 30, 2020

Uh oh!

bgilbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

bobfuru commented Sep 22, 2020 •

edited

Loading