TELCODOCS-1887: Adding section for IBI workflow

Author: rohennes

_topic_maps/_topic_map.yml

@@ -3317,38 +3317,17 @@ Topics:
     File: cnf-image-based-upgrade-base
   - Name: Performing an image-based upgrade for single-node OpenShift clusters using GitOps ZTP
     File: ztp-image-based-upgrade
-# Remove RDS from published docs until 4.16 RDS is released
-# ---
-# Name: Reference design specifications
-# Dir: telco_ref_design_specs
-# Distros: openshift-telco
-# Topics:
-# - Name: Telco reference design specifications
-#   File: telco-ref-design-specs-overview
-# - Name: Telco RAN DU reference design specification
-#   Dir: ran
-#   Topics:
-#   - Name: Telco RAN DU reference design overview
-#     File: telco-ran-ref-design-spec
-#   - Name: Telco RAN DU use model overview
-#     File: telco-ran-du-overview
-#   - Name: RAN DU reference design components
-#     File: telco-ran-ref-du-components
-#   - Name: RAN DU reference design configuration CRs
-#     File: telco-ran-ref-du-crs
-#   - Name: Telco RAN DU software specifications
-#     File: telco-ran-ref-software-artifacts
-# - Name: Telco core reference design specification
-#   Dir: core
-#   Topics:
-#   - Name: Telco core reference design overview
-#     File: telco-core-rds-overview
-#   - Name: Telco core use model overview
-#     File: telco-core-rds-use-cases
-#   - Name: Core reference design components
-#     File: telco-core-ref-design-components
-#   - Name: Core reference design configuration CRs
-#     File: telco-core-ref-crs
+- Name: Image-based installation for single-node OpenShift
+  Dir: image-base-install
+  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
+    File: ibi-factory-image-based-install
+  - Name: Deploying single-node OpenShift using the installation program
+    File: ibi-edge-image-based-install-standalone
 ---
 Name: Specialized hardware and driver enablement
 Dir: hardware_enablement

edge_computing/image-base-install/_attributes

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

edge_computing/image-base-install/ibi-edge-image-based-install-standalone.adoc

@@ -0,0 +1,21 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="ibi-image-based-install-standalone"]
+= About image-based deployments for {sno}
+include::_attributes/common-attributes.adoc[]
+:context: ibi-edge-image-based-install
+
+toc::[]
+
+You can manually generate a configuration ISO by using the {product-title} installation program. Attach the configuration ISO to your preinstalled target host to complete the deployment.
+
+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]
+
+include::modules/ibi-installer-configuration-config.adoc[leveloffset=+2]
+
+include::modules/ibi-extra-manifests-standalone.adoc[leveloffset=+1]
+

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

@@ -0,0 +1,29 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="ibi-image-based-install_{context}"]
+= About image-based installations for {sno} clusters
+include::_attributes/common-attributes.adoc[]
+:context: ibi-factory-image-based-install
+
+toc::[]
+
+Use the `openshift-install` installation program to create a live installation ISO for preinstalling {sno} on bare-metal hosts. For more information about downloading the installation program, see _"Installation process"_ in the _"Additional resources"_ section.
+
+The installation program takes a seed image URL and other inputs, such as the release version of the seed image and the disk to use for the installation process, and creates a live installation ISO. You can then start the host using the live installation ISO to begin preinstallation. When preinstallation is complete, the host is ready to ship to a remote site for the final site-specific configuration and deployment.
+
+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.
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../installing/overview/index.adoc#installation-process_ocp-installation-overview[Installation process]
+
+include::modules/ibi-create-iso-for-bmh.adoc[leveloffset=+1]
+
+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/ibi-preparing-for-image-based-install.adoc

@@ -0,0 +1,25 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="ibi-preparing-for-image-based-install_{context}"]
+= Preparing for an image-based installation for {sno} clusters
+include::_attributes/common-attributes.adoc[]
+:context: ibi-preparing-image-based-install
+
+toc::[]
+To prepare for an image-based installation for {sno} clusters, you must complete the following tasks:
+
+* 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".
+
+== 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.
+
+include::modules/cnf-image-based-upgrade-installing-lifecycle-agent-using-cli.adoc[leveloffset=+2]
+
+include::modules/cnf-image-based-upgrade-installing-lifecycle-agent-using-web-console.adoc[leveloffset=+2]
+
+include::modules/cnf-image-based-upgrade-shared-container-partition.adoc[leveloffset=+1]
+
+include::modules/cnf-image-based-upgrade-seed-image-config.adoc[leveloffset=+1]
+
+include::modules/cnf-image-based-upgrade-generate-seed-image.adoc[leveloffset=+1]

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

@@ -0,0 +1,71 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="ibi-image-based-install_overview"]
+= Understanding an image-based installation and deployment for {sno} clusters
+include::_attributes/common-attributes.adoc[]
+:context: ibi-understanding-image-based-install
+
+toc::[]
+
+Image-based installations streamline the deployment process for {sno} clusters by significantly reducing installation and deployment times.
+
+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.
+
+[id="ibi-installation-deployment-overview"]
+== 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.
+
+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 container image.
+
+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 image.
+
+[id="ibi-installation-overview"]
+=== 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 following is a high-level overview of the image-based installation process:
+
+* Generate an image from a {sno} cluster.
+* Use the {product-title} installation 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 {product-title} installation 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"]
+=== Image-based deployment for {sno} clusters
+
+You can use the {product-title} installation program to configure and deploy a host that you preinstalled with an image-based installation. To configure the target host with site-specific details, 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.
+
+[id="ibi-installation-deployment-components"]
+== Image-based installation and deployment components
+
+TThe 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, embeds the seed image URL in the live installation ISO, and reconfigures the host during remote site deployment.
+
+`openshift-install` installation program:: Use the `openshift-install` program to manually create a configuration ISO. Attach the configuration ISO to a preinstalled host to complete the deployment.
+
+include::modules/ibi-image-based-install-cluster-guide.adoc[leveloffset=+1]
+
+include::modules/ibi-validated-software-versions.adoc[leveloffset=+1]

edge_computing/image-base-install/images

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

edge_computing/image-base-install/modules

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

edge_computing/image-base-install/snippets

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

modules/cnf-image-based-upgrade-seed-image-config.adoc

@@ -1,13 +1,27 @@
 // Module included in the following assemblies:
 // * edge_computing/image-based-upgrade/cnf-preparing-for-image-based-upgrade.adoc
 
+ifeval::["{context}" == "ibi-preparing-image-based-install"]
+:ibi:
+endif::[]
+
+ifeval::["{context}" == "generate-seed"]
+:ibu:
+endif::[]
+
 :_mod-docs-content-type: PROCEDURE
 [id="cnf-image-based-upgrade-seed-image-config_{context}"]
 = Seed image configuration
 
+ifdef::ibu[]
 The seed image targets a set of {sno} clusters with the same hardware and similar configuration.
 This means that the seed image must have all of the components and configuration that the seed cluster shares with the target clusters.
 Therefore, the seed image generated from the seed cluster cannot contain any cluster-specific configuration.
+endif::[]
+
+ifdef::ibi[]
+You can create a seed image from a {sno} cluster with with the same hardware as your bare-metal host, and with a similar target cluster configuration. However, the seed image generated from the seed cluster cannot contain any cluster-specific configuration.
+endif::[]
 
 The following table lists the components, resources, and configurations that you must and must not include in your seed image:
 
@@ -47,9 +61,10 @@ a|Local volumes
 * `LocalVolume` for LSO
 * `LVMCluster` CR for LVMS
 |No
-
+ifdef::ibu[]
 |{oadp-short} `DataProtectionApplication` CR
 |No
+endif::[]
 |====
 . Dual-stack networking is not supported in this release.
 . If the seed cluster is installed in a disconnected environment, the target clusters must also be installed in a disconnected environment.
@@ -127,4 +142,13 @@ The following table lists the components, resources, and configurations that you
 a|`SriovNetwork.yaml`
 `SriovNetworkNodePolicy.yaml`
 |If the configuration, including namespaces, is exactly the same on both the seed and target cluster, you can include them in the seed image. Otherwise, apply them as extra manifests.
-|====
+|====
+
+
+ifeval::["{context}" == "ibi-preparing-image-based-install"]
+:!ibi:
+endif::[]
+
+ifeval::["{context}" == "generate-seed"]
+:!ibu:
+endif::[]

modules/cnf-image-based-upgrade-shared-container-partition.adoc

@@ -1,17 +1,31 @@
 // Module included in the following assemblies:
 // * edge_computing/image-based-upgrade/cnf-preparing-for-image-based-upgrade.adoc
 
+ifeval::["{context}" == "ibi-preparing-image-based-install"]
+:ibi:
+endif::[]
+
+ifeval::["{context}" == "shared-container-partition"]
+:ibu:
+endif::[]
+
 :_mod-docs-content-type: PROCEDURE
 [id="cnf-image-based-upgrade-shared-container-partition_{context}"]
 = Configuring a shared container partition between ostree stateroots
 
+ifdef::ibu[]
 Apply a `MachineConfig` to both the seed and the target clusters during installation time to create a separate partition and share the `/var/lib/containers` partition between the two `ostree` stateroots that will be used during the upgrade process.
+endif::[]
 
 [IMPORTANT]
 ====
 You must complete this procedure at installation time.
 ====
 
+ifdef::ibi[]
+Apply a `MachineConfig` to the seed cluster to create a separate partition and share the `/var/lib/containers` partition between the two `ostree` stateroots that will be used during the preinstall process.
+endif::[]
+
 .Procedure
 
 * Apply a `MachineConfig` to create a separate partition:
@@ -65,4 +79,12 @@ spec:
 ----
 <1> Specify the root disk.
 <2> Specify the start of the partition in MiB. If the value is too small, the installation will fail.
-<3> Specify a minimum size for the partition of 500 GB to ensure adequate disk space for precached images. If the value is too small, the deployments after installation will fail.
+<3> Specify a minimum size for the partition of 500 GB to ensure adequate disk space for precached images. If the value is too small, the deployments after installation will fail.
+
+ifeval::["{context}" == "ibi-preparing-image-based-install"]
+:!ibi:
+endif::[]
+
+ifeval::["{context}" == "shared-container-partition"]
+:!ibu:
+endif::[]