diff --git a/_topic_map.yml b/_topic_map.yml index 998fe296325b..1848738e3873 100644 --- a/_topic_map.yml +++ b/_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 diff --git a/administering_a_cluster/dedicated-admin-role.adoc b/administering_a_cluster/dedicated-admin-role.adoc index a47a2934e8d4..34cf615c93c5 100644 --- a/administering_a_cluster/dedicated-admin-role.adoc +++ b/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] diff --git a/applications/application_life_cycle_management/creating-apps-from-installed-operators.adoc b/applications/application_life_cycle_management/creating-apps-from-installed-operators.adoc index 900c40661275..eb225a957e9b 100644 --- a/applications/application_life_cycle_management/creating-apps-from-installed-operators.adoc +++ b/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}. diff --git a/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc b/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc index a9edde4236a2..b61c11026052 100644 --- a/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc +++ b/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` diff --git a/jaeger/jaeger_install/rhbjaeger-removing.adoc b/jaeger/jaeger_install/rhbjaeger-removing.adoc index afcfc9701fcf..1a24540c5646 100644 --- a/jaeger/jaeger_install/rhbjaeger-removing.adoc +++ b/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. diff --git a/jaeger/jaeger_install/rhbjaeger-updating.adoc b/jaeger/jaeger_install/rhbjaeger-updating.adoc index ca2b7ad9586e..421eca48c71d 100644 --- a/jaeger/jaeger_install/rhbjaeger-updating.adoc +++ b/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. diff --git a/logging/cluster-logging-deploying.adoc b/logging/cluster-logging-deploying.adoc index 86ea3a0dbf59..ed0721ee6281 100644 --- a/logging/cluster-logging-deploying.adoc +++ b/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]. diff --git a/metering/metering-uninstall.adoc b/metering/metering-uninstall.adoc index 1729b184c578..5adf6c1e640d 100644 --- a/metering/metering-uninstall.adoc +++ b/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] ==== diff --git a/migration/migrating_3_4/deploying-cam-3-4.adoc b/migration/migrating_3_4/deploying-cam-3-4.adoc index 1a9ace78166f..5de4e2bc094f 100644 --- a/migration/migrating_3_4/deploying-cam-3-4.adoc +++ b/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] diff --git a/migration/migrating_3_4/planning-migration-3-to-4.adoc b/migration/migrating_3_4/planning-migration-3-to-4.adoc index 9f8d153549f1..e04e0aa1426e 100644 --- a/migration/migrating_3_4/planning-migration-3-to-4.adoc +++ b/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 diff --git a/migration/migrating_4_1_4/deploying-cam-4-1-4.adoc b/migration/migrating_4_1_4/deploying-cam-4-1-4.adoc index ce94ccd395f5..fca8d72e4a92 100644 --- a/migration/migrating_4_1_4/deploying-cam-4-1-4.adoc +++ b/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] diff --git a/migration/migrating_4_2_4/deploying-cam-4-2-4.adoc b/migration/migrating_4_2_4/deploying-cam-4-2-4.adoc index 19096db40a09..9053d3b19bcb 100644 --- a/migration/migrating_4_2_4/deploying-cam-4-2-4.adoc +++ b/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] diff --git a/modules/crd-creating-aggregated-cluster-roles.adoc b/modules/crd-creating-aggregated-cluster-roles.adoc index 9c29cb59cb3f..5f5ff743b04e 100644 --- a/modules/crd-creating-aggregated-cluster-roles.adoc +++ b/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 diff --git a/modules/crd-creating-crds.adoc b/modules/crd-creating-crds.adoc index 95d502922614..89227af7156f 100644 --- a/modules/crd-creating-crds.adoc +++ b/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 diff --git a/modules/crd-creating-custom-resources-from-file.adoc b/modules/crd-creating-custom-resources-from-file.adoc index 84a1138b57ed..72cfbb172f79 100644 --- a/modules/crd-creating-custom-resources-from-file.adoc +++ b/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 diff --git a/modules/crd-custom-resource-definitions.adoc b/modules/crd-custom-resource-definitions.adoc index 6b3c792a311f..8f159062d662 100644 --- a/modules/crd-custom-resource-definitions.adoc +++ b/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 diff --git a/modules/crd-inspecting-custom-resources.adoc b/modules/crd-inspecting-custom-resources.adoc index 2bf929f7ff1a..152c3c10565c 100644 --- a/modules/crd-inspecting-custom-resources.adoc +++ b/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 diff --git a/modules/olm-arch-catalog-operator.adoc b/modules/olm-arch-catalog-operator.adoc index f98c28f82674..c6ad2d95cd51 100644 --- a/modules/olm-arch-catalog-operator.adoc +++ b/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 diff --git a/modules/olm-arch-catalog-registry.adoc b/modules/olm-arch-catalog-registry.adoc index c11a6039f3ea..ea78da47270a 100644 --- a/modules/olm-arch-catalog-registry.adoc +++ b/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 diff --git a/modules/olm-arch-olm-operator.adoc b/modules/olm-arch-olm-operator.adoc index 2de04cff533f..183eb4c14c65 100644 --- a/modules/olm-arch-olm-operator.adoc +++ b/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 diff --git a/modules/olm-architecture.adoc b/modules/olm-architecture.adoc index d5bd8d9b6bb5..e8750fd6c978 100644 --- a/modules/olm-architecture.adoc +++ b/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 diff --git a/modules/olm-bundle-format.adoc b/modules/olm-bundle-format.adoc index 923ded6bc1d0..94fbaaace3f7 100644 --- a/modules/olm-bundle-format.adoc +++ b/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 diff --git a/modules/olm-catalogsource.adoc b/modules/olm-catalogsource.adoc index 6c072bfc6c2c..24f3b3f0baef 100644 --- a/modules/olm-catalogsource.adoc +++ b/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 diff --git a/modules/olm-crds.adoc b/modules/olm-crds.adoc index f9b9bd3ff1d4..83b0942f4d6f 100644 --- a/modules/olm-crds.adoc +++ b/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 diff --git a/modules/olm-creating-etcd-cluster-from-operator.adoc b/modules/olm-creating-etcd-cluster-from-operator.adoc index 4be2a69c3361..652a45bf11cf 100644 --- a/modules/olm-creating-etcd-cluster-from-operator.adoc +++ b/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 diff --git a/modules/olm-csv.adoc b/modules/olm-csv.adoc index 6162b7e4512a..4236f402effd 100644 --- a/modules/olm-csv.adoc +++ b/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 diff --git a/modules/olm-installing-from-operatorhub-using-cli.adoc b/modules/olm-installing-from-operatorhub-using-cli.adoc index e676a310bdcc..781895fd4163 100644 --- a/modules/olm-installing-from-operatorhub-using-cli.adoc +++ b/modules/olm-installing-from-operatorhub-using-cli.adoc @@ -1,19 +1,36 @@ // Module included in the following assemblies: // -// * operators/olm-adding-operators-to-cluster.adoc +// * operators/user/olm-installing-operators-in-namespace.adoc +// * operators/admin/olm-adding-operators-to-cluster.adoc // * post_installation_configuration/preparing-for-users.adoc +ifeval::["{context}" == "olm-installing-operators-in-namespace"] +:olm-user: +endif::[] + [id="olm-installing-operator-from-operatorhub-using-cli_{context}"] = Installing from OperatorHub using the CLI -As a cluster administrator, instead of using the {product-title} web console, -you can install an Operator from OperatorHub using the CLI. Use the `oc` command -to create or update a Subscription object. +Instead of using the {product-title} web console, you can install an Operator +from OperatorHub using the CLI. Use the `oc` command to create or update a +Subscription object. .Prerequisites -- Access to an {product-title} cluster using an account with `cluster-admin` +ifndef::olm-user[] +- Access to an {product-title} cluster using an account with +ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] +`cluster-admin` permissions. +endif::[] +ifdef::openshift-dedicated[] +`dedicated-admins-cluster` permissions. +endif::[] +endif::[] + +ifdef::olm-user[] +- Access to an {product-title} cluster using an account with Operator installation permissions. +endif::[] - Install the `oc` command to your local system. diff --git a/modules/olm-installing-from-operatorhub-using-web-console.adoc b/modules/olm-installing-from-operatorhub-using-web-console.adoc index a0e6c44e4f93..50e82aafa60a 100644 --- a/modules/olm-installing-from-operatorhub-using-web-console.adoc +++ b/modules/olm-installing-from-operatorhub-using-web-console.adoc @@ -1,27 +1,38 @@ // Module included in the following assemblies: // -// * operators/olm-adding-operators-to-cluster.adoc +// * operators/user/olm-installing-operators-in-namespace.adoc +// * operators/admin/olm-adding-operators-to-cluster.adoc // * post_installation_configuration/preparing-for-users.adoc + +// Add additional ifevals here, but before context == olm-adding-operators-to-a-cluster ifeval::["{context}" != "olm-adding-operators-to-a-cluster"] :filter-type: jaeger :filter-operator: Jaeger +:olm-admin: +endif::[] +ifeval::["{context}" == "olm-installing-operators-in-namespace"] +:filter-type: advanced +:filter-operator: Advanced Cluster Management for Kubernetes +:olm-admin!: +:olm-user: endif::[] -// Add additional ifevals here, but before context == olm-adding-operators-to-a-cluster // Keep this ifeval last ifeval::["{context}" == "olm-adding-operators-to-a-cluster"] :filter-type: advanced :filter-operator: Advanced Cluster Management for Kubernetes +:olm-admin: endif::[] [id="olm-installing-from-operatorhub-using-web-console_{context}"] = Installing from OperatorHub using the web console -As a cluster administrator, you can install and subscribe to an Operator from -OperatorHub using the {product-title} web console. +You can install and subscribe to an Operator from OperatorHub using the +{product-title} web console. .Prerequisites +ifdef::olm-admin[] - Access to an {product-title} cluster using an account with ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] `cluster-admin` permissions. @@ -29,6 +40,12 @@ endif::[] ifdef::openshift-dedicated[] `dedicated-admins-cluster` permissions. endif::[] +endif::[] + +ifdef::olm-user[] +- Access to an {product-title} cluster using an account with Operator installation +permissions. +endif::[] .Procedure @@ -53,6 +70,7 @@ Operators; you must acknowledge the warning before continuing. . On the *Create Operator Subscription* page: +ifdef::olm-admin[] .. Select one of the following: *** *All namespaces on the cluster (default)* installs the Operator in the default `openshift-operators` namespace to watch and be made available to all namespaces @@ -64,6 +82,11 @@ ifdef::openshift-dedicated[] If you are installing the Cluster Logging Operator, choose this option to select the `openshift-logging` namespace. endif::[] +endif::[] +ifdef::olm-user[] +.. Choose a specific, single namespace in which to install the Operator. The +Operator will only watch and be made available for use in this single namespace. +endif::[] .. Select an *Update Channel* (if more than one is available). diff --git a/modules/olm-installing-operators-from-operatorhub.adoc b/modules/olm-installing-operators-from-operatorhub.adoc index 8dfb6afa6384..63987f5bc591 100644 --- a/modules/olm-installing-operators-from-operatorhub.adoc +++ b/modules/olm-installing-operators-from-operatorhub.adoc @@ -1,15 +1,21 @@ // Module included in the following assemblies: // -// * operators/olm-adding-operators-to-cluster.adoc +// * operators/user/olm-installing-operators-in-namespace.adoc +// * operators/admin/olm-adding-operators-to-cluster.adoc // * post_installation_configuration/preparing-for-users.adoc +ifeval::["{context}" == "olm-installing-operators-in-namespace"] +:olm-user: +endif::[] + [id="olm-installing-operators-from-operatorhub_{context}"] = Installing Operators from OperatorHub +ifndef::olm-user[] As a cluster administrator, you can install an Operator from OperatorHub using the {product-title} ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] -web console or the CLI. You can then subscribe the Operator to one or more +web console or CLI. You can then subscribe the Operator to one or more namespaces to make it available for developers on your cluster. endif::[] ifdef::openshift-dedicated[] @@ -29,10 +35,16 @@ which requires the `openshift-logging` namespace. Privileged and custom Operators cannot be installed. ==== endif::[] +endif::[] + +ifdef::olm-user[] +As a user with the proper permissions, you can install an Operator from OperatorHub using the {product-title} web console or CLI. +endif::[] During installation, you must determine the following initial settings for the Operator: +ifndef::olm-user[] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] Installation Mode:: Choose *All namespaces on the cluster (default)* to have the Operator installed on all namespaces or choose individual namespaces, if @@ -45,6 +57,11 @@ Installation Mode:: In {product-title} clusters, you can choose *All namespaces to have the Operator installed on all namespaces. This makes the Operator available to all users and projects. endif::[] +endif::[] +ifdef::olm-user[] +Installation Mode:: Choose a specific namespace in which to install the +Operator. +endif::[] Update Channel:: If an Operator is available through multiple channels, you can choose which channel you want to subscribe to. For example, to deploy from the diff --git a/modules/olm-installplan.adoc b/modules/olm-installplan.adoc index 4e9c0eb9b27f..30801ce6ccf8 100644 --- a/modules/olm-installplan.adoc +++ b/modules/olm-installplan.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-installplan_{context}"] = InstallPlan diff --git a/modules/olm-metrics.adoc b/modules/olm-metrics.adoc index 072c6b19558c..e828147c1dc6 100644 --- a/modules/olm-metrics.adoc +++ b/modules/olm-metrics.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-metrics_{context}"] = Exposed metrics diff --git a/modules/olm-operator-framework.adoc b/modules/olm-operator-framework.adoc index 9729be4e2214..fe1056291dd2 100644 --- a/modules/olm-operator-framework.adoc +++ b/modules/olm-operator-framework.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/olm-what-operators-are.adoc +// * operators/understanding/olm-what-operators-are.adoc [id="olm-operator-framework_{context}"] = Operator Framework diff --git a/modules/olm-operator-maturity-model.adoc b/modules/olm-operator-maturity-model.adoc index 797f90c9b5a0..78c67fa86e0d 100644 --- a/modules/olm-operator-maturity-model.adoc +++ b/modules/olm-operator-maturity-model.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/olm-what-operators-are.adoc +// * operators/understanding/olm-what-operators-are.adoc [id="olm-maturity-model_{context}"] = Operator maturity model diff --git a/modules/olm-operatorgroups-about.adoc b/modules/olm-operatorgroups-about.adoc index 42aa4036b7f9..74ff2a1454b8 100644 --- a/modules/olm-operatorgroups-about.adoc +++ b/modules/olm-operatorgroups-about.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-olm.adoc -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-olm.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-about_{context}"] ifeval::["{context}" == "olm-understanding-olm"] diff --git a/modules/olm-operatorgroups-copied-csvs.adoc b/modules/olm-operatorgroups-copied-csvs.adoc index cc56f837cab0..89fedf902c78 100644 --- a/modules/olm-operatorgroups-copied-csvs.adoc +++ b/modules/olm-operatorgroups-copied-csvs.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-copied-csvs_{context}"] = Copied CSVs diff --git a/modules/olm-operatorgroups-csv-annotations.adoc b/modules/olm-operatorgroups-csv-annotations.adoc index 4ad0a2797575..aa3b1eb1d22a 100644 --- a/modules/olm-operatorgroups-csv-annotations.adoc +++ b/modules/olm-operatorgroups-csv-annotations.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-csv-annotations_{context}"] = OperatorGroup CSV annotations diff --git a/modules/olm-operatorgroups-intersections.adoc b/modules/olm-operatorgroups-intersections.adoc index 4a82a5f67d0a..159db51af13c 100644 --- a/modules/olm-operatorgroups-intersections.adoc +++ b/modules/olm-operatorgroups-intersections.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-intersection_{context}"] = OperatorGroup intersection diff --git a/modules/olm-operatorgroups-membership.adoc b/modules/olm-operatorgroups-membership.adoc index 8e2e11033699..919d39e3336e 100644 --- a/modules/olm-operatorgroups-membership.adoc +++ b/modules/olm-operatorgroups-membership.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-membership_{context}"] = OperatorGroup membership diff --git a/modules/olm-operatorgroups-provided-apis-annotations.adoc b/modules/olm-operatorgroups-provided-apis-annotations.adoc index a5a558012db5..4884bd26ae21 100644 --- a/modules/olm-operatorgroups-provided-apis-annotations.adoc +++ b/modules/olm-operatorgroups-provided-apis-annotations.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-provided-apis-annotation_{context}"] = Provided APIs annotation diff --git a/modules/olm-operatorgroups-rbac.adoc b/modules/olm-operatorgroups-rbac.adoc index a1dc6b0949f8..77209813ce91 100644 --- a/modules/olm-operatorgroups-rbac.adoc +++ b/modules/olm-operatorgroups-rbac.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-rbac_{context}"] = Role-based access control diff --git a/modules/olm-operatorgroups-static.adoc b/modules/olm-operatorgroups-static.adoc index bf0350650786..55fd4a07e6f1 100644 --- a/modules/olm-operatorgroups-static.adoc +++ b/modules/olm-operatorgroups-static.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-static_{context}"] = Static OperatorGroups diff --git a/modules/olm-operatorgroups-target-namespace.adoc b/modules/olm-operatorgroups-target-namespace.adoc index 50ff665ba260..a47583e5f67e 100644 --- a/modules/olm-operatorgroups-target-namespace.adoc +++ b/modules/olm-operatorgroups-target-namespace.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-target-namespace_{context}"] = Target namespace selection diff --git a/modules/olm-operatorgroups-troubleshooting.adoc b/modules/olm-operatorgroups-troubleshooting.adoc index 1f6fcce2e3f3..c517bf52f981 100644 --- a/modules/olm-operatorgroups-troubleshooting.adoc +++ b/modules/olm-operatorgroups-troubleshooting.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-understanding-operatorgroups.adoc +// * operators/understanding/olm/olm-understanding-operatorgroups.adoc [id="olm-operatorgroups-troubleshooting_{context}"] = Troubleshooting OperatorGroups diff --git a/modules/olm-operatorhub-overview.adoc b/modules/olm-operatorhub-overview.adoc index f9ad8d012e46..54c203ab1838 100644 --- a/modules/olm-operatorhub-overview.adoc +++ b/modules/olm-operatorhub-overview.adoc @@ -3,7 +3,7 @@ // * operators/olm-understanding-operatorhub.adoc [id="olm-operatorhub-overview_{context}"] -= Overview of OperatorHub += About OperatorHub _OperatorHub_ is available via the {product-title} web console and is the interface that cluster administrators use to discover and install Operators. diff --git a/modules/olm-opm.adoc b/modules/olm-opm.adoc index ee2acca02ae7..91d6b3a3741b 100644 --- a/modules/olm-opm.adoc +++ b/modules/olm-opm.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-packaging-formats.adoc +// * operators/understanding/olm/olm-packaging-formats.adoc // * operators/olm-managing-custom-catalogs.adoc [id="olm-opm_{context}"] diff --git a/modules/olm-overview.adoc b/modules/olm-overview.adoc index 8c9a4b73d218..51dcd97a9e08 100644 --- a/modules/olm-overview.adoc +++ b/modules/olm-overview.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-overview_{context}"] = What is Operator Lifecycle Manager? diff --git a/modules/olm-package-manifest-format.adoc b/modules/olm-package-manifest-format.adoc index bf92c7b2b7c3..1456f1a9b192 100644 --- a/modules/olm-package-manifest-format.adoc +++ b/modules/olm-package-manifest-format.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-packaging-formats.adoc +// * operators/understanding/olm/olm-packaging-formats.adoc [id="olm-package-manifest-format_{context}"] = Package Manifest Format diff --git a/modules/olm-subscription.adoc b/modules/olm-subscription.adoc index bfa271311189..7e5605e99c6e 100644 --- a/modules/olm-subscription.adoc +++ b/modules/olm-subscription.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-subscription_{context}"] = Subscription diff --git a/modules/olm-terms.adoc b/modules/olm-terms.adoc index c245d3b4a63b..1033860ad413 100644 --- a/modules/olm-terms.adoc +++ b/modules/olm-terms.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/understanding_olm/olm-common-terms.adoc +// * operators/understanding/olm/olm-common-terms.adoc [id="olm-common-terms-bundle_{context}"] = Bundle diff --git a/modules/olm-upgrades.adoc b/modules/olm-upgrades.adoc index f9114ed82779..63f952539e4e 100644 --- a/modules/olm-upgrades.adoc +++ b/modules/olm-upgrades.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-upgrades_{context}"] = Operator installation and upgrade workflow in OLM diff --git a/modules/olm-why-use-operators.adoc b/modules/olm-why-use-operators.adoc index 0475bc2c8d61..02520ce8ed13 100644 --- a/modules/olm-why-use-operators.adoc +++ b/modules/olm-why-use-operators.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * operators/olm-what-operators-are.adoc +// * operators/understanding/olm-what-operators-are.adoc [id="olm-why-use-operators_{context}"] = Why use Operators? diff --git a/operators/crds/images b/operators/admin/images similarity index 100% rename from operators/crds/images rename to operators/admin/images diff --git a/operators/crds/modules b/operators/admin/modules similarity index 100% rename from operators/crds/modules rename to operators/admin/modules diff --git a/operators/olm-adding-operators-to-cluster.adoc b/operators/admin/olm-adding-operators-to-cluster.adoc similarity index 80% rename from operators/olm-adding-operators-to-cluster.adoc rename to operators/admin/olm-adding-operators-to-cluster.adoc index 1271242bfd9f..666d0f3cc46f 100644 --- a/operators/olm-adding-operators-to-cluster.adoc +++ b/operators/admin/olm-adding-operators-to-cluster.adoc @@ -14,5 +14,5 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+2] .Additional resources -* xref:../operators/understanding_olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-about_olm-understanding-operatorgroups[About OperatorGroups] +* xref:../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-about_olm-understanding-operatorgroups[About OperatorGroups] endif::[] diff --git a/operators/olm-configuring-proxy-support.adoc b/operators/admin/olm-configuring-proxy-support.adoc similarity index 71% rename from operators/olm-configuring-proxy-support.adoc rename to operators/admin/olm-configuring-proxy-support.adoc index 07418c2d2cd5..544822ce2f44 100644 --- a/operators/olm-configuring-proxy-support.adoc +++ b/operators/admin/olm-configuring-proxy-support.adoc @@ -12,8 +12,8 @@ override the global proxy or inject a custom CA certificate. .Additional resources -* xref:../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[Configuring the cluster-wide proxy] -* xref:../networking/configuring-a-custom-pki.adoc#configuring-a-custom-pki[Configuring a custom PKI] (custom CA certificate) +* xref:../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[Configuring the cluster-wide proxy] +* xref:../../networking/configuring-a-custom-pki.adoc#configuring-a-custom-pki[Configuring a custom PKI] (custom CA certificate) include::modules/olm-overriding-proxy-settings.adoc[leveloffset=+1] include::modules/olm-injecting-custom-ca.adoc[leveloffset=+1] diff --git a/operators/olm-creating-policy.adoc b/operators/admin/olm-creating-policy.adoc similarity index 96% rename from operators/olm-creating-policy.adoc rename to operators/admin/olm-creating-policy.adoc index d283a8b6199d..3b56886ac41a 100644 --- a/operators/olm-creating-policy.adoc +++ b/operators/admin/olm-creating-policy.adoc @@ -1,5 +1,5 @@ [id="olm-creating-policy"] -= Creating policy for Operator installations and upgrades += Allowing non-cluster administrators to install Operators include::modules/common-attributes.adoc[] :context: olm-creating-policy diff --git a/operators/olm-deleting-operators-from-cluster.adoc b/operators/admin/olm-deleting-operators-from-cluster.adoc similarity index 100% rename from operators/olm-deleting-operators-from-cluster.adoc rename to operators/admin/olm-deleting-operators-from-cluster.adoc diff --git a/operators/olm-managing-custom-catalogs.adoc b/operators/admin/olm-managing-custom-catalogs.adoc similarity index 68% rename from operators/olm-managing-custom-catalogs.adoc rename to operators/admin/olm-managing-custom-catalogs.adoc index 42daf80149b7..b4eebcb353c0 100644 --- a/operators/olm-managing-custom-catalogs.adoc +++ b/operators/admin/olm-managing-custom-catalogs.adoc @@ -16,17 +16,17 @@ include::modules/olm-understanding-operator-catalog-images.adoc[leveloffset=+2] include::modules/olm-building-operator-catalog-image.adoc[leveloffset=+2] .Additional resources -* xref:../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Creating a mirror registry for installation in a restricted network] +* xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Creating a mirror registry for installation in a restricted network] include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2] .Additional resources -* xref:../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators] +* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators] include::modules/olm-updating-operator-catalog-image.adoc[leveloffset=+2] .Additional resources -* xref:../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators] +* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators] include::modules/olm-testing-operator-catalog-image.adoc[leveloffset=+2] @@ -37,7 +37,7 @@ include::modules/olm-opm.adoc[leveloffset=+3] .Additional resources * To create a bundle image using the Operator SDK, see -xref:../operators/operator_sdk/osdk-working-bundle-images.adoc#osdk-working-bundle-images[Working with bundle images]. +xref:../../operators/operator_sdk/osdk-working-bundle-images.adoc#osdk-working-bundle-images[Working with bundle images]. include::modules/olm-installing-opm.adoc[leveloffset=+3] include::modules/olm-creating-index-image.adoc[leveloffset=+3] diff --git a/operators/olm-restricted-networks.adoc b/operators/admin/olm-restricted-networks.adoc similarity index 70% rename from operators/olm-restricted-networks.adoc rename to operators/admin/olm-restricted-networks.adoc index c56da19b89f1..983fef3374ae 100644 --- a/operators/olm-restricted-networks.adoc +++ b/operators/admin/olm-restricted-networks.adoc @@ -31,22 +31,22 @@ link:https://access.redhat.com/articles/4740011[] .Additional resources -* xref:../operators/operator_sdk/osdk-generating-csvs.adoc#olm-enabling-operator-for-restricted-network_osdk-generating-csvs[Enabling your Operator for restricted network environments] +* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-enabling-operator-for-restricted-network_osdk-generating-csvs[Enabling your Operator for restricted network environments] include::modules/olm-understanding-operator-catalog-images.adoc[leveloffset=+1] include::modules/olm-building-operator-catalog-image.adoc[leveloffset=+1] .Additional resources -* xref:../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Creating a mirror registry for installation in a restricted network] +* xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Creating a mirror registry for installation in a restricted network] include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1] .Additional resources -* xref:../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators] +* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators] include::modules/olm-updating-operator-catalog-image.adoc[leveloffset=+1] .Additional resources -* xref:../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators] +* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-arch-os-support_osdk-generating-csvs[Architecture and operating system support for Operators] include::modules/olm-testing-operator-catalog-image.adoc[leveloffset=+1] diff --git a/operators/olm-status.adoc b/operators/admin/olm-status.adoc similarity index 100% rename from operators/olm-status.adoc rename to operators/admin/olm-status.adoc diff --git a/operators/operator_sdk/osdk-generating-csvs.adoc b/operators/operator_sdk/osdk-generating-csvs.adoc index 1ab9f5690cee..8cc0e5db7cbc 100644 --- a/operators/operator_sdk/osdk-generating-csvs.adoc +++ b/operators/operator_sdk/osdk-generating-csvs.adoc @@ -45,7 +45,7 @@ include::modules/osdk-csv-composition-configuration.adoc[leveloffset=+1] include::modules/osdk-manually-defined-csv-fields.adoc[leveloffset=+1] .Additional resources -- xref:../../operators/olm-what-operators-are.adoc#olm-maturity-model_olm-what-operators-are[Operator maturity model] +- xref:../../operators/understanding/olm-what-operators-are.adoc#olm-maturity-model_olm-what-operators-are[Operator maturity model] include::modules/osdk-generating-a-csv.adoc[leveloffset=+1] include::modules/olm-enabling-operator-restricted-network.adoc[leveloffset=+1] diff --git a/operators/operator_sdk/osdk-working-bundle-images.adoc b/operators/operator_sdk/osdk-working-bundle-images.adoc index 17dca52b9d46..af9a42191557 100644 --- a/operators/operator_sdk/osdk-working-bundle-images.adoc +++ b/operators/operator_sdk/osdk-working-bundle-images.adoc @@ -12,5 +12,5 @@ include::modules/osdk-building-bundle-image.adoc[leveloffset=+1] [id="osdk-working-bundle-images-additional-resources"] == Additional resources -* See xref:../../operators/olm-packaging-format.adoc#olm-bundle-format_olm-packaging-format[Operator Framework packaging formats] +* See xref:../../operators/understanding/olm-packaging-format.adoc#olm-bundle-format_olm-packaging-format[Operator Framework packaging formats] for more details on the Bundle Format. diff --git a/operators/crds/crd-extending-api-with-crds.adoc b/operators/understanding/crds/crd-extending-api-with-crds.adoc similarity index 100% rename from operators/crds/crd-extending-api-with-crds.adoc rename to operators/understanding/crds/crd-extending-api-with-crds.adoc diff --git a/operators/crds/crd-managing-resources-from-crds.adoc b/operators/understanding/crds/crd-managing-resources-from-crds.adoc similarity index 100% rename from operators/crds/crd-managing-resources-from-crds.adoc rename to operators/understanding/crds/crd-managing-resources-from-crds.adoc diff --git a/operators/understanding/crds/images b/operators/understanding/crds/images new file mode 120000 index 000000000000..5fa6987088da --- /dev/null +++ b/operators/understanding/crds/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/operators/understanding/crds/modules b/operators/understanding/crds/modules new file mode 120000 index 000000000000..8b0e8540076d --- /dev/null +++ b/operators/understanding/crds/modules @@ -0,0 +1 @@ +../../modules \ No newline at end of file diff --git a/operators/understanding/images b/operators/understanding/images new file mode 120000 index 000000000000..5e67573196d8 --- /dev/null +++ b/operators/understanding/images @@ -0,0 +1 @@ +../images \ No newline at end of file diff --git a/operators/understanding/modules b/operators/understanding/modules new file mode 120000 index 000000000000..464b823aca16 --- /dev/null +++ b/operators/understanding/modules @@ -0,0 +1 @@ +../modules \ No newline at end of file diff --git a/operators/olm-common-terms.adoc b/operators/understanding/olm-common-terms.adoc similarity index 100% rename from operators/olm-common-terms.adoc rename to operators/understanding/olm-common-terms.adoc diff --git a/operators/olm-packaging-format.adoc b/operators/understanding/olm-packaging-format.adoc similarity index 100% rename from operators/olm-packaging-format.adoc rename to operators/understanding/olm-packaging-format.adoc diff --git a/operators/olm-understanding-operatorhub.adoc b/operators/understanding/olm-understanding-operatorhub.adoc similarity index 50% rename from operators/olm-understanding-operatorhub.adoc rename to operators/understanding/olm-understanding-operatorhub.adoc index 2aaa1c0c55f5..fd029c223524 100644 --- a/operators/olm-understanding-operatorhub.adoc +++ b/operators/understanding/olm-understanding-operatorhub.adoc @@ -8,12 +8,13 @@ toc::[] This guide outlines the architecture of OperatorHub. include::modules/olm-operatorhub-overview.adoc[leveloffset=+1] -.Additional resources +include::modules/olm-operatorhub-architecture.adoc[leveloffset=+1] + +[id="olm-understanding-operatorhub-resources"] +== Additional resources -* xref:../operators/operator_sdk/osdk-getting-started.adoc#osdk-getting-started[Getting started with the Operator SDK] -* xref:../operators/operator_sdk/osdk-generating-csvs.adoc#osdk-generating-csvs[Generating a ClusterServiceVersion (CSV)] -* xref:../operators/understanding_olm/olm-workflow.adoc#olm-upgrades_olm-workflow[Operator installation and upgrade workflow in OLM] +* xref:../../operators/operator_sdk/osdk-getting-started.adoc#osdk-getting-started[Getting started with the Operator SDK] +* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#osdk-generating-csvs[Generating a ClusterServiceVersion (CSV)] +* xref:../../operators/understanding/olm/olm-workflow.adoc#olm-upgrades_olm-workflow[Operator installation and upgrade workflow in OLM] * link:https://connect.redhat.com[Red Hat Partner Connect] * link:https://marketplace.redhat.com[Red Hat Marketplace] - -include::modules/olm-operatorhub-architecture.adoc[leveloffset=+1] diff --git a/operators/olm-what-operators-are.adoc b/operators/understanding/olm-what-operators-are.adoc similarity index 98% rename from operators/olm-what-operators-are.adoc rename to operators/understanding/olm-what-operators-are.adoc index 5d1bb4897c28..e501858aa41e 100644 --- a/operators/olm-what-operators-are.adoc +++ b/operators/understanding/olm-what-operators-are.adoc @@ -1,5 +1,5 @@ [id="olm-what-operators-are"] -= Understanding Operators += What are Operators? include::modules/common-attributes.adoc[] :context: olm-what-operators-are diff --git a/operators/understanding/olm/images b/operators/understanding/olm/images new file mode 120000 index 000000000000..5fa6987088da --- /dev/null +++ b/operators/understanding/olm/images @@ -0,0 +1 @@ +../../images \ No newline at end of file diff --git a/operators/understanding/olm/modules b/operators/understanding/olm/modules new file mode 120000 index 000000000000..8b0e8540076d --- /dev/null +++ b/operators/understanding/olm/modules @@ -0,0 +1 @@ +../../modules \ No newline at end of file diff --git a/operators/understanding_olm/olm-arch.adoc b/operators/understanding/olm/olm-arch.adoc similarity index 100% rename from operators/understanding_olm/olm-arch.adoc rename to operators/understanding/olm/olm-arch.adoc diff --git a/operators/understanding_olm/olm-understanding-dependency-resolution.adoc b/operators/understanding/olm/olm-understanding-dependency-resolution.adoc similarity index 100% rename from operators/understanding_olm/olm-understanding-dependency-resolution.adoc rename to operators/understanding/olm/olm-understanding-dependency-resolution.adoc diff --git a/operators/understanding_olm/olm-understanding-metrics.adoc b/operators/understanding/olm/olm-understanding-metrics.adoc similarity index 100% rename from operators/understanding_olm/olm-understanding-metrics.adoc rename to operators/understanding/olm/olm-understanding-metrics.adoc diff --git a/operators/understanding_olm/olm-understanding-olm.adoc b/operators/understanding/olm/olm-understanding-olm.adoc similarity index 80% rename from operators/understanding_olm/olm-understanding-olm.adoc rename to operators/understanding/olm/olm-understanding-olm.adoc index a5192a9a5ab3..b12d8b641f0a 100644 --- a/operators/understanding_olm/olm-understanding-olm.adoc +++ b/operators/understanding/olm/olm-understanding-olm.adoc @@ -16,5 +16,5 @@ include::modules/olm-subscription.adoc[leveloffset=+2] include::modules/olm-installplan.adoc[leveloffset=+2] include::modules/olm-operatorgroups-about.adoc[leveloffset=+2] -For more information, see the xref:../../operators/understanding_olm/olm-understanding-operatorgroups.adoc#olm-understanding-operatorgroups[OperatorGroups] +For more information, see the xref:../../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-understanding-operatorgroups[OperatorGroups] guide. diff --git a/operators/understanding_olm/olm-understanding-operatorgroups.adoc b/operators/understanding/olm/olm-understanding-operatorgroups.adoc similarity index 100% rename from operators/understanding_olm/olm-understanding-operatorgroups.adoc rename to operators/understanding/olm/olm-understanding-operatorgroups.adoc diff --git a/operators/understanding_olm/olm-workflow.adoc b/operators/understanding/olm/olm-workflow.adoc similarity index 100% rename from operators/understanding_olm/olm-workflow.adoc rename to operators/understanding/olm/olm-workflow.adoc diff --git a/operators/understanding_olm/images b/operators/understanding_olm/images deleted file mode 120000 index 847b03ed0541..000000000000 --- a/operators/understanding_olm/images +++ /dev/null @@ -1 +0,0 @@ -../../images/ \ No newline at end of file diff --git a/operators/user/images b/operators/user/images new file mode 120000 index 000000000000..5e67573196d8 --- /dev/null +++ b/operators/user/images @@ -0,0 +1 @@ +../images \ No newline at end of file diff --git a/operators/user/modules b/operators/user/modules new file mode 120000 index 000000000000..464b823aca16 --- /dev/null +++ b/operators/user/modules @@ -0,0 +1 @@ +../modules \ No newline at end of file diff --git a/operators/olm-creating-apps-from-installed-operators.adoc b/operators/user/olm-creating-apps-from-installed-operators.adoc similarity index 100% rename from operators/olm-creating-apps-from-installed-operators.adoc rename to operators/user/olm-creating-apps-from-installed-operators.adoc diff --git a/operators/user/olm-installing-operators-in-namespace.adoc b/operators/user/olm-installing-operators-in-namespace.adoc new file mode 100644 index 000000000000..fc10db354dc0 --- /dev/null +++ b/operators/user/olm-installing-operators-in-namespace.adoc @@ -0,0 +1,27 @@ +[id="olm-installing-operators-in-namespace"] += Installing Operators in your namespace +include::modules/common-attributes.adoc[] +:context: olm-installing-operators-in-namespace + +toc::[] + +If a cluster administrator has delegated Operator installation permissions to +your account, you can install and subscribe an Operator to your namespace in a +self-service manner. + +[id="olm-installing-operators-in-namespace-prereqs"] +== Prerequisites + +A cluster administrator must add certain permissions to your {product-title} +user account to allow self-service Operator installation to a namespace. See +xref:../../operators/admin/olm-creating-policy.adoc#olm-creating-policy[Allowing non-cluster administrators to install Operators] +for details. + +include::modules/olm-installing-operators-from-operatorhub.adoc[leveloffset=+1] +include::modules/olm-installing-from-operatorhub-using-web-console.adoc[leveloffset=+2] +ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] +include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+2] +.Additional resources + +* xref:../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-about_olm-understanding-operatorgroups[About OperatorGroups] +endif::[] diff --git a/operators/olm-webhooks.adoc b/operators/user/olm-webhooks.adoc similarity index 83% rename from operators/olm-webhooks.adoc rename to operators/user/olm-webhooks.adoc index d7146eee9d4e..0c7083afbe88 100644 --- a/operators/olm-webhooks.adoc +++ b/operators/user/olm-webhooks.adoc @@ -17,4 +17,4 @@ include::modules/olm-webhook-considerations.adoc[leveloffset=+1] [id="olm-webhooks-additional-resources"] == Additional resources -* xref:../architecture/admission-plug-ins.adoc#admission-webhook-types_admission-plug-ins[Types of webhook admission plug-ins] +* xref:../../architecture/admission-plug-ins.adoc#admission-webhook-types_admission-plug-ins[Types of webhook admission plug-ins] diff --git a/pipelines/installing-pipelines.adoc b/pipelines/installing-pipelines.adoc index 40dc8ada1139..272041357f41 100644 --- a/pipelines/installing-pipelines.adoc +++ b/pipelines/installing-pipelines.adoc @@ -27,4 +27,4 @@ include::modules/op-installing-pipelines-operator-using-the-cli.adoc[leveloffset .Additional Resources -* You can learn more about installing Operators on {product-title} in the xref:../operators/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[adding Operators to a cluster] section. +* You can learn more about installing Operators on {product-title} in the xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[adding Operators to a cluster] section. diff --git a/pipelines/uninstalling-pipelines.adoc b/pipelines/uninstalling-pipelines.adoc index bc5299ddcdab..5db20d4ec133 100644 --- a/pipelines/uninstalling-pipelines.adoc +++ b/pipelines/uninstalling-pipelines.adoc @@ -19,4 +19,4 @@ include::modules/op-uninstalling-the-pipelines-operator.adoc[leveloffset=+1] .Additional Resources -* You can learn more about uninstalling Operators on {product-title} in the xref:../operators/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster] section. +* You can learn more about uninstalling Operators on {product-title} in the xref:../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster] section. diff --git a/post_installation_configuration/preparing-for-users.adoc b/post_installation_configuration/preparing-for-users.adoc index 8c15713aed18..edbd3cf11c2b 100644 --- a/post_installation_configuration/preparing-for-users.adoc +++ b/post_installation_configuration/preparing-for-users.adoc @@ -136,5 +136,5 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+2] .Additional resources -* xref:../operators/understanding_olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-about_olm-understanding-operatorgroups[About OperatorGroups] +* xref:../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-about_olm-understanding-operatorgroups[About OperatorGroups] endif::[] diff --git a/serverless/architecture/serverless-serving-architecture.adoc b/serverless/architecture/serverless-serving-architecture.adoc index bff3dc733cb0..51c6b0c5925a 100644 --- a/serverless/architecture/serverless-serving-architecture.adoc +++ b/serverless/architecture/serverless-serving-architecture.adoc @@ -9,7 +9,7 @@ toc::[] Knative Serving on {product-title} enables developers to write link:https://www.redhat.com/en/topics/cloud-native-apps[cloud-native applications] using link:https://www.redhat.com/en/topics/cloud-native-apps/what-is-serverless[serverless architecture]. Serverless is a cloud computing model where application developers don't need to provision servers or manage scaling for their applications. These routine tasks are abstracted away by the platform, allowing developers to push code to production much faster than in traditional models. -Knative Serving supports deploying and managing cloud-native applications by providing a set of objects as Kubernetes Custom Resource Definitions (CRDs) that define and control the behavior of serverless workloads on an {product-title} cluster. For more information about CRDs, see xref:../../operators/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Extending the Kubernetes API with Custom Resource Definitions]. +Knative Serving supports deploying and managing cloud-native applications by providing a set of objects as Kubernetes Custom Resource Definitions (CRDs) that define and control the behavior of serverless workloads on an {product-title} cluster. For more information about CRDs, see xref:../../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Extending the Kubernetes API with Custom Resource Definitions]. Developers use these CRDs to create custom resource (CR) instances that can be used as building blocks to address complex use cases. For example: @@ -17,7 +17,7 @@ Developers use these CRDs to create custom resource (CR) instances that can be u * Automatically scaling pods. // TODO: Add other use cases, more advanced tutorials? -For more information about CRs, see xref:../../operators/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Managing resources from Custom Resource Definitions]. +For more information about CRs, see xref:../../operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Managing resources from Custom Resource Definitions]. [id="serverless-serving-architecture-custom-resources"] == Knative Serving CRDs diff --git a/serverless/installing_serverless/installing-openshift-serverless.adoc b/serverless/installing_serverless/installing-openshift-serverless.adoc index 9f236d8cfc34..dc09af8d914b 100644 --- a/serverless/installing_serverless/installing-openshift-serverless.adoc +++ b/serverless/installing_serverless/installing-openshift-serverless.adoc @@ -10,7 +10,7 @@ This guide walks cluster administrators through installing the {ServerlessOperat [NOTE] ==== -{ServerlessProductName} is supported for installation in a restricted network environment. For more information, see xref:../../operators/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]. +{ServerlessProductName} is supported for installation in a restricted network environment. For more information, see xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks]. ==== == Cluster sizing requirements diff --git a/serverless/installing_serverless/removing-openshift-serverless.adoc b/serverless/installing_serverless/removing-openshift-serverless.adoc index bb5aa2aa2055..b52fc3eeab87 100644 --- a/serverless/installing_serverless/removing-openshift-serverless.adoc +++ b/serverless/installing_serverless/removing-openshift-serverless.adoc @@ -21,7 +21,7 @@ include::modules/serverless-uninstalling-knative-eventing.adoc[leveloffset=+1] [id="removing-the-operator"] == Removing the {ServerlessOperatorName} -You can remove the {ServerlessOperatorName} from the host 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]. +You can remove the {ServerlessOperatorName} from the host cluster by following the documentation on xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster]. [id="deleting-serverless-CRDs"] == Deleting {ServerlessProductName} CRDs diff --git a/service_mesh/service_mesh_install/updating-ossm.adoc b/service_mesh/service_mesh_install/updating-ossm.adoc index 705e503623de..ae1b48806949 100644 --- a/service_mesh/service_mesh_install/updating-ossm.adoc +++ b/service_mesh/service_mesh_install/updating-ossm.adoc @@ -119,4 +119,4 @@ The version field specifies the version of ServiceMesh to install and defaults t If you choose to update manually, the Operator Lifecycle Manager (OLM) controls the installation, upgrade, and role-based access control (RBAC) of Operators in a cluster. OLM runs by default in {product-title}. OLM uses CatalogSources, which use the Operator Registry API, to query 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-overview_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-overview_olm-understanding-olm[Operator Lifecycle Manager] documentation. diff --git a/virt/upgrading-virt.adoc b/virt/upgrading-virt.adoc index 4ca25a0ead02..8e8dc4e75d1a 100644 --- a/virt/upgrading-virt.adoc +++ b/virt/upgrading-virt.adoc @@ -15,4 +15,4 @@ include::modules/virt-monitoring-upgrade-status.adoc[leveloffset=+1] .Additional information -* xref:../operators/understanding_olm/olm-understanding-olm.adoc#olm-csv_olm-understanding-olm[ClusterServiceVersions (CSVs)] +* xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-csv_olm-understanding-olm[ClusterServiceVersions (CSVs)] diff --git a/welcome/index.adoc b/welcome/index.adoc index ed84204149e8..998f3ce925d9 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -123,7 +123,7 @@ application packages on Kubernetes. A Helm Chart is a packaging format that describes an application that can be deployed using the Helm CLI. endif::[] -- **xref:../operators/olm-what-operators-are.adoc#olm-what-operators-are[Understand Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title} {product-version}. Learn about the Operator Framework and how to deploy applications using installed Operators into your projects. +- **xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Understand Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title} {product-version}. Learn about the Operator Framework and how to deploy applications using installed Operators into your projects. - **xref:../builds/understanding-image-builds.adoc#understanding-image-builds[Understand image builds]**: Choose from different build strategies (Docker, S2I, custom, and pipeline) that can include different kinds of source materials (from places like Git repositories, local binary inputs, and external artifacts). Then, follow examples of build types from basic builds to advanced builds. @@ -151,7 +151,7 @@ that watch over the cluster. As a cluster administrator, this documentation will help you: - **xref:../architecture/architecture.adoc#architecture-overview-architecture[Understand {product-title} management]**: Learn about components -of the {product-title} {product-version} control plane. See how {product-title} masters and workers are managed and updated through the xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machine-api-overview_creating-machineset-aws[Machine API] and xref:../operators/olm-what-operators-are.adoc#machine-api-overview-architecture[Operators]. +of the {product-title} {product-version} control plane. See how {product-title} masters and workers are managed and updated through the xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machine-api-overview_creating-machineset-aws[Machine API] and xref:../operators/understanding/olm-what-operators-are.adoc#machine-api-overview-architecture[Operators]. === Manage cluster components @@ -209,12 +209,12 @@ xref:../storage/container_storage_interface/persistent-storage-csi.adoc#persiste xref:../storage/container_storage_interface/persistent-storage-csi-cloning.adoc#persistent-storage-csi-cloning[clone] persistent storage. -- **xref:../operators/olm-what-operators-are.adoc#olm-what-operators-are[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can -be reviewed by cluster administrators and xref:../operators/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[installed on their clusters]. Once installed, you can xref:../operators/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do). +- **xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can +be reviewed by cluster administrators and xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[installed on their clusters]. Once installed, you can xref:../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do). === Change cluster components -- **xref:../operators/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Use Custom Resource Definition (CRDs) to modify the cluster]**: Cluster features that are implemented with Operators, can be modified with CRDs. Learn to xref:../operators/crds/crd-extending-api-with-crds.adoc#crd-creating-custom-resources-definition_crd-extending-api-with-crds[create a CRD] and xref:../operators/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[manage resources from CRDs]. +- **xref:../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Use Custom Resource Definition (CRDs) to modify the cluster]**: Cluster features that are implemented with Operators, can be modified with CRDs. Learn to xref:../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-creating-custom-resources-definition_crd-extending-api-with-crds[create a CRD] and xref:../operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[manage resources from CRDs]. ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] - **xref:../applications/quotas/quotas-setting-per-project.adoc#quotas-setting-per-project[Set resource quotas]**: Choose from CPU, memory and other system resources to xref:../applications/quotas/quotas-setting-per-project.adoc#quotas-setting-per-project[set quotas]. @@ -256,8 +256,8 @@ cluster can be performed by {product-title} cluster administrators. As a - **xref:../administering_a_cluster/dedicated-admin-role.adoc#dedicated-administrator-role[Understand the `dedicated-admin` role]**: Learn about the elevated privileges provided to {product-title} cluster administrators. //// -- **xref:../operators/olm-what-operators-are.adoc#olm-what-operators-are[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can -be reviewed by cluster administrators and xref:../operators/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[installed on their clusters]. Once installed, you can xref:../operators/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do). +- **xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can +be reviewed by cluster administrators and xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[installed on their clusters]. Once installed, you can xref:../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do). //// - **xref:../administering_a_cluster/dedicated-admin-role.adoc#dedicated-managing-administrators_dedicated-administrator[Manage RBAC authorizations]**: Grant permissions to users or groups and manage service accounts. @@ -269,7 +269,7 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] endif::[] //// -- **xref:../operators/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Manage resources from Custom Resource Definition (CRDs)]**: Learn about how {product-title} cluster administrators and project administrators can use CRDs to manage custom resources in non-default namespaces. +- **xref:../operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Manage resources from Custom Resource Definition (CRDs)]**: Learn about how {product-title} cluster administrators and project administrators can use CRDs to manage custom resources in non-default namespaces. //// diff --git a/whats_new/new-features.adoc b/whats_new/new-features.adoc index 29ea848db517..f66b45f002f5 100644 --- a/whats_new/new-features.adoc +++ b/whats_new/new-features.adoc @@ -13,7 +13,7 @@ See the link:https://github.com/openshift/okd/releases[*Releases*] page in the [id="ocp-operators"] == Operators -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] are pieces of software that ease the operational complexity of running another piece of software. They act like an extension of the software vendor’s engineering team, watching over a Kubernetes environment (such as @@ -35,7 +35,7 @@ access to Operators running on their cluster: * Supports role-based access control (RBAC) for certain teams to use certain Operators See -xref:../operators/understanding_olm/olm-understanding-olm.adoc#olm-understanding-olm[Understanding the Operator Lifecycle Manager (OLM)] for more information. +xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Understanding the Operator Lifecycle Manager (OLM)] for more information. [id="ocp-installation-and-upgrade"] == Installation and upgrade @@ -113,7 +113,7 @@ from Red Hat products, Red Hat partners, and the community. |=== See -xref:../operators/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the OperatorHub] for more information. +xref:../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the OperatorHub] for more information. [id="ocp-storage"] == Storage