Skip to content

Commit 807270b

Browse files
skopacz1skopacz1
committed
OSDOCS-14725: OVE install method
1 parent fd294ca commit 807270b

File tree

8 files changed

+297
-0
lines changed

8 files changed

+297
-0
lines changed

‎_topic_maps/_topic_map.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4709,6 +4709,8 @@ Topics:
47094709
Topics:
47104710
- Name: Preparing your cluster
47114711
File: preparing-cluster-for-virt
4712+
- Name: Installing an OpenShift Virtualization Engine cluster in a disconnected environment
4713+
File: installing-ove
47124714
- Name: Installing OpenShift Virtualization
47134715
File: installing-virt
47144716
Distros: openshift-enterprise

‎images/installing-ove-console.png‎

73.9 KB
Loading

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

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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+
Before you can finally initiate the cluster installation, you must verify host details, configure cluster networking details, and download the default cluster credentials.
10+
11+
.Prerequisites
12+
13+
* You have booted all of the hosts that will comprise your cluster and configured them with the correct rendezvous node IP address.
14+
+
15+
[IMPORTANT]
16+
====
17+
You can add as many hosts as you want to your cluster.
18+
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.
19+
====
20+
21+
.Procedure
22+
23+
. On the installation console hosted by the rendezvous node, configure the hosts in the *Host discovery* page:
24+
25+
.. Verify that every machine you booted from the ISO image appears in the *Host Inventory* section and has a *Status* value of *Ready*.
26+
27+
.. For each host, click the expand icon and verify that all of the specification fields are correct.
28+
29+
.. Optional: For each host except the rendezvous node, configure the role by selecting an option from the dropdown menu of the *Role* column.
30+
The default value for every host except the rendezvous node is `Auto-assign`.
31+
32+
.. Click *Next* to continue.
33+
34+
. On the *Storage* page, click the expand icon for each host and verify that all of the specification fields are correct.
35+
36+
. Click *Next* to continue.
37+
38+
. If you will manage your own networking, select the *User-Managed Networking* option on the *Networking* page.
39+
40+
. If the cluster will manage networking, select the *Cluster-Managed Networking* option on the *Networking* page and configure cluster networking:
41+
42+
.. Select a *Networking stack type*.
43+
44+
.. Optional: Select a machine network from the dropdown menu of the *Machine network* field.
45+
Otherwise, a default value is selected.
46+
47+
.. Enter an IP address in the *API IP* field.
48+
An API IP provides an endpoint for all users to interact with and configure the platform.
49+
50+
.. Enter an IP address in the *Ingress IP* field.
51+
An ingress IP provides an endpoint for application traffic flowing from outside the cluster.
52+
53+
. 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*.
54+
+
55+
This option is available for both cluster-managed and user-managed networking.
56+
57+
. 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.
58+
+
59+
This option is available for both cluster-managed and user-managed networking.
60+
61+
. Click *Next* to continue.
62+
63+
. On the *Download credentials* page, select the checkbox to acknowledge that you must download credential files prior to cluster installation.
64+
65+
. Click *Download credentials* and save the cluster credentials file in a secure location.
66+
+
67+
[IMPORTANT]
68+
====
69+
You must download the credentials at this stage.
70+
Once you initiate the cluster installation, the rendezvous node reboots and you can no longer retrieve the credentials.
71+
====
72+
73+
. On the *Review and create* page, review all of the cluster details and click *Install cluster* to initiate the cluster installation.

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
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.
10+
11+
.Prerequisites
12+
13+
* You have the URL of the installation web console that was provided by the rendezvous node.
14+
15+
.Procedure
16+
17+
. In a web browser, go to the URL provided by the rendezvous node.
18+
19+
. Configure your cluster in the *Cluster details* page:
20+
21+
.. Enter a name for the cluster in the *Cluster name* field.
22+
23+
.. Enter a base domain for the cluster in the *Base domain* field.
24+
All subdomains for the cluster will use this base domain.
25+
+
26+
[NOTE]
27+
====
28+
The base domain must be a valid DNS name.
29+
You must not have a wildcard domain set up for the base domain.
30+
====
31+
32+
.. Enter your pull secret in the *Pull secret* field.
33+
You can obtain a copy of your pull secret link:https://console.redhat.com/openshift/install/pull-secret[here].
34+
35+
.. Optional: In the *Number of control plane nodes* field, select the number of control plane nodes for your installation from the dropdown menu.
36+
The default value is `3`.
37+
38+
.. Optional: Select the *include custom manifests* checkbox if you want to upload custom manifests to further configure your cluster.
39+
This option adds an additional page for custom manifests that you use later in the configuration process.
40+
+
41+
[IMPORTANT]
42+
====
43+
If you have already added custom manifests, clearing the *Include custom manifests* checkbox automatically deletes them all.
44+
You must confirm the deletion.
45+
====
46+
47+
.. Click *Next* to continue.
48+
Once you proceed to the next page, you cannot go back to change any of these cluster details.
49+
50+
. Choose additional Operators to install in the *Operators* page:
51+
52+
.. If you want to install all of the Operators recommended for running Virtualization on your cluster, select *Virtualization* in the *Bundles* section.
53+
54+
.. If you want to install only some Operators, select the individual Operators from the Single Operators section.
55+
+
56+
[NOTE]
57+
====
58+
Some of the listed Operators are available only as part of the Virtualization Operator bundle.
59+
====
60+
61+
.. Click *Next* to continue.

‎modules/installing-ove-hosts.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-booting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-installing-ove-hosts_{context}"]
7+
= Booting the remaining cluster hosts
8+
9+
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.
10+
11+
[NOTE]
12+
====
13+
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.
14+
15+
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.
16+
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.
17+
====
18+
19+
.Prerequisites
20+
21+
* You have downloaded the installation ISO.
22+
23+
.Procedure
24+
25+
. Attach the ISO image to a machine and boot the machine from this image.
26+
You can also boot from a USB drive containing the ISO image.
27+
28+
. Wait for a machine to boot from the image and display the *Rendezvous node setup* menu.
29+
30+
. Enter the rendezvous node IP address in the *Rendezvous node setup* menu and select *Save rendezvous IP*.
31+
32+
. Select *Save and Continue*.
33+
34+
. Repeat this process for each remaining machine that will comprise the hosts in your cluster.

‎modules/installing-ove-iso.adoc‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
You must first download the ISO image that will be used to run the installation on your bare-metal machines.
10+
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.
11+
12+
[NOTE]
13+
====
14+
The size of the ISO image can vary depending on the release you select.
15+
====
16+
17+
.Procedure
18+
19+
. Log in to the {hybrid-console-url}.
20+
21+
. On the *Red Hat OpenShift* tile, click *OpenShift*.
22+
23+
. On the *Red Hat OpenShift Container Platform* tile, click *Create cluster*.
24+
25+
. Click the *Datacenter* tab.
26+
27+
. Under *Assisted Installer*, click *Create cluster*.
28+
29+
. In the *Cluster details* page, select the toggle for "I'm installing on a disconnected/air-gapped/secured environment".
30+
31+
. Click *Next*.
32+
33+
. Click *Download ISO*.

‎modules/installing-ove-rendezvous.adoc‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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+
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.
10+
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.
11+
12+
.Prerequisites
13+
14+
* You have downloaded the installation ISO.
15+
16+
.Procedure
17+
18+
. 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.
19+
You can also boot from a USB drive containing the ISO image.
20+
21+
. Wait for the machine to boot from the image and display the *Rendezvous node setup* menu.
22+
23+
. Select *This is the rendezvous node* in the *Rendezvous node setup* menu.
24+
+
25+
[IMPORTANT]
26+
====
27+
You must select only one machine to act as the rendezvous node.
28+
Selecting two or more machines as a rendezvous node is not supported.
29+
====
30+
31+
. 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*.
32+
Make note of this address for later use.
33+
34+
. 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.
35+
+
36+
image::installing-ove-console.png[The rendezvous host providing the URL of the installation console]

‎virt/install/installing-ove.adoc‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="installing-ove"]
4+
= Installing an {ove} cluster in a disconnected environment
5+
:context: installing-ove
6+
7+
toc::[]
8+
9+
The following procedures describe a method to install a {ove-first} cluster that uses a simplified user interface. This method does not require you to set up an external image registry in disconnected environments, which is a requirement for all other disconnected installation methods.
10+
11+
:FeatureName: Installing an {ove} cluster using this method
12+
include::snippets/technology-preview.adoc[]
13+
14+
// Is it bad to mix mentions of OVE above and plain Virt below?
15+
16+
This method has the following advantages for users who want to install a cluster primarily to run virtualized workloads using {VirtProductName}:
17+
18+
Simplified web interface:: The cluster installation is performed through a graphical user interface.
19+
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.
20+
This reduces the need for in-depth knowledge of {product-title} while still allowing for complex configurations to be made.
21+
22+
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.
23+
All other disconnected installation methods require this additional environment setup.
24+
25+
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.
26+
27+
// Probably need some section for limitations such as bare metal machines, unless that's a commonly understood requirement for virt.
28+
29+
// Downloading the installation ISO
30+
include::modules/installing-ove-iso.adoc[leveloffset=+1]
31+
32+
// Mounting the ISO and booting the rendezvous node
33+
include::modules/installing-ove-rendezvous.adoc[leveloffset=+1]
34+
35+
// Configuring cluster details and choosing Operators to install
36+
include::modules/installing-ove-console-initial.adoc[leveloffset=+1]
37+
38+
// Booting the remaining cluster hosts
39+
include::modules/installing-ove-hosts.adoc[leveloffset=+1]
40+
41+
// Completing cluster configuration and initiating the installation
42+
include::modules/installing-ove-console-final.adoc[leveloffset=+1]
43+
44+
During the installation process, the rendezvous node reboots and the console you used to configure the installation is no longer accessible.
45+
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.
46+
47+
Once the cluster is installed, you can visit this URL and sign in to the web console with your downloaded credentials.
48+
49+
[id="next-steps_{context}"]
50+
== Next steps
51+
52+
After a successful cluster installation, you can take the following next steps to prepare your cluster to run virtualized workloads:
53+
54+
* xref:../../virt/getting_started/virt-using-the-cli-tools.adoc#installing-virtctl_virt-using-the-cli-tools[Install the `virtctl` command line tool] to manage virtualization resources from the command line.
55+
56+
* Create a virtual machine from an xref:../../virt/creating_vm/virt-creating-vms-from-instance-types.adoc#virt-creating-vms-from-instance-types[instance type], from a xref:../../virt/creating_vm/virt-creating-vms-from-templates.adoc#virt-creating-vms-from-templates[template], or by using more xref:../../virt/creating_vms_advanced/advanced-vm-creation-overview.adoc#advanced-vm-creation-overview[advanced methods].
57+
58+
* Use the Migration Toolkit for Virtualization (MTV) to migrate virtual machines from other virtualization providers, such as link:https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.8/html/installing_and_using_the_migration_toolkit_for_virtualization/migrating-vmware[VMware vSphere] or 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[Red{nbsp}Hat Virtualization].

0 commit comments

Comments
 (0)