Skip to content

Commit 230e6dd

Browse files
authored
Merge pull request #83425 from adellape/operatorindex
OCPBUGS#35554: Clarify OLM vs CVO Operators in book index
2 parents 7fbd7a7 + 808803e commit 230e6dd

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

modules/operators-overview.adoc

+8-4
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,24 @@ ifndef::index[]
1414
= Operators in {product-title}
1515
endif::[]
1616

17-
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.
17+
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.
1818

19-
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.
19+
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.
2020

2121
ifndef::index[]
2222
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.
2323

2424
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.
2525
endif::[]
2626

27+
ifdef::index[]
28+
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.
29+
endif::index[]
30+
2731
While both follow similar Operator concepts and goals, Operators in {product-title} are managed by two different systems, depending on their purpose:
2832

29-
* Cluster Operators, which are managed by the Cluster Version Operator (CVO), are installed by default to perform cluster functions.
30-
* Optional add-on Operators, which are managed by Operator Lifecycle Manager (OLM), can be made accessible for users to run in their applications.
33+
Cluster Operators:: Managed by the Cluster Version Operator (CVO) and installed by default to perform cluster functions.
34+
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_.
3135

3236
ifeval::["{context}" == "operators-overview"]
3337
:!index:

operators/index.adoc

+5-7
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,10 @@ toc::[]
88

99
include::modules/operators-overview.adoc[leveloffset=+1]
1010

11-
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.
12-
13-
[id="operators-overview-developer-tasks"]
11+
[id="operators-overview-developer-tasks_{context}"]
1412
== For developers
1513

16-
As a developer, you can perform the following Operator tasks:
14+
As an Operator author, you can perform the following development tasks for OLM-based Operators:
1715

1816
** xref:../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Install Operator SDK CLI].
1917
// 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[]
3735
* xref:../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion-uses_deleting-machine[Machine deletion lifecycle hook examples for Operator developers]
3836
endif::openshift-dedicated,openshift-rosa[]
3937

40-
[id="operators-overview-administrator-tasks"]
38+
[id="operators-overview-administrator-tasks_{context}"]
4139
== For administrators
4240

4341
ifndef::openshift-dedicated,openshift-rosa[]
44-
As a cluster administrator, you can perform the following Operator tasks:
42+
As a cluster administrator, you can perform the following administrative tasks for OLM-based Operators:
4543
endif::openshift-dedicated,openshift-rosa[]
4644

4745
ifdef::openshift-dedicated,openshift-rosa[]
@@ -68,7 +66,7 @@ ifndef::openshift-dedicated,openshift-rosa[]
6866

6967
// Not sure if the xref above should be changed in #82841 since this is the index page of the Operators section
7068

71-
To know all about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference].
69+
For information about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference].
7270
endif::openshift-dedicated,openshift-rosa[]
7371

7472
[id="operators-overview-next-steps"]

0 commit comments

Comments
 (0)