Merge pull request #78462 from adellape/new_extension_book

New Extensions book for OLMv1

Author: adellape

_attributes/common-attributes.adoc

@@ -214,9 +214,9 @@ endif::[]
 :olmv0-caps: Legacy OLM
 :olmv0-first: legacy Operator Lifecycle Manager (OLM)
 :olmv0-first-caps: Legacy Operator Lifecycle Manager (OLM)
-//Next-gen (OCP 4.14+) Operator Lifecycle Manager, aka "v1"
-:olmv1: OLM 1.0
-:olmv1-first: Operator Lifecycle Manager (OLM) 1.0
+//Next-gen (OCP 4.14+) Operator Lifecycle Manager, f/k/a "1.0"
+:olmv1: OLM v1
+:olmv1-first: Operator Lifecycle Manager (OLM) v1
 //
 :ztp-first: GitOps Zero Touch Provisioning (ZTP)
 :ztp: GitOps ZTP

_topic_maps/_topic_map.yml

@@ -1955,25 +1955,48 @@ Topics:
     Distros: openshift-origin
 - Name: Cluster Operators reference
   File: operator-reference
-- Name: OLM 1.0 (Technology Preview)
+- Name: OLM v1 (Technology Preview)
   Dir: olm_v1
   Distros: openshift-origin,openshift-enterprise
   Topics:
-  - Name: About OLM 1.0
+  - Name: About OLM v1
     File: index
-  - Name: Components and architecture
-    Dir: arch
-    Topics:
-    - Name: Components overview
-      File: olmv1-components
-    - Name: Operator Controller
-      File: olmv1-operator-controller
-    - Name: RukPak
-      File: olmv1-rukpak
-    - Name: Catalogd
-      File: olmv1-catalogd
-  - Name: Installing an Operator from a catalog
-    File: olmv1-installing-an-operator-from-a-catalog
+---
+Name: Extensions (OLM v1)
+Dir: extensions
+Distros: openshift-enterprise,openshift-origin
+Topics:
+- Name: Extensions overview
+  File: index
+- Name: Architecture
+  Dir: arch
+  Topics:
+  - Name: Components overview
+    File: components
+  - Name: Operator Controller
+    File: operator-controller
+  - Name: Catalogd
+    File: catalogd
+- Name: Common terms
+  File: of-terms
+- Name: Catalogs
+  Dir: catalogs
+  Topics:
+  - Name: File-based catalogs
+    File: fbc
+  - Name: Red Hat-provided catalogs
+    File: rh-catalogs
+  - Name: Managing catalogs
+    File: managing-catalogs
+  - Name: Creating catalogs
+    File: creating-catalogs
+- Name: Cluster extensions
+  Dir: ce
+  Topics:
+  - Name: Managing extensions
+    File: managing-ce
+  - Name: Upgrade edges
+    File: upgrade-edges
 ---
 Name: CI/CD
 Dir: cicd

extensions/_attributes

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

extensions/arch/_attributes

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

extensions/arch/catalogd.adoc

@@ -0,0 +1,19 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="catalogd"]
+= Catalogd
+include::_attributes/common-attributes.adoc[]
+:context: catalogd
+
+toc::[]
+
+:FeatureName: {olmv1-first}
+include::snippets/technology-preview.adoc[]
+
+{olmv1-first} uses the catalogd component and its resources to manage Operator and extension catalogs.
+
+include::modules/olmv1-about-catalogs.adoc[leveloffset=+1]
+[role="_additional-resources"]
+.Additional resources
+* xref:../../extensions/catalogs/fbc.adoc#fbc[File-based catalogs]
+* xref:../../extensions/catalogs/managing-catalogs.adoc#olmv1-adding-a-catalog-to-a-cluster_managing-catalogs[Adding a catalog to a cluster]
+* xref:../../extensions/catalogs/rh-catalogs.adoc#rh-catalogs[Red Hat-provided catalogs]

extensions/arch/components.adoc

@@ -0,0 +1,16 @@
+:_mod-docs-content-type: ASSEMBLY
+include::_attributes/common-attributes.adoc[]
+[id="olm-components"]
+= {olmv1} components overview
+:context: olm-components
+
+toc::[]
+
+:FeatureName: {olmv1-first}
+include::snippets/technology-preview.adoc[]
+
+{olmv1-first} comprises the following component projects:
+
+Operator Controller:: xref:../../extensions/arch/operator-controller.adoc#operator-controller[Operator Controller] is the central component of {olmv1} that extends Kubernetes with an API through which users can install and manage the lifecycle of Operators and extensions. It consumes information from catalogd.
+
+Catalogd:: xref:../../extensions/arch/catalogd.adoc#catalogd[Catalogd] is a Kubernetes extension that unpacks file-based catalog (FBC) content packaged and shipped in container images for consumption by on-cluster clients. As a component of the {olmv1} microservices architecture, catalogd hosts metadata for Kubernetes extensions packaged by the authors of the extensions, and as a result helps users discover installable content.

extensions/arch/images

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

extensions/arch/modules

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

operators/olm_v1/arch/olmv1-operator-controller.adoc renamed to extensions/arch/operator-controller.adoc

@@ -1,20 +1,20 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="olmv1-operator-controller"]
-= Operator Controller (Technology Preview)
+[id="operator-controller"]
+= Operator Controller
 include::_attributes/common-attributes.adoc[]
-:context: olmv1-operator-controller
+:context: operator-controller
 
 toc::[]
 
-Operator Controller is the central component of {olmv1-first} and consumes the other {olmv1} component, catalogd. It extends Kubernetes with an API through which users can install Operators and extensions.
-
-:FeatureName: {olmv1}
+:FeatureName: {olmv1-first}
 include::snippets/technology-preview.adoc[]
 
+Operator Controller is the central component of {olmv1-first} and consumes the other {olmv1} component, catalogd. It extends Kubernetes with an API through which users can install Operators and extensions.
+
 include::modules/olmv1-clusterextension-api.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../../operators/understanding/olm/olm-colocation.adoc#olm-colocation[Operator Lifecycle Manager (OLM) -> Multitenancy and Operator colocation]
+* xref:../../operators/understanding/olm/olm-colocation.adoc#olm-colocation[Operator Lifecycle Manager (OLM) -> Multitenancy and Operator colocation]
 
 include::modules/olmv1-about-target-versions.adoc[leveloffset=+2]

extensions/arch/snippets

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