Skip to content

Commit f263bf9

Browse files
skopacz1skopacz1
committed
OSDOCS-14725: OVE install method
1 parent 379b94d commit f263bf9

File tree

5 files changed

+195
-0
lines changed

5 files changed

+195
-0
lines changed

‎_topic_maps/_topic_map.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4655,6 +4655,8 @@ Topics:
46554655
Topics:
46564656
- Name: Preparing your cluster
46574657
File: preparing-cluster-for-virt
4658+
- Name: Installing an OpenShift Virtualization Engine cluster
4659+
File: installing-ove
46584660
- Name: Installing OpenShift Virtualization
46594661
File: installing-virt
46604662
Distros: openshift-enterprise

‎modules/installing-ove-booting.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-booting.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-installing-ove-booting_{context}"]
7+
= Mounting the ISO and booting the machines
8+
9+
To initiate the cluster installation, attach the downloaded ISO to each machine and boot the machines from the ISO.
10+
11+
.Prerequisites
12+
13+
* You have downloaded the installation ISO.
14+
15+
.Procedure
16+
17+
. For each machine in your environment, attach the ISO image to the machine and boot the machine from this image.
18+
19+
. Wait for each machine to boot from the image and display the *Rendezvous node setup* menu.
20+
21+
. Configure the rendezvous node for the cluster installation:
22+
23+
.. On the machine that you want to run as the bootstrap host for the installation process, select *This is the rendezvous node* in the *Rendezvous node setup* menu.
24+
25+
.. 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*.
26+
27+
.. On another machine, enter the rendezvous node IP address in the *Rendezvous node setup* menu and select *Save rendezvous IP*.
28+
29+
.. Select *Save and Continue*.
30+
31+
.. Repeat the previous two steps for each remaining machine that has booted from the ISO image.
32+
33+
. Wait for the rendezvous node to provide a URL for finishing the installation and save the URL for later use.

‎modules/installing-ove-console.adoc‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
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_{context}"]
7+
= Configuring the cluster installation from the web console
8+
9+
Once the machines have been booted from the ISO image and the rendezvous node has been selected, configure the rest of the cluster installation 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+
49+
. Choose additional Operators to install in the *Operators* page.
50+
51+
.. If you want to install all of the Operators recommended for running Virtualization on your cluster, select *Virtualization* in the *Bundles* section.
52+
53+
.. If you want to install only some Operators, select the individual Operators from the Single Operators section.
54+
+
55+
[NOTE]
56+
====
57+
Some of the listed Operators are available only as part of the Virtualization Operator bundle.
58+
====
59+
60+
.. Click *Next* to continue.
61+
62+
. Configure the hosts in the *Host discovery* page:
63+
64+
.. Verify that every machine you booted from the ISO appears in the *Host Inventory* section and has a *Status* value of *Ready*.
65+
66+
.. For each host, click the expand icon and verify that all of the specification fields are correct.
67+
68+
.. Optional: For each host configure the role selecting an option from the dropdown menu of the *Role* column.
69+
The default value for every host except the rendezvous node is `Auto-assign`.
70+
71+
.. Click *Next* to continue.
72+
73+
. On the *Storage* page, click the expand icon for each host and verify that all of the specification fields are correct.
74+
75+
. Click *Next* to continue.
76+
77+
. Configure the cluster networking on the *Networking* page:
78+
79+
.. Optional: Select a machine network from the dropdown menu of the *Machine network* field.
80+
Otherwise, a default value is selected.
81+
82+
.. Enter an IP address in the *API IP* field.
83+
An API IP provides an endpoint for all users to interact with, and configure the platform.
84+
85+
.. Enter an IP address in the *Ingress IP* field.
86+
An ingress IP provides an endpoint for application traffic flowing from outside the cluster.
87+
88+
.. 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*.
89+
90+
.. Optional: Enter a key in the *Host SSH Public Key for troubleshooting after installation* to connect to hosts using a public SSH key for troubleshooting after installation.
91+
92+
.. Click *Next* to continue.
93+
94+
. On the *Download credential*s page, select the checkbox to acknowledge that you must download credential files prior to cluster installation.
95+
96+
. Click *Download credentials* and save the cluster credentials file in a secure location.
97+
98+
. On the *Review and create* page, review all of the cluster details and click *Install cluster* to initiate the cluster installation.

‎modules/installing-ove-iso.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
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+
// Not sure if the following sentence is technically accurate or even a necessary detail to mention at this point in the process.
11+
This image includes all of the necessary {product-title} release images, which will be "pinned" to the cluster, to eliminate the need for an image registry when installing in a disconnected environment.
12+
13+
.Procedure
14+
15+
// Steps to actually download the ISO, once the method is officially confirmed

‎virt/install/installing-ove.adoc‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="installing-ove"]
4+
= Installing an {ove} cluster
5+
:context: installing-ove
6+
7+
toc::[]
8+
9+
The following procedures describe a streamlined method to install a {ove-first} cluster that requires less planning and configuration compared to other installation methods.
10+
11+
// To do: add tech preview banner, need a name for this feature though
12+
13+
// Is it bad to mix mentions of OVE above and plain Virt below?
14+
15+
This method has the following advantages for users who want to install a cluster primarily to run virtualized workloads using {VirtProductName}:
16+
17+
* The cluster installation is performed through a graphical user interface.
18+
19+
* You can install the Virtualization bundle, which includes all of the additional Operators needed to run virtual machines on your cluster, at the same time as the cluster installation.
20+
21+
* If you are installing your cluster in a disconnected environment, you do not need to configure an image registry in your environment when using this method.
22+
23+
// Probably need some section for limitations such as bare metal machines, unless that's a commonly understood requirement for virt.
24+
25+
// Downloading the installation ISO
26+
include::modules/installing-ove-iso.adoc[leveloffset=+1]
27+
28+
// Mounting the ISO and booting the machines
29+
include::modules/installing-ove-booting.adoc[leveloffset=+1]
30+
31+
// Configuring the cluster installation from the web console
32+
include::modules/installing-ove-console.adoc[leveloffset=+1]
33+
34+
// Should I include the Agent procedure here about tracking and verifying installation progress? Or does the UI do the same thing as the `wait-for` commands?
35+
36+
After the cluster has been installed, the installation console displays the URL of the web console, which you can visit and sign in using your downloaded credentials.
37+
38+
[id="next-steps_{context}"]
39+
== Next steps
40+
41+
After a successful cluster installation, you can take the following next steps to prepare your cluster to run virtualized workloads:
42+
43+
* 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.
44+
45+
* 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].
46+
47+
* 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)