Update operators documentation - #83
Open
SupremeMortal wants to merge 4 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the OKD documentation site’s Operators section by replacing the previous OperatorHub-focused page with a new Operators landing page and introducing initial documentation for the OKDerators catalog.
Changes:
- Replaces the old
operators.mdcontent with a newdocs/operators/index.mdlanding page. - Adds a new OKDerators docs section (overview, directory, contribution guide) and Docusaurus category metadata.
- Adds an OKDerators operator inventory table and installation instructions for the OKDerators catalog.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/operators/operators.md | Removes the previous Operator Hub Catalogs page content. |
| docs/operators/index.md | Adds new Operators landing page and OKDerators introduction link. |
| docs/operators/okderators/index.md | Adds OKDerators overview and install instructions. |
| docs/operators/okderators/directory.md | Adds OKDerators operator inventory table. |
| docs/operators/okderators/contribute.md | Adds contribution guidance and links for OKDerators packaging. |
| docs/operators/okderators/category.yml | Adds Docusaurus category metadata for OKDerators docs section. |
Suppressed comments (5)
docs/operators/index.md:40
- "RedHat" / "opionated" are misspelled here; using the standard "Red Hat" spelling and "opinionated" improves clarity.
Some vendors (such as RedHat) use the term "Cluster Extension" to describe an opionated deployment of an operator or set of operators that bring significant functionality into their Kubernetes distribution (such as Storage or Virtualisation).
docs/operators/okderators/index.md:19
- Brand spelling: "RedHat's" should be "Red Hat's".
Currently, the choice of what operators are included and packaged as an OKDerator is mainly driven by what's included in RedHat's OpenShift catalogs, and we will use their "mid-stream" versions of the open source project.
docs/operators/okderators/directory.md:35
- Typo: "Red Had" -> "Red Hat".
| cluster-logging | Red Hat OpenShift Logging | stable-6.4 | 6.4.2 | OKD Logging (Loki) | Utility | Red Hat OpenShift Logging The Red Hat OpenShift Logging Operator orchestrates log collection and forwarding to Red Had managed log stores and other third-party… | [source](https://github.com/openshift/cluster-logging-operator) | | High | Yes | ✅ | ✅ |
docs/operators/okderators/directory.md:62
- Typo: "moethod" -> "method".
| external-dns-operator | ExternalDNS Operator | stable-v1 | 1.3.3 | | Utility | deploys https://github.com/kubernetes-sigs/external-dns via operator moethod | [source](https://github.com/openshift/external-dns-operator) | | High | No | ❌ | ❌ |
docs/operators/okderators/directory.md:98
- This row has multiple typos ("Openshift", "Introdution", and "cluster wide") that will be visible in the rendered directory.
| ptp-operator | PTP Operator | stable | 4.21.0-202602180447 | | | Precision Time Protocol (PTP) Operator for Openshift ## Introdution PTP Operator manages cluster wide PTP configuration. | [source](https://github.com/k8snetworkplumbingwg/ptp-operator) | | | No | ❌ | ❌ |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ### Isn't that what Helm is for? | ||
|
|
||
| Helm is a different way of deploying software into Kubernetes clusters. Helm Chats are a set of templates, and then based on your specification (from `values.yaml`), the Helm Controller renders those resources out. Helm Charts often relies on existing Kubernetes primitives (e.g. Deployment) to manage the running pods. |
|
|
||
| ### [OKDerators](./okderators/index.md) | ||
|
|
||
| The OKD Working Group packages an opionated and curated set of operators called "[OKDerators](./okderators/index.md)". These are intended to be the OKD alternative to the private catalogs included within OpenShift (see below). |
| ## Where can I find Operators to install on my cluster? | ||
| OKD currently by default includes a catalog shared with OpenShift called "[Community Operators](https://github.com/redhat-openshift-ecosystem/community-operators-prod)". These Community Operators are often packaged with OKD/OpenShift in mind. | ||
|
|
||
| There is also [OperatorHub.io](https://operatorhub.io/) which contains a larger catalog of software, however operators in this catalog are more likely to not be compatible with OKD/Openshift. |
|
|
||
| ### Can I install OpenShift Cluster Extensions/Operators on my OKD cluster? | ||
|
|
||
| Red Hat OpenShift includes two additional private catalog sources. "redhat-operators" and "certified |
|
|
||
| ## What are OKDerators? | ||
|
|
||
| OKDerators are a curated and opionated catalog of operators for deployment onto OKD clusters. |
|
|
||
| ## I think Operator X should be used to solve Y instead of Operator Z | ||
|
|
||
| Our choice of operators is currently driven by what's included in the RedHat OpenShift first-party catalog. Over time we may diverge or have an additional options (e.g. via an additional "extras" CatalogSource) but at the time of writing we are not sure what that will look like. |
| @@ -0,0 +1,149 @@ | |||
| # Directory | |||
|
|
|||
| The goal of OKDerators is to provide a full suite of options for deploying many of the operators found in RedHat OpenShift. | |||
| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | ||
| | advanced-cluster-management | Advanced Cluster Management for Kubernetes | release-2.15 | 2.15.1 | OKD Multi Cluster (Stolostron) | Suite | Stolostron is OKD integrated Open Cluster Management | [source](https://github.com/stolostron/deploy) | Build process requires access to stolostron quay org | High | No | ✅ | ✅ | | ||
| | odf-csi-addons-operator | CSI Addons | stable-4.20 | 4.20.6-rhodf | | | CSI Addons provides the CSI Addons Controller that enables advanced storage operations for CSI-drivers. | | | | | ✅ | ✅ | | ||
| | cluster-observability-operator | Cluster Observability Operator | stable | 1.3.1 | | Suite | Integrated Prometheus, Altermanager and Thanos Querier | [source](https://github.com/rhobs/observability-operator) | WHy this vs user workload monitoring? | High | Yes | ✅ | ✅ | |
| | cluster-logging | Red Hat OpenShift Logging | stable-6.4 | 6.4.2 | OKD Logging (Loki) | Utility | Red Hat OpenShift Logging The Red Hat OpenShift Logging Operator orchestrates log collection and forwarding to Red Had managed log stores and other third-party… | [source](https://github.com/openshift/cluster-logging-operator) | | High | Yes | ✅ | ✅ | | ||
| | servicemeshoperator | Red Hat OpenShift Service Mesh 2 | stable | 2.6.13-0 | OKD Service Mesh (Maistra) | Suite | Red Hat OpenShift Service Mesh 2 is a platform that provides behavioral insight and operational control over a service mesh, providing a uniform way to connect… | [source](https://github.com/maistra) | | High | No | ✅ | ✅ | | ||
| | servicemeshoperator3 | Red Hat OpenShift Service Mesh 3 | stable | 3.2.2 | OKD Service Mesh (Maistra) | Suite | Red Hat OpenShift Service Mesh is a platform that provides behavioral insight and operational control over a service mesh, providing a uniform way to connect,… | [source](https://github.com/maistra) | | High | No | ✅ | ✅ | | ||
| | sriov-network-operator | SR-IOV Network Operator | stable | 4.21.0-202602091142 | | Utility | SR-IOV Network Operator for Openshift ## Introduction The sriov-network-operator is generally responsible for configuring the sriov components in a openshift c… | [source](https://github.com/openshift/sriov-network-operator) | | Medium | No | ✅ | ✅ | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update Operator documentation and include information regarding OKDerators.