Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OSDOCS-12787: iSCSI booting for Agent #88177

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

skopacz1
Copy link
Contributor

@skopacz1 skopacz1 commented Feb 6, 2025

OSDOCS-12787

Version(s): 4.18+

This PR documents the generic support for iSCSI booting using resources generated by the Agent-based Installer.

QE review:

  • QE has approved this change.

Previews:

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Feb 6, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Feb 6, 2025

@skopacz1: This pull request references OSDOCS-12787 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.19.0" version, but no target version was set.

In response to this:

OSDOCS-12787

Version(s): 4.18+

This PR documents the generic support for iSCSI booting using resources generated by the Agent-based Installer.

QE review:

  • QE has approved this change.

Preview:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 6, 2025
Comment on lines -39 to -43
+
[NOTE]
====
This is the preferred method for the Agent-based installation. Using {ztp} manifests is optional.
====
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tracked down the creation of this note to this comment thread here. It doesn't make sense to place this note under the step for creating the installation directory, and not specifying what "this" preferred method is seems confusing.

So I moved this note to this section's description. Considering that, since adding this note, I've renamed this procedure to mention "preferred inputs" anyways, I could even delete the note entirely. I'll leave that up to SME and QE to decide.

Comment on lines +43 to +44
set initiator-iqn <iscsi_initiator_base>:\${hostname}
sanboot --keep iscsi:<iscsi_network_subnet>.1::::$<iscsi_initiator_base>:\${hostname}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need example values here for the initiator base and subnet

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is an example:

Screenshot from 2025-02-06 16-47-22

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I am not sure what this page should have been called, so feel free to suggest alternative titles. For now I somewhat followed the naming of the "Preparing PXE assets for OCP" page.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Feb 6, 2025

@skopacz1: This pull request references OSDOCS-12787 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.19.0" version, but no target version was set.

In response to this:

OSDOCS-12787

Version(s): 4.18+

This PR documents the generic support for iSCSI booting using resources generated by the Agent-based Installer.

QE review:

  • QE has approved this change.

Previews:

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 openshift-eng/jira-lifecycle-plugin repository.

Copy link

openshift-ci bot commented Feb 6, 2025

@skopacz1: all tests passed!

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.

toc::[]

You can boot an {product-title} cluster through iSCSI using an ISO image generated by the Agent-based Installer.
The following procedures describe how to prepare the necessary installation resources for you to upload to an iSCSI target.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're reloading uploading to the target, which can be a separate iSCSI disk. So perhaps "resources to boot off of an iSCSI target"?

Static networking is not supported.
* You must create an additional network for iSCSI that is separate from the machine network of the cluster.
The machine network is rebooted during cluster installation and cannot be used for the iSCSI session.
* If the iSCSI server uses disks, the iSCSI disk must be specified using the `rootDeviceHints` parameter.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should refer to the actual host you are installing the agent ISO on, not the ISCSI server.
Perhaps - "ff the host on which you are booting the agent ISO also has an installed disk, it may be necessary to specify the iSCSI disk name in the rootDeviceHints parameter to ensure that it is picked as the boot disk for the final RHCOS image."

* You must create an additional network for iSCSI that is separate from the machine network of the cluster.
The machine network is rebooted during cluster installation and cannot be used for the iSCSI session.
* If the iSCSI server uses disks, the iSCSI disk must be specified using the `rootDeviceHints` parameter.
You can also use a diskless environment for iSCSI booting.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case it would not be necessary to set the 'rootDeviceHints'.

--
where:

<iscsi_initiator_base>:: Specifies the (need description here).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifies the iSCSI initiator name on the host that is booting the ISO. This name can be used by the the iSCSI target.

where:

<iscsi_initiator_base>:: Specifies the (need description here).
<iscsi_network_subnet>:: Specifies the subnet of the iSCSI network.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifies the IP address of the iSCSI target.

$ cat << EOF > agent.ipxe
!ipxe
set initiator-iqn <iscsi_initiator_base>:\${hostname}
sanboot --keep iscsi:<iscsi_network_subnet>.1::::$<iscsi_initiator_base>:\${hostname}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The scsi_initiator_base do not have to be the same (but can be). We should make them different to make it clearer.
The one at line 26 is the name of the iSCSI initiator (resides on the host). The one at line 27 is the iSCSI target name.

Comment on lines +43 to +44
set initiator-iqn <iscsi_initiator_base>:\${hostname}
sanboot --keep iscsi:<iscsi_network_subnet>.1::::$<iscsi_initiator_base>:\${hostname}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is an example:

Screenshot from 2025-02-06 16-47-22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants