diff --git a/modules/operators-overview.adoc b/modules/operators-overview.adoc index 0329c503a031..daf6fb55bdab 100644 --- a/modules/operators-overview.adoc +++ b/modules/operators-overview.adoc @@ -14,9 +14,9 @@ ifndef::index[] = Operators in {product-title} endif::[] -Operators are among the most important components of {product-title}. Operators are the preferred method of packaging, deploying, and managing services on the control plane. They can also provide advantages to applications that users run. +Operators are among the most important components of {product-title}. They are the preferred method of packaging, deploying, and managing services on the control plane. They can also provide advantages to applications that users run. -Operators integrate with Kubernetes APIs and CLI tools such as `kubectl` and `oc` commands. They provide the means of monitoring applications, performing health checks, managing over-the-air (OTA) updates, and ensuring that applications remain in your specified state. +Operators integrate with Kubernetes APIs and CLI tools such as `kubectl` and the {oc-first}. They provide the means of monitoring applications, performing health checks, managing over-the-air (OTA) updates, and ensuring that applications remain in your specified state. ifndef::index[] Operators also offer a more granular configuration experience. You configure each component by modifying the API that the Operator exposes instead of modifying a global configuration file. @@ -24,10 +24,14 @@ Operators also offer a more granular configuration experience. You configure eac Because CRI-O and the Kubelet run on every node, almost every other cluster function can be managed on the control plane by using Operators. Components that are added to the control plane by using Operators include critical networking and credential services. endif::[] +ifdef::index[] +Operators are designed specifically for Kubernetes-native applications to implement and automate common Day 1 operations, such as installation and configuration. Operators can also automate Day 2 operations, such as autoscaling up or down and creating backups. All of these activities are directed by a piece of software running on your cluster. +endif::index[] + While both follow similar Operator concepts and goals, Operators in {product-title} are managed by two different systems, depending on their purpose: -* Cluster Operators, which are managed by the Cluster Version Operator (CVO), are installed by default to perform cluster functions. -* Optional add-on Operators, which are managed by Operator Lifecycle Manager (OLM), can be made accessible for users to run in their applications. +Cluster Operators:: Managed by the Cluster Version Operator (CVO) and installed by default to perform cluster functions. +Optional add-on Operators:: Managed by Operator Lifecycle Manager (OLM) and can be made accessible for users to run in their applications. Also known as _OLM-based Operators_. ifeval::["{context}" == "operators-overview"] :!index: diff --git a/operators/index.adoc b/operators/index.adoc index 4fea6077aaa1..3fb1d5153493 100644 --- a/operators/index.adoc +++ b/operators/index.adoc @@ -8,12 +8,10 @@ toc::[] include::modules/operators-overview.adoc[leveloffset=+1] -With Operators, you can create applications to monitor the running services in the cluster. Operators are designed specifically for your applications. Operators implement and automate the common Day 1 operations such as installation and configuration as well as Day 2 operations such as autoscaling up and down and creating backups. All these activities are in a piece of software running inside your cluster. - -[id="operators-overview-developer-tasks"] +[id="operators-overview-developer-tasks_{context}"] == For developers -As a developer, you can perform the following Operator tasks: +As an Operator author, you can perform the following development tasks for OLM-based Operators: ** xref:../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Install Operator SDK CLI]. // The Operator quickstarts aren't published for OSD/ROSA, so for OSD/ROSA, these xrefs point to the tutorials instead. @@ -37,11 +35,11 @@ ifndef::openshift-dedicated,openshift-rosa[] * xref:../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion-uses_deleting-machine[Machine deletion lifecycle hook examples for Operator developers] endif::openshift-dedicated,openshift-rosa[] -[id="operators-overview-administrator-tasks"] +[id="operators-overview-administrator-tasks_{context}"] == For administrators ifndef::openshift-dedicated,openshift-rosa[] -As a cluster administrator, you can perform the following Operator tasks: +As a cluster administrator, you can perform the following administrative tasks for OLM-based Operators: endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] @@ -66,7 +64,7 @@ endif::openshift-dedicated,openshift-rosa[] ifndef::openshift-dedicated,openshift-rosa[] ** xref:../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Use Operator Lifecycle Manager on restricted networks]. -To know all about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference]. +For information about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference]. endif::openshift-dedicated,openshift-rosa[] [id="operators-overview-next-steps"]