TELCODOCS-1887: Adding section for IBI workflow

Author: rohennes

_topic_maps/_topic_map.yml

@@ -3345,16 +3345,23 @@ Topics:
   - Name: Performing an image-based upgrade for single-node OpenShift clusters using GitOps ZTP
     File: ztp-image-based-upgrade
 - Name: Image-based installation for single-node OpenShift
-  Dir: image-base-install
+  Dir: image_base_install
+  Distros: openshift-origin,openshift-enterprise
   Topics:
   - Name: Understanding image-based installation and deployment for single-node OpenShift
     File: ibi-understanding-image-based-install
   - Name: Preparing for a single-node OpenShift image-based installation
     File: ibi-preparing-for-image-based-install
-  - Name: Installing single-node OpenShift using an image-based installation
+  - Name: Preinstalling single-node OpenShift using an image-based installation
     File: ibi-factory-image-based-install
-  - Name: Deploying single-node OpenShift using the installation program
-    File: ibi-edge-image-based-install-standalone
+  - Name: Deploying single-node OpenShift clusters
+    Dir: ibi_deploying_sno_clusters
+    Distros: openshift-origin,openshift-enterprise
+    Topics:
+    - Name: Deploying managed single-node OpenShift using the IBI Operator
+      File: ibi-edge-image-based-install
+    - Name: Deploying single-node OpenShift using the installation program
+      File: ibi-edge-image-based-install-standalone
 - Name: Day 2 operations for telco core CNF clusters
   Dir: day_2_core_cnf_clusters
   Distros: openshift-origin,openshift-enterprise

edge_computing/image-base-install/ibi-understanding-image-based-install.adoc

@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="ibi-image-based-install_{context}"]
-= About image-based installations for {sno} clusters
+[id="ibi-factory-image-based-install"]
+= About image-based installation for {sno}
 include::_attributes/common-attributes.adoc[]
 :context: ibi-factory-image-based-install
 
@@ -13,8 +13,8 @@ The installation program takes a seed image URL and other inputs, such as the re
 The following are the high-level steps to preinstall a {sno} cluster using an image-based installation:
 
 * Generate a seed image.
-* Create a live installation ISO using the installation program.
-* Start the host using the live installation ISO to preinstall the host.
+* Create a live installation ISO using the `openshift-install` installation program.
+* Boot the host using the live installation ISO to preinstall the host.
 
 [role="_additional-resources"]
 .Additional resources
@@ -23,7 +23,11 @@ The following are the high-level steps to preinstall a {sno} cluster using an im
 
 include::modules/ibi-create-iso-for-bmh.adoc[leveloffset=+1]
 
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../edge_computing/image_base_install/ibi_deploying_sno_clusters/ibi-edge-image-based-install-standalone.adoc#ibi-installer-configuration-config_ibi-edge-image-based-install[Reference specifications for the `image-based-installation-config.yaml` manifest]
+
 include::modules/ibi-provision-install-iso-to-bmh.adoc[leveloffset=+1]
 
 include::modules/ibi-installer-installation-config.adoc[leveloffset=+1]
-

edge_computing/image-base-install/_attributes renamed to edge_computing/image_base_install/_attributes

@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="ibi-preparing-for-image-based-install_{context}"]
-= Preparing for an image-based installation for {sno} clusters
+[id="ibi-preparing-for-image-based-install"]
+= Preparing for image-based installation for {sno} clusters
 include::_attributes/common-attributes.adoc[]
 :context: ibi-preparing-image-based-install
 
@@ -10,6 +10,11 @@ To prepare for an image-based installation for {sno} clusters, you must complete
 * Create a seed image by using the {lcao}.
 * Verify that all software components meet the required versions. For further information, see "Software prerequisites for an image-based installation and deployment".
 
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../edge_computing/image_base_install/ibi-understanding-image-based-install.adoc#ztp-image-based-upgrade-prereqs_ibi-understanding-image-based-install[Software prerequisites for an image-based installation and deployment]
+
 == Installing the {lcao}
 
 Use the {lcao} to generate a seed image from a seed cluster. You can install the {lcao} using the {oc-first} or the web console.
@@ -22,4 +27,4 @@ include::modules/cnf-image-based-upgrade-shared-container-partition.adoc[levelof
 
 include::modules/cnf-image-based-upgrade-seed-image-config.adoc[leveloffset=+1]
 
-include::modules/cnf-image-based-upgrade-generate-seed-image.adoc[leveloffset=+1]
+include::modules/cnf-image-based-upgrade-generate-seed-image.adoc[leveloffset=+1]

edge_computing/image-base-install/ibi-factory-image-based-install.adoc renamed to edge_computing/image_base_install/ibi-factory-image-based-install.adoc

@@ -0,0 +1,131 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="ibi-understanding-image-based-install"]
+= Understanding image-based installation and deployment for {sno}
+include::_attributes/common-attributes.adoc[]
+:context: ibi-understanding-image-based-install
+
+toc::[]
+
+Image-based installations significantly reduce the deployment time of {sno} clusters by streamlining the installation process.
+
+This approach enables the preinstallation of configured and validated instances of {sno} on target hosts. These preinstalled hosts can be rapidly reconfigured and deployed at the far edge of the network, including in disconnected environments, with minimal intervention.
+
+[NOTE]
+====
+To deploy a managed cluster using an imaged-based approach in combination with {ztp-first}, you can use the SiteConfig operator. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html-single/multicluster_engine_operator_with_red_hat_advanced_cluster_management/index#siteconfig-intro[SiteConfig operator].
+====
+
+[id="ibi-installation-deployment-overview_{context}"]
+== Overview of image-based installation and deployment for {sno} clusters
+
+Deploying infrastructure at the far edge of the network presents challenges for service providers with low bandwidth, high latency, and disconnected environments. 
+It is also costly and time-consuming to install and deploy {sno} clusters.
+
+An image-based approach to installing and deploying {sno} clusters at the far edge of the network overcomes these challenges by separating the installation and deployment stages.
+
+.Overview of an image-based installation and deployment for managed {sno} clusters
+image::../images/711_OpenShift_IBI_Installation_high-level_0624.png[Overview of an image-based installation and deployment]
+
+Imaged-based installation::
+Preinstall multiple hosts with {sno} at a central site, such as a service depot or a factory.
+Then, validate the base configuration for these hosts and leverage the image-based approach to perform reproducible factory installs at scale by using a single live installation ISO.
+
+Image-based deployment::
+Ship the preinstalled and validated hosts to a remote site and rapidly reconfigure and deploy the clusters in a matter of minutes by using a configuration ISO.
+
+You can choose from two methods to preinstall and configure your SNO clusters.
+
+Using the `openshift-install` program::
+For a {sno} cluster, use the `openshift-install` program only to manually create the live installation ISO that is common to all hosts. Then, use the program again to create the configuration ISO which ensures that the host is unique. For more information, see “Deploying managed {sno} using the openshift-install program”.
+
+Using the IBI Operator::
+For managed {sno} clusters, you can use the `openshift-install` with the Image Based Install (IBI) Operator to scale up the operations. The program creates the live installation ISO and then the IBI Operator creates one configuration ISO for each host. For more information, see “Deploying {sno} using the IBI Operator”.
+
+[id="ibi-installation-overview_{context}"]
+=== Image-based installation for {sno} clusters
+
+Using the {lcao}, you can generate an OCI container image that encapsulates an instance of a {sno} cluster. This image is derived from a dedicated cluster that you can configure with the target {product-title} version.  
+
+You can reference this image in a live installation ISO to consistently preinstall configured and validated instances of {sno} to multiple hosts. This approach enables the preparation of hosts at a central location, for example in a factory or service depot, before shipping the preinstalled hosts to a remote site for rapid reconfiguration and deployment. The instructions for preinstalling a host are the same whether you deploy the host by using only the `openshift-install` program or using the program with the IBI Operator.
+
+The following is a high-level overview of the image-based installation process:
+
+. Generate an image from a {sno} cluster.
+. Use the `openshift-install` program to embed the seed image URL, and other installation artifacts, in a live installation ISO.
+. Start the host using the live installation ISO to preinstall the host. 
++
+During this process, the `openshift-install` program installs {op-system-first} to the disk, pulls the image you generated, and precaches release container images to the disk.
+
+. When the installation completes, the host is ready to ship to the remote site for rapid reconfiguration and deployment.
+
+[id="ibi-deployment-overview_{context}"]
+=== Image-based deployment for {sno} clusters
+
+You can use the `openshift-install` program or the IBI Operator to configure and deploy a host that you preinstalled with an image-based installation.
+
+{sno-caps} cluster deployment::
+
+To configure the target host with site-specific details by using the `openshift-install` program, you must create the following resources:
++
+--
+* The `install-config.yaml` installation manifest
+
+* The `image-based-config.yaml` manifest
+--
++
+The `openshift-install` program uses these resources to generate a configuration ISO that you attach to the preinstalled target host to complete the deployment.
+
+Managed {sno} cluster deployment::
+
+{rh-rhacm-first} and the {mce} (MCE) use a hub-and-spoke architecture to manage and deploy {sno} clusters across multiple sites. Using this approach, the hub cluster serves as a central control plane that manages the spoke clusters, which are often remote {sno} clusters deployed at the far edge of the network.
++
+You can define the site-specific configuration resources for an image-based deployment in the hub cluster. The IBI Operator uses these configuration resources to reconfigure the preinstalled host at the remote site and deploy the host as a managed {sno} cluster. This approach is especially beneficial for telecommunications providers and other service providers with extensive, distributed infrastructures, where an end-to-end installation at the remote site would be time-consuming and costly.
++
+The following is a high-level overview of the image-based deployment process for hosts preinstalled with an imaged-based installation:
++
+--
+* Define the site-specific configuration resources for the preinstalled host in the hub cluster.
+* Apply these resources in the hub cluster. This initiates the deployment process.
+* The IBI Operator creates a configuration ISO.
+* The IBI Operator boots the target preinstalled host with the configuration ISO attached.
+* The host mounts the configuration ISO and begins the reconfiguration process.
+* When the reconfiguration completes, the {sno} cluster is ready.
+--
++
+As the host is already preinstalled using an image-based installation, a technician can reconfigure and deploy the host in a matter of minutes.
+
+[id="ibi-installation-deployment-components_{context}"]
+== Image-based installation and deployment components
+
+The following content describes the components in an image-based installation and deployment.
+
+Seed image:: OCI container image generated from a dedicated cluster with the target {product-title} version.
+
+Seed cluster:: Dedicated {sno} cluster that you use to create a seed image and is deployed with the target {product-title} version.
+
+{lcao}:: Generates the seed image.
+
+Image Based Install (IBI) Operator:: When you deploy managed clusters, the IBI Operator creates a configuration ISO from the site-specific resources you define in the hub cluster, and attaches the configuration ISO to the preinstalled host by using a bare-metal provisioning service.
+
+`openshift-install` program:: Creates the installation and configuration ISO, and embeds the seed image URL in the live installation ISO. If the IBI Operator is not used, you must manually attach the configuration ISO to a preinstalled host to complete the deployment.
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../edge_computing/image_base_install/ibi_deploying_sno_clusters/ibi-edge-image-based-install-standalone.adoc#create-standalone-config-iso_ibi-edge-image-based-install[Deploying a {sno} cluster using the `openshift-install` program]
+
+include::modules/ibi-image-based-install-cluster-guide.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../edge_computing/image_base_install/ibi-preparing-for-image-based-install.adoc#cnf-image-based-upgrade-shared-container-partition_ibi-preparing-image-based-install[Configuring a shared container partition between ostree stateroots]
+
+include::modules/ibi-validated-software-versions.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/about/welcome-to-red-hat-advanced-cluster-management-for-kubernetes#multicluster-architecture[Multicluster architecture]
+
+* xref:../../edge_computing/image_based_upgrade/cnf-understanding-image-based-upgrade.adoc#cnf-understanding-image-based-upgrade[Understanding the image-based upgrade for {sno} clusters]

edge_computing/image-base-install/ibi-preparing-for-image-based-install.adoc renamed to edge_computing/image_base_install/ibi-preparing-for-image-based-install.adoc

@@ -0,0 +1 @@
+../../../_attributes/

edge_computing/image_base_install/ibi-understanding-image-based-install.adoc

@@ -13,9 +13,10 @@ include::modules/ibi-create-standalone-config-iso.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../openshift_images/managing_images/using-image-pull-secrets.adoc#using-image-pull-secrets[Using image pull secrets]
+* xref:../../../openshift_images/managing_images/using-image-pull-secrets.adoc[Using image pull secrets]
 
-include::modules/ibi-installer-configuration-config.adoc[leveloffset=+2]
+* xref:../../../edge_computing/image_base_install/ibi_deploying_sno_clusters/ibi-edge-image-based-install-standalone.adoc#ibi-installer-configuration-config_ibi-edge-image-based-install[Reference specifications for the `image-based-installation-config.yaml` manifest]
 
-include::modules/ibi-extra-manifests-standalone.adoc[leveloffset=+1]
+include::modules/ibi-installer-configuration-config.adoc[leveloffset=+2]
 
+include::modules/ibi-extra-manifests-standalone.adoc[leveloffset=+1]