Skip to content

Commit 13634a0

Browse files
author
Amrita
committed
Operators overview
1 parent 7e9104b commit 13634a0

File tree

3 files changed

+60
-1
lines changed

3 files changed

+60
-1
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1244,6 +1244,8 @@ Name: Operators
12441244
Dir: operators
12451245
Distros: openshift-enterprise,openshift-origin
12461246
Topics:
1247+
- Name: Operators overview
1248+
File: index
12471249
- Name: Understanding Operators
12481250
Dir: understanding
12491251
Topics:

modules/operators-overview.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
// Module included in the following assemblies:
22
//
33
// * architecture/control-plane.adoc
4+
// * operators/index.adoc
45

6+
7+
ifeval::["{context}" == "operators-overview"]
8+
:index:
9+
endif::[]
10+
11+
:_content-type: CONCEPT
512
[id="operators-overview_{context}"]
6-
= Operators in {product-title}
713

814
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.
915

1016
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.
1117

18+
ifndef::index[]
1219
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.
1320

1421
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.
22+
endif::[]
1523

1624
While both follow similar Operator concepts and goals, Operators in {product-title} are managed by two different systems, depending on their purpose:
1725

1826
* Platform Operators, which are managed by the Cluster Version Operator (CVO), are installed by default to perform cluster functions.
1927
* Optional add-on Operators, which are managed by Operator Lifecycle Manager (OLM), can be made accessible for users to run in their applications.
28+
29+
ifeval::["{context}" == "operators-overview"]
30+
:!index:
31+
endif::[]

operators/index.adoc

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
:_content-type: ASSEMBLY
2+
[id="operators-overview"]
3+
= Operators overview
4+
include::modules/common-attributes.adoc[]
5+
:context: operators-overview
6+
7+
toc::[]
8+
9+
include::modules/operators-overview.adoc[leveloffset=+1]
10+
11+
With Operators, you can create applications to monitor the running services in the cluster.
12+
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.
13+
14+
15+
[id="overview-developer-tasks"]
16+
== For developers
17+
18+
As a developer, you can perform the following Operator tasks:
19+
20+
** xref:../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Install Operator SDK CLI].
21+
** Create xref:../operators/operator_sdk/golang/osdk-golang-quickstart.adoc#osdk-golang-quickstart[Go-based Operators], xref:../operators/operator_sdk/ansible/osdk-ansible-quickstart.adoc#osdk-ansible-quickstart[Ansible-based Operators], and xref:../operators/operator_sdk/helm/osdk-helm-quickstart.adoc#osdk-helm-quickstart[Helm-based Operators].
22+
** xref:../operators/operator_sdk/osdk-about.adoc#osdk-about[Use Operator SDK to build,test, and deploy an Operator].
23+
** xref:../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Install and subscribe an Operator to your namespace].
24+
** xref:../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[Create an application from an installed Operator through the web console].
25+
26+
[id="overview-administrator-tasks"]
27+
== For administrators
28+
29+
As a cluster administrator, you can perform the following Operator tasks:
30+
31+
** xref:../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Manage custom catalogs]
32+
** xref:../operators/admin/olm-creating-policy.adoc#olm-creating-policy[Allow non-cluster administrators to install Operators]
33+
** xref:../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Install an Operator from OperatorHub]
34+
** xref:../operators/admin/olm-status.adoc#olm-status[View Operator status].
35+
** xref:../operators/admin/olm-managing-operatorconditions.adoc#olm-managing-operatorconditions[Manage Operator conditions]
36+
** xref:../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Upgrade installed Operators]
37+
** xref:../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Delete installed Operators]
38+
** xref:../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[Configure proxy support]
39+
** xref:../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Use Operator Lifecycle Manager on restricted networks]
40+
41+
To know all about the Platform Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#platform-operators-ref[Red Hat Operators]
42+
43+
== Next steps
44+
45+
To understand more about Operators, see xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[What are Operators?]

0 commit comments

Comments
 (0)