Merge pull request #78320 from amolnar-rh/IBU-peer-review-update

TELCODOCS-1932: Implement peer review feedback post-GA

Author: skopacz1

_topic_maps/_topic_map.yml

@@ -3147,20 +3147,52 @@ Topics:
     Dir: preparing_for_image_based_upgrade
     Distros: openshift-origin,openshift-enterprise
     Topics:
-    - Name: Configuring a shared container directory for the image-based upgrade
-      File: cnf-image-based-upgrade-shared-container-image
+    - Name: Configuring a shared container partition for the image-based upgrade
+      File: cnf-image-based-upgrade-shared-container-partition
     - Name: Installing Operators for the image-based upgrade
       File: cnf-image-based-upgrade-install-operators
-    - Name: Generating a seed image for the image-based upgrade with Lifecycle Agent
+    - Name: Generating a seed image for the image-based upgrade with the Lifecycle Agent
       File: cnf-image-based-upgrade-generate-seed
-    - Name: Creating ConfigMap objects for the image-based upgrade with Lifecycle Agent
+    - Name: Creating ConfigMap objects for the image-based upgrade with the Lifecycle Agent
       File: cnf-image-based-upgrade-prep-resources
     - Name: Creating ConfigMap objects for the image-based upgrade with Lifecycle Agent using GitOps ZTP
       File: ztp-image-based-upgrade-prep-resources
-  - Name: Performing an image-based upgrade for single-node OpenShift clusters
+  - Name: Performing an image-based upgrade for single-node OpenShift clusters with the Lifecycle Agent
     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: Specialized hardware and driver enablement
 Dir: hardware_enablement

edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc

@@ -1,8 +1,8 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="cnf-image-based-upgrade-for-sno"]
-= Performing an image-based upgrade for {sno} clusters
+[id="cnf-image-based-upgrade"]
+= Performing an image-based upgrade for {sno} clusters with the {lcao}
 include::_attributes/common-attributes.adoc[]
-:context: cnf-image-based-upgrade
+:context: cnf-non-gitops
 
 toc::[]
 
@@ -16,14 +16,14 @@ include::modules/cnf-image-based-upgrade-prep.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-prep-resources.adoc#cnf-image-based-upgrade-prep-resources[Creating ConfigMap objects for the image-based upgrade with Lifecycle Agent]
+* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-prep-resources.adoc#cnf-image-based-upgrade-prep-resources[Creating ConfigMap objects for the image-based upgrade with {lcao}]
 
 include::modules/cnf-image-based-upgrade-with-backup.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#ztp-image-based-upgrade-rollback_cnf-image-based-upgrade[(Optional) Moving to the Rollback stage of the image-based upgrade with Lifecycle Agent]
+* xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade-rollback_cnf-non-gitops[Moving to the Rollback stage of the image-based upgrade with {lcao}]
 
 include::modules/cnf-image-based-upgrade-rollback.adoc[leveloffset=+1]
 

edge_computing/image_based_upgrade/cnf-understanding-image-based-upgrade.adoc

@@ -1,7 +1,7 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="understanding-image-based-upgrade-for-sno"]
-= Understanding the image-based upgrade for {sno} clusters
 include::_attributes/common-attributes.adoc[]
+[id="cnf-understanding-image-based-upgrade"]
+= Understanding the image-based upgrade for {sno} clusters
 :context: understanding-image-based-upgrade
 
 toc::[]
@@ -72,13 +72,13 @@ include::modules/cnf-image-based-upgrade.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade-for-sno[Performing an image-based upgrade with Lifecycle Agent]
+* xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade[Performing an image-based upgrade for {sno} clusters with {lcao}]
 
-* xref:../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade-for-sno[Performing an image-based upgrade with Lifecycle Agent and GitOps ZTP]
+* xref:../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade[Performing an image-based upgrade for {sno} clusters using {ztp}]
 
-* xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#ztp-image-based-upgrade-rollback_cnf-image-based-upgrade[(Optional) Moving to the Rollback stage of the image-based upgrade with Lifecycle Agent]
+* xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade-rollback_cnf-non-gitops[Moving to the Rollback stage of the image-based upgrade with {lcao}]
 
-* xref:../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade-with-talm-rollback_ztp-image-based-upgrade[(Optional) Moving to the Rollback stage of the image-based upgrade with Lifecycle Agent and GitOps ZTP]
+* xref:../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade-rollback_ztp-gitops[Moving to the Rollback stage of the image-based upgrade with {lcao} and {ztp}]
 
 include::modules/cnf-image-based-upgrade-guidelines.adoc[leveloffset=+1]
 
@@ -87,36 +87,36 @@ include::modules/cnf-image-based-upgrade-guidelines.adoc[leveloffset=+1]
 
 * xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[Mirroring images for a disconnected installation]
 
-include::modules/ztp-image-based-upgrade-cluster-validated-software.adoc[leveloffset=+2]
+include::modules/cnf-image-based-upgrade-cluster-validated-software.adoc[leveloffset=+2]
 
 include::modules/ztp-image-based-upgrade-hub-cluster-guide.adoc[leveloffset=+2]
 
-include::modules/ztp-image-based-upgrade-seed-image-guide.adoc[leveloffset=+2]
+include::modules/cnf-image-based-upgrade-seed-image-guide.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-image.adoc#cnf-image-based-upgrade-shared-container-directory_shared-container-directory[Configuring a shared container directory between ostree stateroots]
+* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc#cnf-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots]
 
-* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-image.adoc#ztp-image-based-upgrade-shared-container-directory_shared-container-directory[Configuring a shared container directory between ostree stateroots when using GitOps ZTP]
+* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc#ztp-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots when using {ztp}]
 
-* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-generate-seed.adoc#ztp-image-based-seed-image-config_generate-seed[Seed image configuration]
+* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-generate-seed.adoc#cnf-image-based-upgrade-seed-image-config_generate-seed[Seed image configuration]
 
-include::modules/ztp-image-based-upgrade-backup-guide.adoc[leveloffset=+2]
+include::modules/cnf-image-based-upgrade-backup-guide.adoc[leveloffset=+2]
 
-include::modules/ztp-image-based-upgrade-extra-manifests-guide.adoc[leveloffset=+2]
+include::modules/cnf-image-based-upgrade-extra-manifests-guide.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade-for-sno[Performing an image-based upgrade with Lifecycle Agent]
+* xref:../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade[Performing an image-based upgrade for {sno} clusters with {lcao}]
 
-* xref:../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade-for-sno[Performing an image-based upgrade with Lifecycle Agent and GitOps ZTP]
+* xref:../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade[Performing an image-based upgrade for {sno} clusters using {ztp}]
 
 * xref:../../edge_computing/ztp-preparing-the-hub-cluster.adoc#ztp-preparing-the-hub-cluster[Preparing the hub cluster for ZTP]
 
-* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-prep-resources.adoc#cnf-image-based-upgrade-creating-backup-oadp-resources_nongitops[Creating ConfigMap objects for the image-based upgrade with Lifecycle Agent]
+* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-prep-resources.adoc#cnf-image-based-upgrade-prep-oadp_cnf-non-gitops[Creating ConfigMap objects for the image-based upgrade with {lcao}]
 
-* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/ztp-image-based-upgrade-prep-resources.adoc#ztp-image-based-upgrade-prep-resources[Creating ConfigMap objects for the image-based upgrade with GitOps ZTP]
+* xref:../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/ztp-image-based-upgrade-prep-resources.adoc#ztp-image-based-upgrade-prep-resources[Creating ConfigMap objects for the image-based upgrade with {ztp}]
 
 * xref:../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc#about-installing-oadp[About installing OADP]

edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-generate-seed.adoc

@@ -1,23 +1,20 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="cnf-image-based-upgrade-seed-image"]
-= Generating a seed image for the image-based upgrade with {lcao}
+[id="cnf-image-based-upgrade-generate-seed-image"]
+= Generating a seed image for the image-based upgrade with the {lcao}
 include::_attributes/common-attributes.adoc[]
 :context: generate-seed
 
 toc::[]
 
 Use the {lcao} to generate the seed image with the `SeedGenerator` custom resource (CR).
 
-:FeatureName: The Lifecycle Agent
-
-
 include::modules/cnf-image-based-upgrade-seed-image-config.adoc[leveloffset=+1]
 
 include::modules/cnf-image-based-upgrade-generate-seed-image.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-image.adoc#cnf-image-based-upgrade-shared-container-directory_shared-container-directory[Configuring a shared container directory between ostree stateroots]
+* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc#cnf-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots]
 
-* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-image#ztp-image-based-upgrade-shared-container-directory_shared-container-directory[Configuring a shared container directory between ostree stateroots when using GitOps ZTP]
+* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition#ztp-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots when using {ztp}]

edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-install-operators.adoc

@@ -25,6 +25,6 @@ include::modules/cnf-image-based-upgrade-installing-lifecycle-agent-using-cli.ad
 
 include::modules/cnf-image-based-upgrade-installing-lifecycle-agent-using-web-console.adoc[leveloffset=+1]
 
-include::modules/ztp-image-based-upgrade-installing-lcao-with-gitops.adoc[leveloffset=+1]
+include::modules/ztp-image-based-upgrade-installing-lca.adoc[leveloffset=+1]
 
-include::modules/ztp-image-based-upgrade-installing-oadp-with-gitops.adoc[leveloffset=+1]
+include::modules/ztp-image-based-upgrade-installing-oadp.adoc[leveloffset=+1]

edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-prep-resources.adoc

@@ -1,8 +1,8 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="cnf-image-based-upgrade-prep-resources"]
-= Creating ConfigMap objects for the image-based upgrade with {lcao}
+= Creating ConfigMap objects for the image-based upgrade with the {lcao}
 include::_attributes/common-attributes.adoc[]
-:context: nongitops
+:context: cnf-non-gitops
 
 toc::[]
 
@@ -13,7 +13,7 @@ include::modules/cnf-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-image.adoc#cnf-image-based-upgrade-shared-container-directory_shared-container-directory[Configuring a shared container directory between ostree stateroots]
+* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc#cnf-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots]
 
 * xref:../../../backup_and_restore/application_backup_and_restore/installing/about-installing-oadp.adoc[About installing OADP]
 
@@ -26,4 +26,4 @@ include::modules/cnf-image-based-upgrade-prep-catalogsource.adoc[leveloffset=+1]
 
 * xref:../../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource_olm-understanding-olm[Catalog source]
 
-* xref:../../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade-for-sno[Performing an image-based upgrade with Lifecycle Agent]
+* xref:../../../edge_computing/image_based_upgrade/cnf-image-based-upgrade-base.adoc#cnf-image-based-upgrade[Performing an image-based upgrade for {sno} with {lcao}]

edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-image.adoc

@@ -0,0 +1,14 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="cnf-image-based-upgrade-shared-container-partition"]
+= Configuring a shared container partition for the image-based upgrade
+include::_attributes/common-attributes.adoc[]
+:context: shared-container-partition
+
+toc::[]
+
+Your {sno} clusters need to have a shared `var/lib/containers` partition for the image-based upgrade.
+You can do this at install time.
+
+include::modules/cnf-image-based-upgrade-shared-container-partition.adoc[leveloffset=+1]
+
+include::modules/ztp-image-based-upgrade-shared-container-partition.adoc[leveloffset=+1]

edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc

@@ -1,6 +1,6 @@
 :_mod-docs-content-type: ASSEMBLY
 [id="ztp-image-based-upgrade-prep-resources"]
-= Creating ConfigMap objects for the image-based upgrade with {lcao} using {ztp}
+= Creating ConfigMap objects for the image-based upgrade with the {lcao} using {ztp}
 include::_attributes/common-attributes.adoc[]
 :context: ztp-gitops
 
@@ -13,15 +13,15 @@ include::modules/ztp-image-based-upgrade-prep-oadp.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-image.adoc#ztp-image-based-upgrade-shared-container-directory_shared-container-directory[Configuring a shared container directory between ostree stateroots when using GitOps ZTP]
+* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc#ztp-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots when using {ztp}]
 
-* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-install-operators#ztp-image-based-upgrade-installing-oadp-with-gitops_install-operators[Installing and configuring the OADP Operator with GitOps ZTP]
+* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-install-operators#ztp-image-based-upgrade-installing-oadp_install-operators[Installing and configuring the OADP Operator with {ztp}]
 
 include::modules/ztp-image-based-upgrade-prep-label-extramanifests.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-image.adoc#ztp-image-based-upgrade-shared-container-directory_shared-container-directory[Configuring a shared container directory between ostree stateroots when using GitOps ZTP]
+* xref:../../../edge_computing/image_based_upgrade/preparing_for_image_based_upgrade/cnf-image-based-upgrade-shared-container-partition.adoc#ztp-image-based-upgrade-shared-container-partition_shared-container-partition[Configuring a shared container partition between ostree stateroots when using {ztp}]
 
-* xref:../../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade-for-sno[Performing an image-based upgrade for {sno} clusters using GitOps ZTP]
+* xref:../../../edge_computing/image_based_upgrade/ztp-image-based-upgrade.adoc#ztp-image-based-upgrade[Performing an image-based upgrade for {sno} clusters using {ztp}]