Skip to content

Commit 63ca1d2

Browse files
skopacz1skopacz1
committed
OSDOCS-14725: OVE install method
1 parent 30ea527 commit 63ca1d2

File tree

9 files changed

+329
-0
lines changed

9 files changed

+329
-0
lines changed

‎_topic_maps/_topic_map.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,8 @@ Topics:
409409
File: installing-with-agent-basic
410410
- Name: Installing a cluster with customizations
411411
File: installing-with-agent-based-installer
412+
- Name: Installing a cluster without an external registry
413+
File: installing-ove
412414
- Name: Preparing PXE assets for OCP
413415
File: prepare-pxe-assets-agent
414416
- Name: Preparing installation assets for iSCSI booting

‎images/installing-ove-console.png‎

73.9 KB
Loading

‎installing/installing_with_agent_based_installer/installing-ove.adoc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="installing-ove"]
3+
= Installing a cluster without an external registry
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installing-ove
6+
7+
toc::[]
8+
9+
[role="_abstract"]
10+
You can deploy an {product-title} cluster without the need for an external image registry, either in a connected or disconnected environment. This installation method uses a simplified user interface and self-contained media to facilitate the installation.
11+
12+
Although the method supports general clusters, the downloaded media contains an Operator bundle that is curated specifically for {ove-first}, meaning additional Operators must be retrieved separately if required for other use cases.
13+
14+
:FeatureName: Installing an {ove} cluster using this method
15+
include::snippets/technology-preview.adoc[]
16+
17+
include::modules/installing-ove-advantages.adoc[leveloffset=+1]
18+
19+
// Downloading the installation ISO
20+
include::modules/installing-ove-iso.adoc[leveloffset=+1]
21+
22+
// Mounting the ISO and booting the rendezvous node
23+
include::modules/installing-ove-rendezvous.adoc[leveloffset=+1]
24+
25+
// Configuring cluster details and choosing Operators to install
26+
include::modules/installing-ove-console-initial.adoc[leveloffset=+1]
27+
28+
// Booting the remaining cluster hosts
29+
include::modules/installing-ove-hosts.adoc[leveloffset=+1]
30+
31+
// Completing cluster configuration and initiating the installation
32+
include::modules/installing-ove-console-final.adoc[leveloffset=+1]
33+
34+
[id="additional-resources_{context}"]
35+
[role="_additional-resources"]
36+
== Additional resources
37+
38+
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#installing-virtctl_virt-using-the-cli-tools[Installing virtctl]
39+
* xref:../../virt/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[Creating virtual machines from instance types]
40+
* xref:../../virt/creating_vm/virt-creating-vms-from-templates.adoc#virt-creating-vms-from-templates[Creating virtual machines from templates]
41+
* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.8/html/installing_and_using_the_migration_toolkit_for_virtualization/migrating-vmware[Migrating virtual machines from VMware vSphere (Migration Toolkit for Virtualization documentation)]
42+
* link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.8/html/installing_and_using_the_migration_toolkit_for_virtualization/migrating-rhv_rhv[Migrating virtual machines from Red{nbsp}Hat Virtualization (Migration Toolkit for Virtualization documentation)]

‎modules/installing-ove-advantages.adoc‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_with_agent_based_installer/installing-ove.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="virt-installing-ove-advantages_{context}"]
7+
= Installation method advantages
8+
9+
[role="_abstract"]
10+
This method has several advantages for users who want to install a cluster primarily to run virtualized workloads using {VirtProductName}.
11+
12+
Simplified web interface:: The cluster installation is performed through a graphical user interface.
13+
In addition to providing reasonable default configurations, this interface guides you through the installation by providing hints and warnings about configuring your cluster, without limiting the configurations that are available at installation time.
14+
This reduces the need for in-depth knowledge of {product-title} while still allowing for complex configurations to be made.
15+
16+
No external registry needed:: If you are installing your cluster in a disconnected environment, you do not need to configure an external image registry in your environment when using this method.
17+
All other disconnected installation methods require this additional environment setup.
18+
19+
Included Operator bundle:: You can install the Virtualization bundle, which includes all of the additional {olm-first} Operators needed to run virtual machines on your cluster, at the same time as the cluster installation.
20+
21+
[NOTE]
22+
====
23+
This installation method does not come with any storage Operators as part of the Operator bundle.
24+
You must configure your own storage solution separately.
25+
====

‎modules/installing-ove-console-final.adoc‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/install/installing-ove.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-installing-ove-console-final_{context}"]
7+
= Completing cluster configuration and initiating the installation
8+
9+
[role="_abstract"]
10+
Before you can finally initiate the cluster installation, you must verify host details, configure cluster networking details, and download the default cluster credentials.
11+
12+
.Prerequisites
13+
14+
* You have booted all of the hosts that will comprise your cluster and configured them with the correct rendezvous node IP address.
15+
+
16+
[IMPORTANT]
17+
====
18+
You can add as many hosts as you want to your cluster.
19+
However, at this stage, you must at least have enough available hosts to match the value you specified in the *Number of control plane nodes* field of the installation console's *Cluster details* page.
20+
====
21+
22+
.Procedure
23+
24+
. On the installation console hosted by the rendezvous node, configure the hosts in the *Host discovery* page:
25+
26+
.. Verify that every machine you booted from the ISO image appears in the *Host Inventory* section and has a *Status* value of *Ready*.
27+
28+
.. For each host, click the expand icon and verify that all of the specification fields are correct.
29+
30+
.. Optional: For each host except the rendezvous node, configure the role by selecting an option from the dropdown menu of the *Role* column.
31+
The default value for every host except the rendezvous node is `Auto-assign`.
32+
33+
.. Click *Next* to continue.
34+
35+
. On the *Storage* page, click the expand icon for each host and verify that all of the specification fields are correct.
36+
37+
. Click *Next* to continue.
38+
39+
. If you want to manage your own networking, select the *User-Managed Networking* option on the *Networking* page.
40+
41+
. If you want the cluster to manage networking, select the *Cluster-Managed Networking* option on the *Networking* page and configure cluster networking:
42+
43+
.. Select a *Networking stack type*.
44+
45+
.. Optional: Select a machine network from the dropdown menu of the *Machine network* field.
46+
Otherwise, a default value is selected.
47+
48+
.. Enter an IP address in the *API IP* field.
49+
An API IP provides an endpoint for all users to interact with and configure the platform.
50+
51+
.. Enter an IP address in the *Ingress IP* field.
52+
An ingress IP provides an endpoint for application traffic flowing from outside the cluster.
53+
54+
. Optional: Select the *Use advanced networking* checkbox and configure other parameters such as the *Cluster network CIDR*, the *Cluster network host prefix*, or *the Service network CIDR*.
55+
+
56+
This option is available for both cluster-managed and user-managed networking.
57+
58+
. Optional: Enter a key in the *Host SSH Public Key for troubleshooting after installation* field, which you can use to connect to hosts using a public SSH key for troubleshooting after installation.
59+
+
60+
This option is available for both cluster-managed and user-managed networking.
61+
62+
. Click *Next* to continue.
63+
64+
. On the *Download credentials* page, select the checkbox to acknowledge that you must download credential files prior to cluster installation.
65+
66+
. Click *Download credentials* and save the cluster credentials file in a secure location.
67+
+
68+
[IMPORTANT]
69+
====
70+
You must download the credentials at this stage.
71+
Once you initiate the cluster installation, the rendezvous node reboots and you can no longer retrieve the credentials.
72+
====
73+
74+
. On the *Review and create* page, review all of the cluster details and click *Install cluster* to initiate the cluster installation.
75+
+
76+
During the installation process, the rendezvous node reboots and the console you used to configure the installation is no longer accessible.
77+
At that point, the URL of the deployed cluster's web console is provided, although this console is not accessible until the cluster installation is completed.
78+
+
79+
Once the cluster is installed, you can visit this URL and sign in to the web console with your downloaded credentials.

‎modules/installing-ove-console-initial.adoc‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/install/installing-booting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-installing-ove-console-initial_{context}"]
7+
= Configuring cluster details and choosing Operators to install
8+
9+
[role="_abstract"]
10+
Once the rendezvous node has been booted from the ISO image, configure details about your cluster and choose Virtualization Operators to install from the web console.
11+
12+
.Prerequisites
13+
14+
* You have the URL of the installation web console that was provided by the rendezvous node.
15+
16+
.Procedure
17+
18+
. In a web browser, go to the URL provided by the rendezvous node.
19+
20+
. Configure your cluster in the *Cluster details* page:
21+
22+
.. Enter a name for the cluster in the *Cluster name* field.
23+
24+
.. Enter a base domain for the cluster in the *Base domain* field.
25+
All subdomains for the cluster will use this base domain.
26+
+
27+
[NOTE]
28+
====
29+
The base domain must be a valid DNS name.
30+
You must not have a wildcard domain set up for the base domain.
31+
====
32+
33+
.. Enter your pull secret in the *Pull secret* field.
34+
You can obtain a copy of your pull secret from the link:https://console.redhat.com/openshift/install/pull-secret[{hybrid-console}].
35+
36+
.. Optional: In the *Number of control plane nodes* field, select the number of control plane nodes for your installation from the dropdown menu.
37+
The default value is `3`.
38+
39+
.. Optional: Select the *Include custom manifests* checkbox if you want to upload custom manifests to further configure your cluster.
40+
This option adds an additional page for custom manifests that you use later in the configuration process.
41+
+
42+
[IMPORTANT]
43+
====
44+
If you have already added custom manifests, clearing the *Include custom manifests* checkbox automatically deletes them all.
45+
You must confirm the deletion.
46+
====
47+
48+
.. Optional: Under *Encryption of installation disks*, select the toggle switch for each disk you want to encrypt.
49+
50+
.. If you are encrypting disks, select either *TPM v2* or *Tang* as your encryption method.
51+
52+
.. If you are encrypting disks using a Tang server, enter the **Server URL** and **Server Thumbprint** in the **Tang servers** section of the page. You can select **Add another Tang server** to configure details for additional Tang server.
53+
54+
.. Click *Next* to continue.
55+
Once you proceed to the next page, you cannot go back to change any of these cluster details.
56+
57+
. Choose additional Operators to install in the *Operators* page:
58+
59+
.. If you want to install all of the Operators recommended for running Virtualization on your cluster, select *Virtualization* in the *Bundles* section.
60+
61+
.. If you want to install only some Operators, select the individual Operators from the Single Operators section.
62+
+
63+
[NOTE]
64+
====
65+
Some of the listed Operators are available only as part of the Virtualization Operator bundle.
66+
====
67+
68+
.. Click *Next* to continue.

‎modules/installing-ove-hosts.adoc‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/install/installing-booting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-installing-ove-hosts_{context}"]
7+
= Booting the remaining cluster hosts
8+
9+
[role="_abstract"]
10+
After you have configured initial cluster details in the installation web console and have a defined cluster topology, you must boot the remaining machines that will make up your cluster from the ISO image.
11+
12+
[NOTE]
13+
====
14+
You can boot non-rendezvous node machines earlier in the installation process, even before you designate a machine as the rendezvous node. However, you must know the valid IP address that you will select for the rendezvous node.
15+
16+
When you boot your non-rendezvous node machines, the machines will perform a check to see if an Assisted Service is running at the specified rendezvous IP address.
17+
If the service is not yet running, a warning appears to confirm whether you would still like to proceed booting the machine from the ISO image.
18+
====
19+
20+
.Prerequisites
21+
22+
* You have downloaded the installation ISO.
23+
24+
.Procedure
25+
26+
. Attach the ISO image to a machine and boot the machine from this image.
27+
You can also boot from a USB drive containing the ISO image.
28+
29+
. Wait for a machine to boot from the image and display the *Rendezvous node setup* menu.
30+
31+
. Enter the rendezvous node IP address in the *Rendezvous node setup* menu and select *Save rendezvous IP*.
32+
33+
. Select *Save and Continue*.
34+
35+
. Repeat this process for each remaining machine that will comprise the hosts in your cluster.

‎modules/installing-ove-iso.adoc‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/install/installing-ove.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-installing-ove-iso_{context}"]
7+
= Downloading the installation ISO
8+
9+
[role="_abstract"]
10+
You must first download the ISO image that will be used to run the installation on your bare-metal machines.
11+
This image includes all of the necessary {product-title} release images, as well as the {olm-first} Operators needed to install Virtualization on the cluster.
12+
13+
[NOTE]
14+
====
15+
The size of the ISO image can vary depending on the release you select.
16+
====
17+
18+
.Procedure
19+
20+
. Log in to the {hybrid-console-url}.
21+
22+
. On the *Red Hat OpenShift* tile, click *OpenShift*.
23+
24+
. On the *Red Hat OpenShift Container Platform* tile, click *Create cluster*.
25+
26+
. Click the *Datacenter* tab.
27+
28+
. Under *Assisted Installer*, click *Create cluster*.
29+
30+
. In the *Cluster details* page, select the toggle for "I'm installing on a disconnected/air-gapped/secured environment".
31+
32+
. Click *Next*.
33+
34+
. Click *Download ISO*.

‎modules/installing-ove-rendezvous.adoc‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/install/installing-booting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-installing-ove-booting_{context}"]
7+
= Mounting the ISO and booting the rendezvous node
8+
9+
[role="_abstract"]
10+
To initiate the cluster installation, attach the downloaded ISO to the machine that will serve as your rendezvous host and boot the machine from the ISO.
11+
12+
The rendezvous node runs as the bootstrap host during the installation, which hosts the configuration web console and runs an Assisted Service that facilitates the cluster deployment.
13+
14+
.Prerequisites
15+
16+
* You have downloaded the installation ISO.
17+
18+
.Procedure
19+
20+
. On the machine that you have designated to be the rendezvous node, attach the ISO image to the machine and boot the machine from this image.
21+
You can also boot from a USB drive containing the ISO image.
22+
+
23+
[NOTE]
24+
====
25+
If you mount the ISO via a virtual drive, the cluster installation might take several hours to complete.
26+
Mount the ISO with physical media such as a USB drive to reduce the overall installation time.
27+
====
28+
29+
. Wait for the machine to boot from the image and display the *Rendezvous node setup* menu.
30+
31+
. Select *This is the rendezvous node* in the *Rendezvous node setup* menu.
32+
+
33+
[IMPORTANT]
34+
====
35+
You must select only one machine to act as the rendezvous node.
36+
Selecting two or more machines as a rendezvous node is not supported.
37+
====
38+
39+
. In the *Rendezvous node IP selection* menu, select an IP address from the list to use as the rendezvous node IP address and select *Continue*.
40+
Make note of this address for later use.
41+
42+
. Wait for the rendezvous node to provide a URL for finishing the installation and save the URL for later use, as shown in the following image.
43+
+
44+
image::installing-ove-console.png[The rendezvous host providing the URL of the installation console]

0 commit comments

Comments
 (0)