Skip to content

Commit 856ecf9

Browse files
kcarmichael08kcarmichael08
authored
Merge pull request #65762 from skopacz1/OSDOCS-4639
2 parents 2049e3b + 8e3a6e5 commit 856ecf9

File tree

6 files changed

+118
-5
lines changed

6 files changed

+118
-5
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,8 @@ Topics:
347347
File: understanding-disconnected-installation-mirroring
348348
- Name: Installing a cluster with Agent-based Installer
349349
File: installing-with-agent-based-installer
350+
- Name: Preparing PXE assets for OCP
351+
File: prepare-pxe-assets-agent
350352
- Name: Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes
351353
File: preparing-an-agent-based-installed-cluster-for-mce
352354
- Name: Installing on a single node

‎installing/installing_with_agent_based_installer/prepare-pxe-assets-agent.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
:_content-type: ASSEMBLY
2+
[id="prepare-pxe-assets-agent"]
3+
= Preparing PXE assets for {product-title}
4+
include::_attributes/common-attributes.adoc[]
5+
:context: prepare-pxe-assets-agent
6+
7+
toc::[]
8+
9+
Use the following procedures to create the assets needed to PXE boot an {product-title} cluster using the Agent-based Installer.
10+
11+
The assets you create in these procedures will deploy a single-node {product-title} installation. You can use these procedures as a basis and modify configurations according to your requirements.
12+
13+
[id="prerequisites_prepare-pxe-assets-agent"]
14+
== Prerequisites
15+
16+
* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
17+
18+
// Downloading the Agent-based Installer
19+
include::modules/installing-ocp-agent-download.adoc[leveloffset=+1]
20+
21+
// Creating the preferred configuration inputs
22+
include::modules/installing-ocp-agent-inputs.adoc[leveloffset=+1]
23+
24+
[role="_additional-resources"]
25+
.Additional resources
26+
* xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#modifying-install-config-for-dual-stack-network_ipi-install-installation-workflow[Deploying with dual-stack networking].
27+
* xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#configuring-the-install-config-file_ipi-install-installation-workflow[Configuring the install-config yaml file].
28+
* See xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-three-node-cluster_installing-restricted-networks-bare-metal[Configuring a three-node cluster] to deploy three-node clusters in bare metal environments.
29+
* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#root-device-hints_preparing-to-install-with-agent-based-installer[About root device hints].
30+
* link:https://nmstate.io/examples.html[NMState state examples].
31+
32+
// Creating the PXE assets
33+
include::modules/pxe-assets-ocp-agent.adoc[leveloffset=+1]
34+
35+
[role="_additional-resources"]
36+
[id="additional-resources_prepare-pxe-assets-agent"]
37+
== Additional resources
38+
* See xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-with-agent-based-installer[Installing an {product-title} cluster with the Agent-based Installer] to learn about more configurations available with the Agent-based Installer.

‎modules/installing-ocp-agent-boot.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Use this procedure to boot the agent image on your machines.
1111
.Procedure
1212

1313
. Create the agent image by running the following command:
14-
1514
+
1615
[source,terminal]
1716
----

‎modules/installing-ocp-agent-download.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing-with-agent-based-installer/installing-with-agent-based-installer.adoc
4+
// * installing/installing_with_agent_based_installer/prepare-pxe-infra-agent.adoc
45

56
:_content-type: PROCEDURE
67
[id="installing-ocp-agent-retrieve_{context}"]
78
= Downloading the Agent-based Installer
89

9-
.Procedure
10-
1110
Use this procedure to download the Agent-based Installer and the CLI needed for your installation.
1211

12+
.Procedure
13+
1314
. Log in to the {product-title} web console using your login credentials.
1415

1516
. Navigate to link:https://console.redhat.com/openshift/create/datacenter[Datacenter].

‎modules/installing-ocp-agent-inputs.adoc

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing-with-agent-based-installer/installing-with-agent-based-installer.adoc
4+
// *installing/installing_with_agent_based_installer/prepare-pxe-infra-agent.adoc
5+
6+
ifeval::["{context}" == "prepare-pxe-assets-agent"]
7+
:pxe-boot:
8+
endif::[]
49

510
:_content-type: PROCEDURE
611
[id="installing-ocp-agent-inputs_{context}"]
712
= Creating the preferred configuration inputs
813

14+
ifndef::pxe-boot[]
915
Use this procedure to create the preferred configuration inputs used to create the agent image.
16+
endif::pxe-boot[]
17+
ifdef::pxe-boot[]
18+
Use this procedure to create the preferred configuration inputs used to create the PXE files.
19+
endif::pxe-boot[]
1020

1121
.Procedure
1222

@@ -117,7 +127,7 @@ platform:
117127
[source,terminal]
118128
----
119129
$ cat > agent-config.yaml << EOF
120-
apiVersion: v1alpha1
130+
apiVersion: v1beta1
121131
kind: AgentConfig
122132
metadata:
123133
name: sno-cluster
@@ -159,4 +169,25 @@ You must provide the rendezvous IP address when you do not specify at least one
159169
<2> Optional: Host configuration. The number of hosts defined must not exceed the total number of hosts defined in the `install-config.yaml` file, which is the sum of the values of the `compute.replicas` and `controlPlane.replicas` parameters.
160170
<3> Optional: Overrides the hostname obtained from either the Dynamic Host Configuration Protocol (DHCP) or a reverse DNS lookup. Each host must have a unique hostname supplied by one of these methods.
161171
<4> Enables provisioning of the Red Hat Enterprise Linux CoreOS (RHCOS) image to a particular device. It examines the devices in the order it discovers them, and compares the discovered values with the hint values. It uses the first discovered device that matches the hint value.
162-
<5> Optional: Configures the network interface of a host in NMState format.
172+
<5> Optional: Configures the network interface of a host in NMState format.
173+
174+
ifdef::pxe-boot[]
175+
176+
. Optional: To create an iPXE script, add the `bootArtifactsBaseURL` to the `agent-config.yaml` file:
177+
+
178+
[source,yaml]
179+
----
180+
apiVersion: v1beta1
181+
kind: AgentConfig
182+
metadata:
183+
name: sno-cluster
184+
rendezvousIP: 192.168.111.80
185+
bootArtifactsBaseURL: <asset_server_URL>
186+
----
187+
+
188+
Where `<asset_server_URL>` is the URL of the server you will upload the PXE assets to.
189+
endif::pxe-boot[]
190+
191+
ifeval::["{context}" == "prepare-pxe-assets-agent"]
192+
:!pxe-boot:
193+
endif::[]

‎modules/pxe-assets-ocp-agent.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_with_agent_based_installer/prepare-pxe-infra-agent.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="pxe-assets-ocp-agent_{context}"]
7+
= Creating the PXE assets
8+
9+
Use the following procedure to create the assets and optional script to implement in your PXE infrastructure.
10+
11+
.Procedure
12+
13+
. Create the PXE assets by running the following command:
14+
+
15+
[source,terminal]
16+
----
17+
$ openshift-install agent create pxe-files
18+
----
19+
+
20+
The generated PXE assets and optional iPXE script can be found in the `boot-artifacts` directory.
21+
+
22+
.Example filesystem with PXE assets and optional iPXE script
23+
[source,terminal]
24+
----
25+
boot-artifacts
26+
├─ agent.x86_64-initrd.img
27+
├─ agent.x86_64.ipxe
28+
├─ agent.x86_64-rootfs.img
29+
└─ agent.x86_64-vmlinuz
30+
----
31+
+
32+
[NOTE]
33+
====
34+
Red Hat Enterprise Linux CoreOS (RHCOS) supports multipathing on the primary disk, allowing stronger resilience to hardware failure to achieve higher host availability. Multipathing is enabled by default in the agent ISO image, with a default `/etc/multipath.conf` configuration.
35+
====
36+
37+
. Upload the PXE assets and optional script to your infrastructure where they will be accessible during the boot process.
38+
+
39+
[NOTE]
40+
====
41+
If you generated an iPXE script, the location of the assets must match the `bootArtifactsBaseURL` you added to the `agent-config.yaml` file.
42+
====

0 commit comments

Comments
 (0)