Skip to content

Commit 729c785

Browse files
committed
OSDOCS-12579: Updated the Installing OpenShift on a single node
1 parent 9e775b9 commit 729c785

7 files changed

+32
-16
lines changed

installing/installing_sno/install-sno-installing-sno.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ include::_attributes/common-attributes.adoc[]
77
toc::[]
88

99
ifndef::openshift-origin[]
10-
You can install {sno} using the web-based Assisted Installer and a discovery ISO that you generate using the Assisted Installer. You can also install {sno} by using `coreos-installer` to generate the installation ISO.
10+
You can install {sno} by using either the web-based Assisted Installer or the `coreos-installer` tool to generate a discovery ISO image. The discovery ISO image writes the {op-system-first} system configuration to the target installation disk, so that you can run a single-cluster node to meet your needs.
11+
12+
Consider using {sno} when you want to run a cluster in a low-resource or an isolated environment for testing, troubleshooting, training, or small-scale project purposes.
1113

1214
[id="installing-sno-assisted-installer"]
1315
== Installing {sno} using the Assisted Installer
@@ -24,6 +26,7 @@ include::modules/install-sno-generating-the-discovery-iso-with-the-assisted-inst
2426
* xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#persistent-storage-using-lvms_logical-volume-manager-storage[Persistent storage using logical volume manager storage]
2527
* xref:../../virt/about_virt/about-virt.adoc#virt-what-you-can-do-with-virt_about-virt[What you can do with OpenShift Virtualization]
2628

29+
// Installing single-node OpenShift with the Assisted Installer
2730
include::modules/install-sno-installing-with-the-assisted-installer.adoc[leveloffset=+2]
2831
endif::openshift-origin[]
2932

@@ -80,6 +83,7 @@ include::modules/install-sno-generating-the-install-iso-manually.adoc[leveloffse
8083
* See xref:../../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] for more information about enabling cluster capabilities that were disabled before installation.
8184
* See xref:../../installing/overview/cluster-capabilities.adoc#explanation_of_capabilities_cluster-capabilities[Optional cluster capabilities in {product-title} {product-version}] for more information about the features provided by each capability.
8285

86+
// Monitoring the cluster installation using openshift-install
8387
include::modules/install-sno-monitoring-the-installation-manually.adoc[leveloffset=+2]
8488

8589
[role="_additional-resources"]

modules/creating-manifest-file-customized-br-ex-bridge.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ spec:
149149
endif::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
150150

151151
ifdef::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
152-
. Create a `NodeNetworkConfigurationPolicy` (NNCP) CR and define a customized `br-ex` bridge network configuration. Depending on your needs, ensure that you set a masquerade IP for either the `ipv4.address.ip`, `ipv6.address.ip`, or both parameters. A masquerade IP address must match an in-use IP address block.
152+
* Create a `NodeNetworkConfigurationPolicy` (NNCP) CR and define a customized `br-ex` bridge network configuration. Depending on your needs, ensure that you set a masquerade IP for either the `ipv4.address.ip`, `ipv6.address.ip`, or both parameters. A masquerade IP address must match an in-use IP address block.
153153
+
154154
.Example of an NNCP CR that sets IPv6 and IPv4 masquerade IP addresses
155155
[source,yaml]

modules/install-sno-additional-requirements-for-installing-sno-on-a-cloud-provider.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ifndef::openshift-origin[]
99

1010
The documentation for installer-provisioned installation on cloud providers is based on a high availability cluster consisting of three control plane nodes. When referring to the documentation, consider the differences between the requirements for a {sno} cluster and a high availability cluster.
1111

12-
* A high availability cluster requires a temporary bootstrap machine, three control plane machines, and at least two compute machines. For a {sno} cluster, you need only a temporary bootstrap machine and one cloud instance for the control plane node and no worker nodes.
12+
* A high availability cluster requires a temporary bootstrap machine, three control plane machines, and at least two compute machines. For a {sno} cluster, you need only a temporary bootstrap machine and one cloud instance for the control plane node and no compute nodes.
1313
1414
* The minimum resource requirements for high availability cluster installation include a control plane node with 4 vCPUs and 100GB of storage. For a {sno} cluster, you must have a minimum of 8 vCPUs and 120GB of storage.
1515
endif::openshift-origin[]

modules/install-sno-generating-the-discovery-iso-with-the-assisted-installer.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Installing {product-title} on a single node requires a discovery ISO, which the
1212

1313
. On the administration host, open a browser and navigate to link:https://console.redhat.com/openshift/assisted-installer/clusters[{cluster-manager-first}].
1414

15-
. Click *Create Cluster* to create a new cluster.
15+
. Click *Create New Cluster* to create a new cluster.
1616

1717
. In the *Cluster name* field, enter a name for the cluster.
1818

@@ -25,7 +25,7 @@ example.com
2525
All DNS records must be subdomains of this base domain and include the cluster name, for example:
2626
+
2727
----
28-
<cluster-name>.example.com
28+
<cluster_name>.example.com
2929
----
3030
+
3131
[NOTE]
@@ -35,9 +35,11 @@ You cannot change the base domain or cluster name after cluster installation.
3535

3636
. Select *Install single node OpenShift (SNO)* and complete the rest of the wizard steps. Download the discovery ISO.
3737

38-
. Make a note of the discovery ISO URL for installing with virtual media.
39-
40-
[NOTE]
38+
. Complete the remaining Assisted Installer wizard steps.
39+
+
40+
[IMPORTANT]
4141
=====
42+
Ensure that you take note of the discovery ISO URL for installing with virtual media.
43+
4244
If you enable {VirtProductName} during this process, you must have a second local storage device of at least 50GiB for your virtual machines.
4345
=====

modules/install-sno-generating-the-install-iso-manually.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ ifndef::openshift-origin[]
2424
+
2525
[source,terminal]
2626
----
27-
$ OCP_VERSION=<ocp_version> <1>
27+
$ export OCP_VERSION=<ocp_version> <1>
2828
----
2929
+
3030
<1> Replace `<ocp_version>` with the current version, for example, `latest-{product-version}`
@@ -44,7 +44,7 @@ endif::openshift-origin[]
4444
+
4545
[source,terminal]
4646
----
47-
$ ARCH=<architecture> <1>
47+
$ export ARCH=<architecture> <1>
4848
----
4949
<1> Replace `<architecture>` with the target host architecture, for example, `aarch64` or `x86_64`.
5050

@@ -116,7 +116,7 @@ $ chmod +x openshift-install
116116
+
117117
[source,terminal]
118118
----
119-
$ ISO_URL=$(./openshift-install coreos print-stream-json | grep location | grep $ARCH | grep iso | cut -d\" -f4)
119+
$ export ISO_URL=$(./openshift-install coreos print-stream-json | grep location | grep $ARCH | grep iso | cut -d\" -f4)
120120
----
121121

122122
ifndef::openshift-origin[]

modules/install-sno-installing-with-the-assisted-installer.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,22 @@
88

99
Use the Assisted Installer to install the single-node cluster.
1010

11+
.Prerequisites
12+
13+
* Ensure that the boot drive order in the server BIOS settings defaults to booting the server from the target installation disk.
14+
1115
.Procedure
1216

13-
. Attach the {op-system} discovery ISO to the target host.
17+
. Attach the discovery ISO image to the target host.
1418

15-
. Configure the boot drive order in the server BIOS settings to boot from the attached discovery ISO and then reboot the server.
19+
. Boot the server from the discovery ISO image. The discovery ISO image writes the system configuration to the target installation disk and automatically triggers a server restart.
1620

1721
. On the administration host, return to the browser. Wait for the host to appear in the list of discovered hosts. If necessary, reload the link:https://console.redhat.com/openshift/assisted-installer/clusters[*Assisted Clusters*] page and select the cluster name.
1822

1923
. Complete the install wizard steps. Add networking details, including a subnet from the available subnets. Add the SSH public key if necessary.
2024

2125
. Monitor the installation's progress. Watch the cluster events. After the installation process finishes writing the operating system image to the server's hard disk, the server restarts.
2226

23-
. Remove the discovery ISO, and reset the server to boot from the installation drive.
27+
. Optional: Remove the discovery ISO image.
2428
+
2529
The server restarts several times automatically, deploying the control plane.

modules/install-sno-monitoring-the-installation-manually.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,15 @@
88

99
Use `openshift-install` to monitor the progress of the single-node cluster installation.
1010

11+
.Prerequisites
12+
13+
* Ensure that the boot drive order in the server BIOS settings defaults to booting the server from the target installation disk.
14+
1115
.Procedure
1216

13-
. Attach the modified {op-system} installation ISO to the target host.
17+
. Attach the discovery ISO image to the target host.
1418

15-
. Configure the boot drive order in the server BIOS settings to boot from the attached discovery ISO and then reboot the server.
19+
. Boot the server from the discovery ISO image. The discovery ISO image writes the system configuration to the target installation disk and automatically triggers a server restart.
1620

1721
. On the administration host, monitor the installation by running the following command:
1822
ifndef::openshift-origin[]
@@ -29,6 +33,8 @@ ifdef::openshift-origin[]
2933
$ ./openshift-install --dir=sno wait-for install-complete
3034
----
3135
endif::openshift-origin[]
36+
37+
. Optional: Remove the discovery ISO image.
3238
+
3339
The server restarts several times while deploying the control plane.
3440

0 commit comments

Comments
 (0)