Split Operators guide into user/admin tasks

_topic_map.yml

@@ -796,67 +796,79 @@ Name: Operators
 Dir: operators
 Topics:
 - Name: Understanding Operators
-  File: olm-what-operators-are
-- Name: Common terms
-  File: olm-common-terms
-- Name: Packaging formats
-  File: olm-packaging-format
-- Name: Understanding Operator Lifecycle Manager (OLM)
-  Dir: understanding_olm
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin
-  Topics:
-  - Name: Concepts
-    File: olm-understanding-olm
-  - Name: Architecture
-    File: olm-arch
-  - Name: Workflow
-    File: olm-workflow
-  - Name: Dependency resolution
-    File: olm-understanding-dependency-resolution
-  - Name: OperatorGroups
-    File: olm-understanding-operatorgroups
-  - Name: Metrics
-    File: olm-understanding-metrics
-- Name: Understanding OperatorHub
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin
-  File: olm-understanding-operatorhub
-- Name: Adding Operators to a cluster
-  File: olm-adding-operators-to-cluster
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
-- Name: Configuring proxy support
-  File: olm-configuring-proxy-support
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin
-- Name: Deleting Operators from a cluster
-  File: olm-deleting-operators-from-cluster
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
-- Name: Creating applications from installed Operators
-  File: olm-creating-apps-from-installed-operators
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
-- Name: Viewing Operator status
-  File: olm-status
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
-- Name: Creating policy for Operator installations and upgrades
-  File: olm-creating-policy
-  Distros: openshift-origin,openshift-enterprise,openshift-webscale
-- Name: Managing admission webhooks in OLM
-  File: olm-webhooks
-  Distros: openshift-origin,openshift-enterprise,openshift-webscale
-- Name: Managing custom catalogs
-  File: olm-managing-custom-catalogs
-  Distros: openshift-origin,openshift-enterprise,openshift-webscale
-- Name: Using OLM on restricted networks
-  File: olm-restricted-networks
-  Distros: openshift-origin,openshift-enterprise,openshift-webscale
-- Name: CRDs
-  Dir: crds
+  Dir: understanding
+  Topics:
+  - Name: What are Operators?
+    File: olm-what-operators-are
+  - Name: Common terms
+    File: olm-common-terms
+  - Name: Packaging formats
+    File: olm-packaging-format
+  - Name: Operator Lifecycle Manager (OLM)
+    Dir: olm
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin
+    Topics:
+    - Name: Concepts
+      File: olm-understanding-olm
+    - Name: Architecture
+      File: olm-arch
+    - Name: Workflow
+      File: olm-workflow
+    - Name: Dependency resolution
+      File: olm-understanding-dependency-resolution
+    - Name: OperatorGroups
+      File: olm-understanding-operatorgroups
+    - Name: Metrics
+      File: olm-understanding-metrics
+  - Name: OperatorHub
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin
+    File: olm-understanding-operatorhub
+  - Name: CRDs
+    Dir: crds
+    Topics:
+    - Name: Extending the Kubernetes API with CRDs
+      File: crd-extending-api-with-crds
+      Distros: openshift-origin,openshift-enterprise,openshift-webscale
+    - Name: Managing resources from CRDs
+      File: crd-managing-resources-from-crds
+      Distros: openshift-origin,openshift-enterprise,openshift-webscale
+- Name: User tasks
+  Dir: user
   Topics:
-  - Name: Extending the Kubernetes API with CRDs
-    File: crd-extending-api-with-crds
+  - Name: Creating applications from installed Operators
+    File: olm-creating-apps-from-installed-operators
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
+  - Name: Installing Operators in your namespace
+    File: olm-installing-operators-in-namespace
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin
+  - Name: Managing admission webhooks in OLM
+    File: olm-webhooks
+    Distros: openshift-origin,openshift-enterprise,openshift-webscale
+- Name: Administrator tasks
+  Dir: admin
+  Topics:
+  - Name: Adding Operators to a cluster
+    File: olm-adding-operators-to-cluster
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
+  - Name: Configuring proxy support
+    File: olm-configuring-proxy-support
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin
+  - Name: Deleting Operators from a cluster
+    File: olm-deleting-operators-from-cluster
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
+  - Name: Viewing Operator status
+    File: olm-status
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
+  - Name: Allowing non-cluster administrators to install Operators
+    File: olm-creating-policy
+    Distros: openshift-origin,openshift-enterprise,openshift-webscale
+  - Name: Managing custom catalogs
+    File: olm-managing-custom-catalogs
     Distros: openshift-origin,openshift-enterprise,openshift-webscale
-  - Name: Managing resources from CRDs
-    File: crd-managing-resources-from-crds
+  - Name: Using OLM on restricted networks
+    File: olm-restricted-networks
     Distros: openshift-origin,openshift-enterprise,openshift-webscale
-- Name: Operator SDK
+- Name: Developing Operators
   Dir: operator_sdk
   Distros: openshift-origin,openshift-enterprise,openshift-webscale
   Topics:
@@ -883,7 +895,7 @@ Topics:
     Distros: openshift-origin
   - Name: Appendices
     File: osdk-appendices
-- Name: Red Hat Operators
+- Name: Red Hat Operators reference
   File: operator-reference
 ---
 Name: Builds

administering_a_cluster/dedicated-admin-role.adoc

@@ -48,4 +48,4 @@ namespace, except for the Cluster Logging Operator, which requires the
 
 .Additional resources
 
-* xref:../operators/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]
+* xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]

applications/application_life_cycle_management/creating-apps-from-installed-operators.adoc

@@ -15,7 +15,7 @@ installed Operator using the {product-title} web console.
 .Additional resources
 
 * See the
-xref:../../operators/olm-what-operators-are.adoc#olm-what-operators-are[Operators]
+xref:../../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Operators]
 guide for more on how Operators work and how the Operator Lifecycle Manager is
 integrated in {product-title}.
 

cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc

@@ -15,7 +15,7 @@ the service. If this YAML has placeholder values or sample values, a service can
 
 == Prerequisites
 * Install the `oc` CLI and log into the cluster.
-** Note that the configuration of the cluster determines the services available to you. To access the Operator services, a cluster administrator must install the respective Operator on the cluster first. To learn more, see xref:../../operators/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Adding Operators to the cluster].
+** Note that the configuration of the cluster determines the services available to you. To access the Operator services, a cluster administrator must install the respective Operator on the cluster first. To learn more, see xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Adding Operators to the cluster].
 * Install the `{odo-title}` CLI.
 * Enable experimental mode. To enable experimental mode in `{odo-title}`, run:
 `odo preference set Experimental true` or use the environment variable `odo config set --env ODO_EXPERIMENTAL=true`

jaeger/jaeger_install/rhbjaeger-removing.adoc

@@ -20,7 +20,7 @@ include::modules/jaeger-removing-instance-cli.adoc[leveloffset=+1]
 
 .Procedure
 
-. Follow the instructions for xref:../../operators/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster].
+. Follow the instructions for xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster].
 
 * Remove the Jaeger Operator.
 

jaeger/jaeger_install/rhbjaeger-updating.adoc

@@ -7,6 +7,6 @@ toc::[]
 
 The Operator Lifecycle Manager (OLM) controls the installation, upgrade, and role-based access control (RBAC) of Operators in a cluster. The OLM runs by default in {product-title}.
 The OLM queries for available Operators as well as upgrades for installed Operators.
-For more information about how {product-title} handled upgrades, refer to the xref:../../operators/understanding_olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager] documentation.
+For more information about how {product-title} handled upgrades, refer to the xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager] documentation.
 
 The update approach used by the Jaeger Operator upgrades the managed Jaeger instances to the version associated with the Operator. Whenever a new version of the Jaeger Operator is installed, all the Jaeger application instances managed by the Operator will be upgraded to the Operator’s  version.  For example, if version 1.10 is installed (both Operator and backend components) and the Operator is upgraded to version 1.11, then as soon as the Operator upgrade has completed, the Operator will scan for running Jaeger instances and upgrade them to 1.11 as well.

logging/cluster-logging-deploying.adoc

@@ -34,4 +34,4 @@ include::modules/cluster-logging-deploy-cli.adoc[leveloffset=+1]
 
 == Additional resources
 
-* For more information on installing Operators, see xref:../operators/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].
+* For more information on installing Operators, see xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Installing Operators from the OperatorHub].

metering/metering-uninstall.adoc

@@ -17,7 +17,7 @@ you must manually clean up S3 buckets that were used to store metering data.
 == Removing the Metering Operator from your cluster
 
 Remove the Metering Operator from your cluster by following the documentation on
-xref:../operators/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster].
+xref:../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster].
 
 [NOTE]
 ====

migration/migrating_3_4/deploying-cam-3-4.adoc

@@ -39,7 +39,7 @@ On the {product-title} 3 cluster, you can create a manifest file based on the Op
 
 .Additional resources
 
-* xref:../../operators/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
+* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
 
 include::modules/olm-building-operator-catalog-image.adoc[leveloffset=+2]
 include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2]

migration/migrating_3_4/planning-migration-3-to-4.adoc

@@ -44,7 +44,7 @@ For more information, see xref:../../architecture/architecture-rhcos.adoc#archit
 
 Operators are a method of packaging, deploying, and managing a Kubernetes application. Operators ease the operational complexity of running another piece of software. They watch over your environment and use the current state to make decisions in real time. Advanced Operators are designed to upgrade and react to failures automatically.
 
-For more information, see xref:../../operators/olm-what-operators-are.adoc#olm-what-operators-are[Understanding Operators].
+For more information, see xref:../../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Understanding Operators].
 
 [id="migration-differences-install"]
 === Installation and update differences

migration/migrating_4_1_4/deploying-cam-4-1-4.adoc

@@ -42,7 +42,7 @@ You can build a custom Operator catalog image for {product-title} 4, push it to
 
 .Additional resources
 
-* xref:../../operators/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
+* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
 
 include::modules/olm-building-operator-catalog-image.adoc[leveloffset=+2]
 include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2]

migration/migrating_4_2_4/deploying-cam-4-2-4.adoc

@@ -42,7 +42,7 @@ You can build a custom Operator catalog image for {product-title} 4, push it to
 
 .Additional resources
 
-* xref:../../operators/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
+* xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]
 
 include::modules/olm-building-operator-catalog-image.adoc[leveloffset=+2]
 include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2]

modules/crd-creating-aggregated-cluster-roles.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/crds/extending-api-with-crds.adoc
+// * operators/understanding/crds/extending-api-with-crds.adoc
 
 [id="crd-creating-aggregated-cluster-role_{context}"]
 = Creating cluster roles for Custom Resource Definitions

modules/crd-creating-crds.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/crds/extending-api-with-crds.adoc
+// * operators/understanding/crds/extending-api-with-crds.adoc
 
 [id="crd-creating-custom-resources-definition_{context}"]
 = Creating a Custom Resource Definition

modules/crd-creating-custom-resources-from-file.adoc

@@ -3,8 +3,8 @@
 // Module included in the following assemblies:
 //
 // * operators/olm-managing-resources-from-crds.adoc
-// * operators/crds/crd-managing-resources-from-crds.adoc
-// * operators/crds/extending-api-with-crds.adoc
+// * operators/understanding/crds/crd-managing-resources-from-crds.adoc
+// * operators/understanding/crds/extending-api-with-crds.adoc
 
 [id="crd-creating-custom-resources-from-file_{context}"]
 = Creating Custom Resources from a file

modules/crd-custom-resource-definitions.adoc

@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
-// * operators/crds/crd-managing-resources-from-crds.adoc
-// * operators/crds/extending-api-with-crds.adoc
+// * operators/understanding/crds/crd-managing-resources-from-crds.adoc
+// * operators/understanding/crds/extending-api-with-crds.adoc
 
 [id="crd-custom-resource-definitions_{context}"]
 = Custom Resource Definitions

modules/crd-inspecting-custom-resources.adoc

@@ -2,8 +2,8 @@
 //
 // Module included in the following assemblies:
 //
-// * operators/crds/crd-managing-resources-from-crds.adoc
-// * operators/crds/extending-api-with-crds.adoc
+// * operators/understanding/crds/crd-managing-resources-from-crds.adoc
+// * operators/understanding/crds/extending-api-with-crds.adoc
 
 [id="crd-inspecting-custom-resources_{context}"]
 = Inspecting custom resources

modules/olm-arch-catalog-operator.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/understanding_olm/olm-arch.adoc
+// * operators/understanding/olm/olm-arch.adoc
 
 [id="olm-arch-catalog-operator_{context}"]
 = Catalog Operator

modules/olm-arch-catalog-registry.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/understanding_olm/olm-arch.adoc
+// * operators/understanding/olm/olm-arch.adoc
 
 [id="olm-arch-catalog-registry_{context}"]
 = Catalog Registry

modules/olm-arch-olm-operator.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/understanding_olm/olm-arch.adoc
+// * operators/understanding/olm/olm-arch.adoc
 
 [id="olm-arch-olm-operator_{context}"]
 = OLM Operator

modules/olm-architecture.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/understanding_olm/olm-understanding-olm.adoc
+// * operators/understanding/olm/olm-understanding-olm.adoc
 
 [id="olm-architecture_{context}"]
 = Component responsibilities

modules/olm-bundle-format.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/understanding_olm/olm-packaging-format.adoc
+// * operators/understanding/olm/olm-packaging-format.adoc
 
 [id="olm-bundle-format_{context}"]
 = Bundle Format

modules/olm-catalogsource.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/understanding_olm/olm-understanding-olm.adoc
+// * operators/understanding/olm/olm-understanding-olm.adoc
 
 [id="olm-catalogsource_{context}"]
 = CatalogSource

modules/olm-crds.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/understanding_olm/olm-understanding-olm.adoc
+// * operators/understanding/olm/olm-understanding-olm.adoc
 
 [id="olm-resources_{context}"]
 = OLM resources

modules/olm-creating-etcd-cluster-from-operator.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/olm-creating-apps-from-installed-operators.adoc
+// * /operators/user/olm-creating-apps-from-installed-operators.adoc
 
 [id="olm-creating-etcd-cluster-from-operator_{context}"]
 = Creating an etcd cluster using an Operator

modules/olm-csv.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * operators/understanding_olm/olm-understanding-olm.adoc
+// * operators/understanding/olm/olm-understanding-olm.adoc
 
 [id="olm-csv_{context}"]
 = ClusterServiceVersion