Skip to content

Commit d0ce60b

Browse files
committed
TELCODOCS-1146: Revised installation introduction to include Assisted Installer. Revised additional docs to include AI for Nutanix and vSphere..
1 parent 0113368 commit d0ce60b

8 files changed

+65
-21
lines changed

installing/index.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ include::modules/ipi-verifying-nodes-after-installation.adoc[leveloffset=+2]
2525
* xref:../installing/validating-an-installation.adoc#validating-an-installation[Validating an installation]
2626
2727
* xref:../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[Agent-based Installer]
28+
29+
* link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2022/html-single/assisted_installer_for_openshift_container_platform/index[Assisted Installer for OpenShift Container Platform]
30+
2831
[discrete]
2932
=== Installation scope
3033

installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,20 @@ include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=
2424
[id="choosing-a-method-to-install-ocp-on-bare-metal"]
2525
== Choosing a method to install {product-title} on bare metal
2626

27-
You can install {product-title} on installer-provisioned or user-provisioned infrastructure. The default installation type uses installer-provisioned infrastructure, where the installation program provisions the underlying infrastructure for the cluster. You can also install {product-title} on infrastructure that you provision. If you do not use infrastructure that the installation program provisions, you must manage and maintain the cluster resources yourself.
27+
The {product-title} installation program offers four methods for deploying a cluster:
28+
29+
* *Interactive*: You can deploy a cluster with the web-based link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2022/html-single/assisted_installer_for_openshift_container_platform/index[{ai-full}]. This is the recommended approach for clusters with networks connected to the internet. The {ai-full} is the easiest way to install {product-title}, it provides smart defaults, and it performs pre-flight validations before installing the cluster. It also provides a RESTful API for automation and advanced configuration scenarios.
30+
31+
* *Local Agent-based*: You can deploy a cluster locally with the xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[agent-based installer] for air-gapped or restricted networks. It provides many of the benefits of the {ai-full}, but you must download and configure the link:https://console.redhat.com/openshift/install/metal/agent-based[agent-based installer] first. Configuration is done with a commandline interface. This approach is ideal for air-gapped or restricted networks.
32+
33+
* *Automated*: You can xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[deploy a cluster on installer-provisioned infrastructure] and the cluster it maintains. The installer uses each cluster host's baseboard management controller (BMC) for provisioning. You can deploy clusters with both connected or air-gapped or restricted networks.
34+
35+
* *Full control*: You can deploy a cluster on xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[infrastructure that you prepare and maintain], which provides maximum customizability. You can deploy clusters with both connected or air-gapped or restricted networks.
36+
37+
The clusters have the following characteristics:
38+
39+
* Highly available infrastructure with no single points of failure is available by default.
40+
* Administrators maintain control over what updates are applied and when.
2841

2942
See xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process] for more information about installer-provisioned and user-provisioned installation processes.
3043

installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
In {product-title} version {product-version}, you can install a cluster on your Nutanix instance that uses installer-provisioned infrastructure.
9+
In {product-title} version {product-version}, you can install a cluster on your Nutanix instance with two methods:
10+
11+
* Using the link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2022/html-single/assisted_installer_for_openshift_container_platform/index[{ai-full}] hosted at link:http://console.redhat.com[console.redhat.com]. This method requires no setup for the installer, and is ideal for connected environments like Nutanix. Installing with the {ai-full} also provides integration with Nutanix, enabling autoscaling. See xref:../../installing/installing_on_prem_assisted/installing-on-prem-assisted.adoc#installing-on-prem-assisted[Installing an on-premise cluster using the {ai-full}] for additional details.
12+
13+
* Using installer-provisioned infrastructure. Use the procedures in the following sections to use installer-provisioned infrastructure. Installer-provisioned infrastructure is ideal for installing in environments with air-gapped/restricted networks.
1014
1115
== Prerequisites
1216

installing/installing_vsphere/preparing-to-install-on-vsphere.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ xref:../../installing/install_config/configuring-firewall.adoc#configuring-firew
2222
[id="choosing-a-method-to-install-ocp-on-vsphere"]
2323
== Choosing a method to install {product-title} on vSphere
2424

25-
You can install {product-title} on vSphere by using installer-provisioned or user-provisioned infrastructure. The default installation type uses installer-provisioned infrastructure, where the installation program provisions the underlying infrastructure for the cluster. You can also install {product-title} on infrastructure that you provide. If you do not use infrastructure that the installation program provisions, you must manage and maintain the cluster resources yourself.
25+
You can install {product-title} with the link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2022/html-single/assisted_installer_for_openshift_container_platform/index[{ai-full}]. This method requires no setup for the installer, and is ideal for connected environments like vSphere. Installing with the {ai-full} also provides integration with vSphere, enabling autoscaling. See xref:../../installing/installing_on_prem_assisted/installing-on-prem-assisted.adoc#installing-on-prem-assisted[Installing an on-premise cluster using the {ai-full}] for additional details.
26+
27+
You can also install {product-title} on vSphere by using installer-provisioned or user-provisioned infrastructure. Installer-provisioned infrastructure is ideal for installing in environments with air-gapped/restricted networks, where the installation program provisions the underlying infrastructure for the cluster. You can also install {product-title} on infrastructure that you provide. If you do not use infrastructure that the installation program provisions, you must manage and maintain the cluster resources yourself.
2628

2729
See the xref:../../architecture/architecture-installation.html#installation-process_architecture-installation[Installation process] for more information about installer-provisioned and user-provisioned installation processes.
2830

modules/assisted-installer-using-the-assisted-installer.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="using-the-assisted-installer_{context}"]
77
= Using the Assisted Installer
88

9-
The {product-title} link:https://console.redhat.com/openshift/assisted-installer/clusters/~new[{ai-full}] is a user-friendly installation solution offered on the link:http://console.redhat.com[Red Hat Hybrid Cloud Console]. The {ai-full} supports the various deployment platforms with a focus on bare metal and vSphere infrastructures.
9+
The {product-title} link:https://console.redhat.com/openshift/assisted-installer/clusters/~new[{ai-full}] is a user-friendly installation solution offered on the link:http://console.redhat.com[Red Hat Hybrid Cloud Console]. The {ai-full} supports the various deployment platforms with a focus on bare metal, Nutanix, and vSphere infrastructures.
1010

1111
The {ai-full} provides installation functionality as a service. This software-as-a-service (SaaS) approach has the following advantages:
1212

@@ -35,7 +35,7 @@ The {ai-full} provides installation functionality as a service. This software-as
3535
The {ai-full} supports installing {product-title} on premises in a connected environment, including with an optional HTTP/S proxy. It can install the following:
3636

3737
* Highly available {product-title} or Single Node OpenShift (SNO)
38-
* {product-title} on bare metal or vSphere with full platform integration, or other virtualization platforms without integration
38+
* {product-title} on bare metal, Nutanix, or vSphere with full platform integration, or other virtualization platforms without integration
3939
* Optionally {VirtProductName} and {rh-storage} (formerly OpenShift Container Storage)
4040

4141
The user interface provides an intuitive interactive workflow where automation does not exist or is not required. Users may also automate installations using the REST API.

modules/install-openshift-common-terms.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88

99
This glossary defines common terms that are used in the installation content. These terms help you understand installation effectively.
1010

11+
{ai-full}::
12+
An installer hosted at link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2022/html-single/assisted_installer_for_openshift_container_platform/index[console.redhat.com] that provides a web user interface or a RESTful API for creating a cluster configuration. The {ai-full} generates a discovery image. Cluster machines boot with the discovery image, which installs {op-system} and an agent. Together, the {ai-full} and agent provide pre-installation validation and installation for the cluster.
13+
14+
Agent-based installer::
15+
An installer similar to the {ai-full}, but you must download the link:https://console.redhat.com/openshift/install/metal/agent-based[agent-based installer] first. The agent-based installer is ideal for air-gapped/restricted networks.
16+
1117
Bootstrap node::
1218
A temporary machine that runs a minimal Kubernetes configuration to deploy the {product-title} control plane.
1319

modules/installation-overview.adoc

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,32 @@
77
[id="installation-overview_{context}"]
88
= About {product-title} installation
99

10-
The {product-title} installation program offers you flexibility. You can use the program to:
10+
The {product-title} installation program offers four methods for deploying a cluster:
1111

12-
* Deploy a cluster on provisioned infrastructure and the cluster it maintains.
13-
* Deploy a cluster on infrastructure that you prepare and maintain.
12+
* *Interactive*: You can deploy a cluster with the web-based link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2022/html-single/assisted_installer_for_openshift_container_platform/index[{ai-full}]. This is the recommended approach for clusters with networks connected to the internet. The {ai-full} is the easiest way to install {product-title}, it provides smart defaults, and it performs pre-flight validations before installing the cluster. It also provides a RESTful API for automation and advanced configuration scenarios.
1413
15-
These two basic types of {product-title} clusters are frequently called:
14+
* *Local Agent-based*: You can deploy a cluster locally with the agent-based installer for air-gapped or restricted networks. It provides many of the benefits of the {ai-full}, but you must download and configure the link:https://console.redhat.com/openshift/install/metal/agent-based[agent-based installer] first. Configuration is done with a commandline interface. This approach is ideal for air-gapped or restricted networks.
1615
17-
* Installer-provisioned infrastructure clusters.
18-
* User-provisioned infrastructure clusters.
16+
* *Automated*: You can deploy a cluster on installer-provisioned infrastructure and the cluster it maintains. The installer uses each cluster host's baseboard management controller (BMC) for provisioning. You can deploy clusters with both connected or air-gapped or restricted networks.
1917
20-
Both cluster types have the following characteristics:
18+
* *Full control*: You can deploy a cluster on infrastructure that you prepare and maintain, which provides maximum customizability. You can deploy clusters with both connected or air-gapped or restricted networks.
19+
20+
The clusters have the following characteristics:
2121

2222
* Highly available infrastructure with no single points of failure is available by default.
2323
* Administrators maintain control over what updates are applied and when.
2424
25-
The Agent-based Installer is part of the {product-title} Installer. The installer provides you with the flexibility of user-provisioned infrastructure (UPI) installation and the ease of use of the Assisted Installer (AI).
26-
2725
[id="about-the-installation-program"]
2826
== About the installation program
2927

30-
You can use the installation program to deploy both types of clusters. The installation program generates main assets such as Ignition config files for the bootstrap, master, and worker machines. You can start an {product-title} cluster with these three configurations and correctly configured infrastructure.
28+
You can use the installation program to deploy each type of cluster. The installation program generates main assets such as Ignition config files for the bootstrap, control plane (master), and worker machines. You can start an {product-title} cluster with these three configurations and correctly configured infrastructure.
3129

3230
The {product-title} installation program uses a set of targets and dependencies to manage cluster installations. The installation program has a set of targets that it must achieve, and each target has a set of dependencies. Because each target is only concerned with its own dependencies, the installation program can act to achieve multiple targets in parallel with the ultimate target being a running cluster. The installation program recognizes and uses existing components instead of running commands to create them again because the program meets dependencies.
3331

3432
.{product-title} installation targets and dependencies
3533
image::targets-and-dependencies.png[{product-title} installation targets and dependencies]
3634

35+
3736
[id="about-rhcos"]
3837
== About {op-system-first}
3938

0 commit comments

Comments
 (0)