mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
76 lines
5.3 KiB
Plaintext
76 lines
5.3 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="operators-overview"]
|
|
= Operators overview
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: operators-overview
|
|
|
|
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"]
|
|
== For developers
|
|
|
|
As a developer, you can perform the following Operator tasks:
|
|
|
|
** 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.
|
|
ifndef::openshift-dedicated,openshift-rosa[]
|
|
** 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], xref:../operators/operator_sdk/java/osdk-java-quickstart.adoc#osdk-java-quickstart[Java-based Operators], and xref:../operators/operator_sdk/helm/osdk-helm-quickstart.adoc#osdk-helm-quickstart[Helm-based Operators].
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
// TODO: When the Java-based Operators is GA, it can be added to the list below for OSD/ROSA.
|
|
ifdef::openshift-dedicated,openshift-rosa[]
|
|
** Create xref:../operators/operator_sdk/golang/osdk-golang-tutorial.adoc#osdk-golang-tutorial[Go-based Operators], xref:../operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc#osdk-ansible-tutorial[Ansible-based Operators], and xref:../operators/operator_sdk/helm/osdk-helm-tutorial.adoc#osdk-helm-tutorial[Helm-based Operators].
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
** xref:../operators/operator_sdk/osdk-about.adoc#osdk-about[Use Operator SDK to build, test, and deploy an Operator].
|
|
ifndef::openshift-dedicated,openshift-rosa[]
|
|
** xref:../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Install and subscribe an Operator to your namespace].
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
** 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].
|
|
|
|
// This xref could be relevant for OSD/ROSA, but the target doesn't currently exist in the OSD/ROSA docs.
|
|
ifndef::openshift-dedicated,openshift-rosa[]
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
* 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"]
|
|
== For administrators
|
|
|
|
ifndef::openshift-dedicated,openshift-rosa[]
|
|
As a cluster administrator, you can perform the following Operator tasks:
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
|
|
ifdef::openshift-dedicated,openshift-rosa[]
|
|
As an administrator with the `dedicated-admin` role, you can perform the following Operator tasks:
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
|
|
** xref:../operators/admin/olm-managing-custom-catalogs.adoc#olm-managing-custom-catalogs[Manage custom catalogs].
|
|
ifndef::openshift-dedicated,openshift-rosa[]
|
|
** xref:../operators/admin/olm-creating-policy.adoc#olm-creating-policy[Allow non-cluster administrators to install Operators].
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
ifndef::openshift-dedicated,openshift-rosa[]
|
|
** xref:../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace[Install an Operator from OperatorHub].
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
ifdef::openshift-dedicated,openshift-rosa[]
|
|
** xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Install an Operator from OperatorHub].
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
** xref:../operators/admin/olm-status.adoc#olm-status[View Operator status].
|
|
** xref:../operators/admin/olm-managing-operatorconditions.adoc#olm-managing-operatorconditions[Manage Operator conditions].
|
|
** xref:../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Upgrade installed Operators].
|
|
** xref:../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Delete installed Operators].
|
|
** xref:../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[Configure proxy support].
|
|
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].
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
|
|
[id="operators-overview-next-steps"]
|
|
== Next steps
|
|
|
|
To understand more about Operators, see xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[What are Operators?]
|