1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/operators/operator-reference.adoc
Aidan Reilly d51917ed74 low latency tuning refactor
Changes for Martin

Martin's 3rd review comments

Martin's 4th review

Final comments from Martin

More updates for Martin

Tweaks for Martin

Martin's comments 22-Apr - workload pods

Apr 30 review comments

final review comments

Michael's comments
2024-05-10 09:01:21 +00:00

165 lines
7.1 KiB
Plaintext

:_mod-docs-content-type: ASSEMBLY
[id="cluster-operators-ref"]
= Cluster Operators reference
include::_attributes/common-attributes.adoc[]
:context: cluster-operators-ref
toc::[]
This reference guide indexes the _cluster Operators_ shipped by Red Hat that serve as the architectural foundation for {product-title}. Cluster Operators are installed by default, unless otherwise noted, and are managed by the Cluster Version Operator (CVO). For more details on the control plane architecture, see xref:../architecture/control-plane.adoc#operators-overview_control-plane[Operators in {product-title}].
Cluster administrators can view cluster Operators in the {product-title} web console from the *Administration* -> *Cluster Settings* page.
[NOTE]
====
Cluster Operators are not managed by Operator Lifecycle Manager (OLM) and OperatorHub. OLM and OperatorHub are part of the link:https://operatorframework.io/[Operator Framework] used in {product-title} for installing and running optional xref:../architecture/control-plane.adoc#olm-operators_control-plane[add-on Operators].
====
Some of the following cluster Operators can be disabled prior to installation. For more information see xref:../installing/cluster-capabilities.adoc#cluster-capabilities[cluster capabilities].
include::modules/cluster-bare-metal-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../installing/cluster-capabilities.adoc#cluster-bare-metal-operator_cluster-capabilities[Bare-metal capability]
include::modules/baremetal-event-relay.adoc[leveloffset=+1]
include::modules/cloud-credential-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
[discrete]
[id="additional-resources_cluster-op-ref-cco"]
=== Additional resources
* xref:../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[About the Cloud Credential Operator]
* xref:../rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest` custom resource]
include::modules/cluster-authentication-operator.adoc[leveloffset=+1]
include::modules/cluster-autoscaler-operator.adoc[leveloffset=+1]
include::modules/cluster-cloud-controller-manager-operator.adoc[leveloffset=+1]
include::modules/cluster-capi-operator.adoc[leveloffset=+1]
include::modules/cluster-config-operator.adoc[leveloffset=+1]
include::modules/cluster-csi-snapshot-controller-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../installing/cluster-capabilities.adoc#cluster-csi-snapshot-controller-operator_cluster-capabilities[CSI snapshot controller capability]
include::modules/cluster-image-registry-operator.adoc[leveloffset=+1]
include::modules/cluster-machine-approver-operator.adoc[leveloffset=+1]
include::modules/cluster-monitoring-operator.adoc[leveloffset=+1]
include::modules/cluster-network-operator.adoc[leveloffset=+1]
include::modules/cluster-samples-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../installing/cluster-capabilities.adoc#cluster-samples-operator_cluster-capabilities[OpenShift samples capability]
include::modules/cluster-storage-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../installing/cluster-capabilities.adoc#cluster-storage-operator_cluster-capabilities[Storage capability]
include::modules/cluster-version-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../updating/understanding_updates/intro-to-updates.adoc#understanding-clusterversion-conditiontypes_understanding-openshift-updates[Understanding cluster version condition types]
include::modules/console-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../installing/cluster-capabilities.adoc#console-operator_cluster-capabilities[Web console capability]
include::modules/control-plane-machine-set-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
[discrete]
[id="additional-resources_cluster-op-ref-cpmso"]
=== Additional resources
* xref:../machine_management/control_plane_machine_management/cpmso-about.adoc#cpmso-about[About control plane machine sets]
* xref:../rest_api/machine_apis/controlplanemachineset-machine-openshift-io-v1.adoc#controlplanemachineset-machine-openshift-io-v1[`ControlPlaneMachineSet` custom resource]
include::modules/cluster-dns-operator.adoc[leveloffset=+1]
include::modules/etcd-operator.adoc[leveloffset=+1]
include::modules/ingress-operator.adoc[leveloffset=+1]
include::modules/insights-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../installing/cluster-capabilities.adoc#insights-operator_cluster-capabilities[Insights capability]
* See xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for details about Insights Operator and Telemetry.
include::modules/kube-apiserver-operator.adoc[leveloffset=+1]
include::modules/kube-controller-manager-operator.adoc[leveloffset=+1]
include::modules/cluster-kube-scheduler-operator.adoc[leveloffset=+1]
include::modules/cluster-kube-storage-version-migrator-operator.adoc[leveloffset=+1]
include::modules/machine-api-operator.adoc[leveloffset=+1]
include::modules/machine-config-operator.adoc[leveloffset=+1]
include::modules/operator-marketplace.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../installing/cluster-capabilities.adoc#marketplace-operator_cluster-capabilities[Marketplace capability]
include::modules/node-tuning-operator.adoc[leveloffset=+1]
[discrete]
[role="_additional-resources"]
[id="cluster-operators-ref-nto-addtl-resources"]
=== Additional resources
* xref:../scalability_and_performance/low_latency_tuning/cnf-understanding-low-latency.adoc#cnf-understanding-low-latency_cnf-understanding-low-latency[About low latency]
include::modules/openshift-apiserver-operator.adoc[leveloffset=+1]
include::modules/cluster-openshift-controller-manager-operators.adoc[leveloffset=+1]
[id="cluster-operators-ref-olm"]
== Operator Lifecycle Manager Operators
[discrete]
include::modules/olm-overview.adoc[leveloffset=+2]
[discrete]
include::modules/olm-architecture.adoc[leveloffset=+2]
[discrete]
include::modules/olm-arch-olm-operator.adoc[leveloffset=+2]
[discrete]
include::modules/olm-arch-catalog-operator.adoc[leveloffset=+2]
[discrete]
include::modules/olm-arch-catalog-registry.adoc[leveloffset=+2]
[role="_additional-resources"]
[discrete]
[id="cluster-operators-ref-olm-addtl-resources"]
=== Additional resources
* For more information, see the sections on xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[understanding Operator Lifecycle Manager (OLM)].
include::modules/openshift-service-ca-operator.adoc[leveloffset=+1]
include::modules/vsphere-problem-detector-operator.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* For more details, see xref:../installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc#using-vsphere-problem-detector-operator[Using the vSphere Problem Detector Operator].