mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
Merge pull request #96961 from openshift-cherrypick-robot/cherry-pick-96711-to-enterprise-4.20
[enterprise-4.20] OSDOCS-15521: Remove unnecessary headings and fix ID for Operator ref doc
This commit is contained in:
Ashleigh Brennan
@@ -5,12 +5,9 @@
|
||||
[id="windows-machine-config-operator_{context}"]
|
||||
= Windows Machine Config Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Windows Machine Config Operator (WMCO) orchestrates the process of deploying and managing Windows workloads on a cluster. The WMCO configures Windows machines into compute nodes, enabling Windows container workloads to run in {product-title} clusters. This is done by creating a compute machine set that uses a Windows image with the Docker-formatted container runtime installed. The WMCO completes all necessary steps to configure the underlying Windows VM so that it can join the cluster as a compute node.
|
||||
|
||||
[discrete]
|
||||
== Project
|
||||
|
||||
link:https://github.com/openshift/windows-machine-config-operator[windows-machine-config-operator]
|
||||
link:https://github.com/openshift/windows-machine-config-operator[windows-machine-config-operator]
|
||||
|
||||
@@ -47,7 +47,7 @@ include::modules/arch-cluster-operators.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference]
|
||||
* xref:../operators/operator-reference.adoc#operator-reference[Cluster Operators reference]
|
||||
endif::[]
|
||||
|
||||
include::modules/arch-olm-operators.adoc[leveloffset=+2]
|
||||
|
||||
@@ -112,4 +112,4 @@ To resolve insufficient credentials issues, provide a credential with sufficient
|
||||
[id="additional-resources_about-cloud-credential-operator_{context}"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../operators/operator-reference.adoc#cloud-credential-operator_cluster-operators-ref[Cluster Operators reference page for the Cloud Credential Operator]
|
||||
* xref:../../operators/operator-reference.adoc#cloud-credential-operator_operator-reference[Cluster Operators reference page for the Cloud Credential Operator]
|
||||
|
||||
@@ -14,7 +14,7 @@ The same machine config is applied on all nodes or only on one MCP in the cluste
|
||||
|
||||
For more information about how and why to apply MCPs in a telco core cluster, see xref:../../../edge_computing/day_2_core_cnf_clusters/updating/telco-update-ocp-update-prep.adoc#telco-update-applying-mcp-labels-to-nodes-before-the-update_ocp-update-prep[Applying MachineConfigPool labels to nodes before the update].
|
||||
|
||||
For more information about the Machine Config Operator, see xref:../../../operators/operator-reference.adoc#machine-config-operator_cluster-operators-ref[Machine Config Operator].
|
||||
For more information about the Machine Config Operator, see xref:../../../operators/operator-reference.adoc#machine-config-operator_operator-reference[Machine Config Operator].
|
||||
|
||||
include::modules/telco-troubleshooting-mco-purpose.adoc[leveloffset=+1]
|
||||
include::modules/telco-troubleshooting-mco-apply-several-mcs.adoc[leveloffset=+1]
|
||||
include::modules/telco-troubleshooting-mco-apply-several-mcs.adoc[leveloffset=+1]
|
||||
|
||||
@@ -63,4 +63,4 @@ include::modules/olmv1-blocked-cluster-updates.adoc[leveloffset=+2]
|
||||
* xref:../../updating/understanding_updates/intro-to-updates.adoc#understanding_clusteroperator_conditiontypes_understanding-openshift-updates[Understanding cluster Operator condition types]
|
||||
* xref:../../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Upgrading installed Operators]
|
||||
* xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster]
|
||||
* xref:../../operators/operator-reference.adoc#cluster-operators-ref-olmv1_cluster-operators-ref[Cluster Operators reference -> {olmv1-first} Operator]
|
||||
* xref:../../operators/operator-reference.adoc#cluster-operators-ref-olmv1_operator-reference[Cluster Operators reference -> {olmv1-first} Operator]
|
||||
|
||||
@@ -33,4 +33,4 @@ include::modules/osdk-cco-aws-sts-enabling.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* xref:../operators/operator-reference.adoc#cloud-credential-operator_cluster-operators-ref[Cluster Operators reference page for the Cloud Credential Operator]
|
||||
* xref:../operators/operator-reference.adoc#cloud-credential-operator_operator-reference[Cluster Operators reference page for the Cloud Credential Operator]
|
||||
|
||||
@@ -92,10 +92,10 @@ include::modules/machine-api-capability.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../machine_management/index.html#index[Overview of machine management]
|
||||
* xref:../../operators/operator-reference.html#machine-api-operator_cluster-operators-ref[Machine API Operator]
|
||||
* xref:../../operators/operator-reference.html#cluster-autoscaler-operator_cluster-operators-ref[Cluster Autoscaler Operator]
|
||||
* xref:../../operators/operator-reference.html#control-plane-machine-set-operator_cluster-operators-ref[Control Plane Machine Set Operator]
|
||||
* xref:../../machine_management/index.adoc#index[Overview of machine management]
|
||||
* xref:../../operators/operator-reference.adoc#machine-api-operator_operator-reference[Machine API Operator]
|
||||
* xref:../../operators/operator-reference.adoc#cluster-autoscaler-operator_operator-reference[Cluster Autoscaler Operator]
|
||||
* xref:../../operators/operator-reference.adoc#control-plane-machine-set-operator_operator-reference[Control Plane Machine Set Operator]
|
||||
|
||||
// Marketplace capability
|
||||
include::modules/operator-marketplace.adoc[leveloffset=+2]
|
||||
|
||||
@@ -39,7 +39,7 @@ include::modules/capi-arch-operator.adoc[leveloffset=+2]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../operators/operator-reference.adoc#cluster-capi-operator_cluster-operators-ref[{cluster-capi-operator}]
|
||||
* xref:../../operators/operator-reference.adoc#cluster-capi-operator_operator-reference[{cluster-capi-operator}]
|
||||
|
||||
//Cluster API primary resources
|
||||
include::modules/capi-arch-resources.adoc[leveloffset=+2]
|
||||
include::modules/capi-arch-resources.adoc[leveloffset=+2]
|
||||
|
||||
@@ -25,5 +25,5 @@ include::modules/cpmso-limitations.adoc[leveloffset=+2]
|
||||
[id="additional-resources_cpmso-about"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../operators/operator-reference.adoc#control-plane-machine-set-operator_cluster-operators-ref[Control Plane Machine Set Operator reference]
|
||||
* xref:../../rest_api/machine_apis/controlplanemachineset-machine-openshift-io-v1.adoc#controlplanemachineset-machine-openshift-io-v1[`ControlPlaneMachineSet` custom resource]
|
||||
* xref:../../operators/operator-reference.adoc#control-plane-machine-set-operator_operator-reference[Control Plane Machine Set Operator reference]
|
||||
* xref:../../rest_api/machine_apis/controlplanemachineset-machine-openshift-io-v1.adoc#controlplanemachineset-machine-openshift-io-v1[`ControlPlaneMachineSet` custom resource]
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
// * operators/operator-reference.adoc
|
||||
// * installing/modules/node-tuning-operator.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operators:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-capabilities"]
|
||||
@@ -15,9 +15,6 @@ endif::[]
|
||||
ifdef::operators[= Cloud Credential Operator]
|
||||
ifdef::cluster-caps[= Cloud credential capability]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
The Cloud Credential Operator provides features for the `CloudCredential` capability.
|
||||
|
||||
@@ -51,9 +48,9 @@ link:https://github.com/openshift/cloud-credential-operator[openshift-cloud-cred
|
||||
No configuration required.
|
||||
endif::operators[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operators:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-capabilities"]
|
||||
:!cluster-caps:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="cluster-authentication-operator_{context}"]
|
||||
= Cluster Authentication Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Cluster Authentication Operator installs and maintains the `Authentication` custom resource in a cluster and can be viewed with:
|
||||
|
||||
[source,terminal]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="cluster-autoscaler-operator_{context}"]
|
||||
= Cluster Autoscaler Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Cluster Autoscaler Operator manages deployments of the OpenShift Cluster Autoscaler using the `cluster-api` provider.
|
||||
|
||||
[discrete]
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
// * operators/operator-reference.adoc
|
||||
// * installing/overview/cluster-capabilities.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -25,9 +25,6 @@ The Cluster Baremetal Operator is an optional cluster capability that can be dis
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
|
||||
The Cluster Baremetal Operator provides the features for the `baremetal` capability.
|
||||
@@ -59,7 +56,7 @@ link:https://github.com/openshift/cluster-baremetal-operator[cluster-baremetal-o
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
|
||||
|
||||
@@ -5,16 +5,13 @@
|
||||
[id="cluster-capi-operator_{context}"]
|
||||
= {cluster-capi-operator}
|
||||
|
||||
The {cluster-capi-operator} maintains the lifecycle of Cluster API resources. This Operator is responsible for all administrative tasks related to deploying the Cluster API project within an {product-title} cluster.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
This Operator is available as a link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] for {aws-first}, {gcp-first}, {azure-first}, {rh-openstack-first}, and {vmw-first} clusters.
|
||||
====
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The {cluster-capi-operator} maintains the lifecycle of Cluster API resources. This Operator is responsible for all administrative tasks related to deploying the Cluster API project within an {product-title} cluster.
|
||||
|
||||
[discrete]
|
||||
== Project
|
||||
|
||||
@@ -69,4 +66,4 @@ link:https://github.com/openshift/cluster-capi-operator[cluster-capi-operator]
|
||||
|
||||
* `metal3machinetemplates.infrastructure.cluster.x-k8s.io`
|
||||
** Scope: Namespaced
|
||||
** CR: `metal3machinetemplate`
|
||||
** CR: `metal3machinetemplate`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// * operators/operator-reference.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operators:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-capabilities"]
|
||||
@@ -13,9 +13,6 @@ endif::[]
|
||||
ifdef::operators[= Cloud Controller Manager Operator]
|
||||
ifdef::cluster-caps[= Cloud controller manager capability]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
The Cloud Controller Manager Operator provides features for the `CloudControllerManager` capability.
|
||||
|
||||
@@ -62,9 +59,9 @@ ifdef::operators[]
|
||||
link:https://github.com/openshift/cluster-cloud-controller-manager-operator[cluster-cloud-controller-manager-operator]
|
||||
endif::operators[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operators:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-capabilities"]
|
||||
:!cluster-caps:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="cluster-config-operator_{context}"]
|
||||
= Cluster Config Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Cluster Config Operator performs the following tasks related to `config.openshift.io`:
|
||||
|
||||
* Creates CRDs.
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
// * operators/operator-reference.adoc
|
||||
// * installing/overview/cluster-capabilities.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -25,9 +25,6 @@ The Cluster CSI Snapshot Controller Operator is an optional cluster capability t
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
|
||||
The Cluster CSI Snapshot Controller Operator provides the features for the `CSISnapshot` capability.
|
||||
@@ -45,10 +42,10 @@ link:https://github.com/openshift/cluster-csi-snapshot-controller-operator[clust
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-caps"]
|
||||
:!cluster-caps:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="dns-operator_{context}"]
|
||||
= DNS Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The DNS Operator deploys and manages CoreDNS to provide a name resolution service to pods that enables DNS-based Kubernetes Service discovery in {product-title}.
|
||||
|
||||
The Operator creates a working default deployment based on the cluster's configuration.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
// * installing/overview/cluster-capabilities.adoc
|
||||
|
||||
// operators/operator-reference.adoc
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -18,9 +18,6 @@ endif::[]
|
||||
ifdef::operator-ref[= Cluster Image Registry Operator]
|
||||
ifdef::cluster-caps[= Cluster Image Registry capability]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
The Cluster Image Registry Operator provides features for the `ImageRegistry` capability.
|
||||
endif::[]
|
||||
@@ -49,7 +46,7 @@ endif::[]
|
||||
|
||||
link:https://github.com/openshift/cluster-image-registry-operator[cluster-image-registry-operator]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-capabilities"]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="cluster-kube-scheduler-operator_{context}"]
|
||||
= Kubernetes Scheduler Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Kubernetes Scheduler Operator manages and updates the Kubernetes Scheduler deployed on top of {product-title}. The Operator is based on the {product-title} `library-go` framework and it is installed with the Cluster Version Operator (CVO).
|
||||
|
||||
The Kubernetes Scheduler Operator contains the following components:
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="cluster-kube-storage-version-migrator-operator_{context}"]
|
||||
= Kubernetes Storage Version Migrator Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Kubernetes Storage Version Migrator Operator detects changes of the default storage version, creates migration requests for resource types when the storage version changes, and processes migration requests.
|
||||
|
||||
[discrete]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="cluster-machine-approver-operator_{context}"]
|
||||
= Cluster Machine Approver Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Cluster Machine Approver Operator automatically approves the CSRs requested for a new worker node after cluster installation.
|
||||
|
||||
[NOTE]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="cluster-monitoring-operator_{context}"]
|
||||
= {cmo-full}
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The {cmo-first} manages and updates the Prometheus-based cluster monitoring stack deployed on top of {product-title}.
|
||||
|
||||
[discrete]
|
||||
|
||||
@@ -5,7 +5,4 @@
|
||||
[id="cluster-network-operator_{context}"]
|
||||
= Cluster Network Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Cluster Network Operator installs and upgrades the networking components on an {product-title} cluster.
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="cluster-openshift-controller-manager-operator_{context}"]
|
||||
= OpenShift Controller Manager Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The OpenShift Controller Manager Operator installs and maintains the `OpenShiftControllerManager` custom resource in a cluster and can be viewed with:
|
||||
|
||||
[source,terminal]
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
// * installing/overview/cluster-capabilities.adoc
|
||||
|
||||
// operators/operator-reference.adoc
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -27,9 +27,6 @@ The Cluster Samples Operator is an optional cluster capability that can be disab
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
The Cluster Samples Operator provides the features for the `openshift-samples` capability.
|
||||
endif::cluster-caps[]
|
||||
@@ -66,10 +63,10 @@ Upon deletion of the samples resource, the Cluster Samples Operator recreates th
|
||||
link:https://github.com/openshift/cluster-samples-operator[cluster-samples-operator]
|
||||
endif::operator-ref[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-caps"]
|
||||
:!cluster-caps:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
// * operators/operator-reference.adoc
|
||||
// * installing/overview/cluster-capabilities.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -24,9 +24,6 @@ The Cluster Storage Operator is an optional cluster capability that can be disab
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
|
||||
The Cluster Storage Operator provides the features for the `Storage` capability.
|
||||
@@ -61,10 +58,10 @@ endif::operator-ref[]
|
||||
|
||||
* The storage class that the Operator creates can be made non-default by editing its annotation, but this storage class cannot be deleted as long as the Operator runs.
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-caps"]
|
||||
:!cluster-caps:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -5,12 +5,9 @@
|
||||
[id="cluster-version-operator_{context}"]
|
||||
= Cluster Version Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
Cluster Operators manage specific areas of cluster functionality. The Cluster Version Operator (CVO) manages the lifecycle of cluster Operators, many of which are installed in {product-title} by default.
|
||||
|
||||
The CVO also checks with the OpenShift Update Service to see the valid updates and update paths based on current component versions and information in the graph by collecting the status of both the cluster version and its cluster Operators. This status includes the condition type, which informs you of the health and current state of the {product-title} cluster.
|
||||
The CVO also checks with the OpenShift Update Service to see the valid updates and update paths based on current component versions and information in the graph by collecting the status of both the cluster version and its cluster Operators. This status includes the condition type, which informs you of the health and current state of the {product-title} cluster.
|
||||
|
||||
For more information regarding cluster version condition types, see "Understanding cluster version condition types".
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
// * installing/overview/cluster-capabilities.adoc
|
||||
|
||||
// operators/operator-reference.adoc
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -26,9 +26,6 @@ The Console Operator is an optional cluster capability that can be disabled by c
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
|
||||
The Console Operator provides the features for the `Console` capability.
|
||||
@@ -46,7 +43,7 @@ link:https://github.com/openshift/console-operator[console-operator]
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-capabilities"]
|
||||
|
||||
@@ -5,16 +5,13 @@
|
||||
[id="control-plane-machine-set-operator_{context}"]
|
||||
= Control Plane Machine Set Operator
|
||||
|
||||
The Control Plane Machine Set Operator automates the management of control plane machine resources within an {product-title} cluster.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
This Operator is available for Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, Nutanix, and VMware vSphere.
|
||||
====
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Control Plane Machine Set Operator automates the management of control plane machine resources within an {product-title} cluster.
|
||||
|
||||
[discrete]
|
||||
== Project
|
||||
|
||||
@@ -26,4 +23,4 @@ link:https://github.com/openshift/cluster-control-plane-machine-set-operator[clu
|
||||
* `controlplanemachineset.machine.openshift.io`
|
||||
** Scope: Namespaced
|
||||
** CR: `ControlPlaneMachineSet`
|
||||
** Validation: Yes
|
||||
** Validation: Yes
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="etcd-cluster-operator_{context}"]
|
||||
= etcd cluster Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The etcd cluster Operator automates etcd cluster scaling, enables etcd monitoring and metrics, and simplifies disaster recovery procedures.
|
||||
[discrete]
|
||||
== Project
|
||||
|
||||
@@ -7,7 +7,7 @@ ifeval::["{context}" == "cluster-capabilities"]
|
||||
:cluster-caps:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -16,9 +16,6 @@ endif::[]
|
||||
ifdef::operator-ref[= Ingress Operator]
|
||||
ifdef::cluster-caps[= Ingress Capability]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
|
||||
The Ingress Operator provides the features for the `Ingress` capability.
|
||||
@@ -78,10 +75,10 @@ $ oc get network/cluster -o jsonpath='{.status.clusterNetwork[*]}'
|
||||
map[cidr:10.128.0.0/14 hostPrefix:23]
|
||||
----
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-caps"]
|
||||
:!cluster-caps:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -7,7 +7,7 @@ ifeval::["{context}" == "cluster-capabilities"]
|
||||
:cluster-caps:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -25,9 +25,6 @@ The Insights Operator is an optional cluster capability that can be disabled by
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
|
||||
The Insights Operator provides the features for the `Insights` capability.
|
||||
@@ -55,10 +52,10 @@ endif::operator-ref[]
|
||||
|
||||
Insights Operator complements {product-title} Telemetry.
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-caps"]
|
||||
:!cluster-caps:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="kube-apiserver-operator_{context}"]
|
||||
= Kubernetes API Server Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Kubernetes API Server Operator manages and updates the Kubernetes API server deployed on top of {product-title}. The Operator is based on the {product-title} `library-go` framework and it is installed using the Cluster Version Operator (CVO).
|
||||
|
||||
[discrete]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="kube-controller-manager-operator_{context}"]
|
||||
= Kubernetes Controller Manager Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Kubernetes Controller Manager Operator manages and updates the Kubernetes Controller Manager deployed on top of {product-title}. The Operator is based on {product-title} `library-go` framework and it is installed via the Cluster Version Operator (CVO).
|
||||
|
||||
It contains the following components:
|
||||
|
||||
@@ -6,9 +6,6 @@
|
||||
[id="machine-api-capability_{context}"]
|
||||
= Machine API capability
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The `machine-api-operator`, `cluster-autoscaler-operator`, and `cluster-control-plane-machine-set-operator` Operators provide the features for the `MachineAPI` capability. You can disable this capability only if you install a cluster with user-provisioned infrastructure.
|
||||
|
||||
The Machine API capability is responsible for all machine configuration and management in the cluster. If you disable the Machine API capability during installation, you need to manage all machine-related tasks manually.
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="machine-api-operator_{context}"]
|
||||
= Machine API Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Machine API Operator manages the lifecycle of specific purpose custom resource definitions (CRD), controllers, and RBAC objects that extend the Kubernetes API. This declares the desired state of machines in a cluster.
|
||||
|
||||
[discrete]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="machine-config-operator_{context}"]
|
||||
= Machine Config Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Machine Config Operator manages and applies configuration and updates of the base operating system and container runtime, including everything between the kernel and kubelet.
|
||||
|
||||
There are four components:
|
||||
@@ -23,4 +20,3 @@ include::snippets/mcs-endpoint-limitation.adoc[]
|
||||
== Project
|
||||
|
||||
link:https://github.com/openshift/machine-config-operator[openshift-machine-config-operator]
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
// * nodes/nodes/nodes-node-tuning-operator.adoc
|
||||
// * nodes/nodes/rosa-tuning-config.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operators:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "node-tuning-operator"]
|
||||
@@ -26,11 +26,6 @@ ifdef::perf[]
|
||||
endif::perf[]
|
||||
ifdef::cluster-caps[= Node Tuning capability]
|
||||
|
||||
ifndef::perf[]
|
||||
[discrete]
|
||||
== Purpose
|
||||
endif::perf[]
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
The Node Tuning Operator provides features for the `NodeTuning` capability.
|
||||
endif::cluster-caps[]
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
// * operators/operator-reference.adoc
|
||||
|
||||
[id="olm-architecture_{context}"]
|
||||
ifeval::["{context}" != "cluster-operators-ref"]
|
||||
ifeval::["{context}" != "operator-reference"]
|
||||
= Component responsibilities
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
= CRDs
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" != "cluster-operators-ref"]
|
||||
ifeval::["{context}" != "operator-reference"]
|
||||
Operator Lifecycle Manager (OLM) is composed of two Operators: the OLM Operator and the Catalog Operator.
|
||||
endif::[]
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
// * operators/understanding/olm/olm-understanding-olm.adoc
|
||||
// * operators/operator-reference.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operators:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-capabilities"]
|
||||
@@ -18,14 +18,9 @@ ifndef::cluster-caps[]
|
||||
= What is {olmv0-first}?
|
||||
endif::[]
|
||||
endif::[]
|
||||
ifdef::operators[]
|
||||
= Purpose
|
||||
endif::[]
|
||||
ifdef::cluster-caps[]
|
||||
= {olmv0-first} capability
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
endif::[]
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
@@ -72,10 +67,10 @@ The `marketplace` capability depends on the `OperatorLifecycleManager` capabilit
|
||||
====
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operators:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "cluster-caps"]
|
||||
:!cluster-caps:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
// * operators/operator-reference.adoc
|
||||
// * installing/overview/cluster-capabilities.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operators:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "cluster-capabilities"]
|
||||
@@ -20,9 +20,6 @@ ifdef::cluster-caps[]
|
||||
= {olmv1-first} capability
|
||||
endif::[]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
{olmv1} provides the features for the `OperatorLifecycleManagerV1` capability.
|
||||
endif::[]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="openshift-apiserver-operator_{context}"]
|
||||
= OpenShift API Server Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The OpenShift API Server Operator installs and maintains the `openshift-apiserver` on a cluster.
|
||||
|
||||
[discrete]
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="openshift-service-ca-operator_{context}"]
|
||||
= OpenShift Service CA Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The OpenShift Service CA Operator mints and manages serving certificates for Kubernetes services.
|
||||
|
||||
[discrete]
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
// * installing/overview/cluster-capabilities.adoc
|
||||
|
||||
// operators/operator-reference.adoc
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operator-ref:
|
||||
endif::[]
|
||||
|
||||
@@ -27,9 +27,6 @@ The Marketplace Operator is an optional cluster capability that can be disabled
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
ifdef::cluster-caps[]
|
||||
|
||||
The Marketplace Operator provides the features for the `marketplace` capability.
|
||||
@@ -52,7 +49,7 @@ link:https://github.com/operator-framework/operator-marketplace[operator-marketp
|
||||
|
||||
endif::operator-ref[]
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:!operator-ref:
|
||||
endif::[]
|
||||
|
||||
|
||||
@@ -5,9 +5,6 @@
|
||||
[id="prometheus-operator_{context}"]
|
||||
= Prometheus Operator
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The Prometheus Operator for Kubernetes provides easy monitoring definitions for Kubernetes services and deployment and management of Prometheus instances.
|
||||
|
||||
Once installed, the Prometheus Operator provides the following features:
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
//
|
||||
// * hardware_enablement/psap-node-feature-discovery-operator.adoc
|
||||
|
||||
ifeval::["{context}" == "cluster-operators-ref"]
|
||||
ifeval::["{context}" == "operator-reference"]
|
||||
:operators:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "node-feature-discovery-operator"]
|
||||
@@ -16,10 +16,6 @@ endif::operators[]
|
||||
ifdef::perf[]
|
||||
= About the Node Feature Discovery Operator
|
||||
endif::perf[]
|
||||
ifdef::operators[]
|
||||
[discrete]
|
||||
== Purpose
|
||||
endif::operators[]
|
||||
The Node Feature Discovery Operator (NFD) manages the detection of hardware features and configuration in an {product-title} cluster by labeling the nodes with hardware-specific information. NFD labels the host with node-specific attributes, such as PCI cards, kernel, operating system version, and so on.
|
||||
|
||||
The NFD Operator can be found on the Operator Hub by searching for “Node Feature Discovery”.
|
||||
|
||||
@@ -7,9 +7,6 @@
|
||||
[id="vsphere-problem-detector-operator_{context}"]
|
||||
= {operator-name}
|
||||
|
||||
[discrete]
|
||||
== Purpose
|
||||
|
||||
The {operator-name} checks clusters that are deployed on vSphere for common installation and misconfiguration issues that are related to storage.
|
||||
|
||||
[NOTE]
|
||||
|
||||
@@ -74,5 +74,4 @@ include::modules/nodes-edge-remote-workers-strategies.adoc[leveloffset=+1]
|
||||
|
||||
* For more information on replication controllers, see xref:../../applications/deployments/what-deployments-are.adoc#deployments-replicationcontrollers_what-deployments-are[Replication controllers].
|
||||
|
||||
* For more information on the controller manager, see xref:../../operators/operator-reference.adoc#kube-controller-manager-operator_cluster-operators-ref[Kubernetes Controller Manager Operator].
|
||||
|
||||
* For more information on the controller manager, see xref:../../operators/operator-reference.adoc#kube-controller-manager-operator_operator-reference[Kubernetes Controller Manager Operator].
|
||||
|
||||
@@ -56,7 +56,7 @@ For more general information about Flow Collector specifications and the Network
|
||||
include::modules/network-observability-updating-migrating.adoc[leveloffset=+2]
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
* xref:../../operators/operator-reference.adoc#cluster-kube-storage-version-migrator-operator_cluster-operators-ref[Kubernetes Storage Version Migrator Operator]
|
||||
* xref:../../operators/operator-reference.adoc#cluster-kube-storage-version-migrator-operator_operator-reference[Kubernetes Storage Version Migrator Operator]
|
||||
|
||||
include::modules/network-observability-kafka-option.adoc[leveloffset=+1]
|
||||
[role="_additional-resources"]
|
||||
|
||||
@@ -56,7 +56,7 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
// Not sure if the xref above should be changed in #82841 since this is the index page of the Operators section
|
||||
|
||||
For information about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference].
|
||||
For information about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#operator-reference[Cluster Operators reference].
|
||||
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
||||
|
||||
[id="operators-overview-next-steps"]
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="cluster-operators-ref"]
|
||||
[id="operator-reference"]
|
||||
= Cluster Operators reference
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: cluster-operators-ref
|
||||
:context: operator-reference
|
||||
|
||||
toc::[]
|
||||
|
||||
@@ -139,7 +139,7 @@ include::modules/cluster-openshift-controller-manager-operators.adoc[leveloffset
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The following sections pertain to {olmv0-first} that has been included with {product-title} 4 since its initial release. For {olmv1}, see xref:../operators/operator-reference.adoc#cluster-operators-ref-olmv1_cluster-operators-ref[{olmv1-first} Operators].
|
||||
The following sections pertain to {olmv0-first} that has been included with {product-title} 4 since its initial release. For {olmv1}, see xref:../operators/operator-reference.adoc#cluster-operators-ref-olmv1_operator-reference[{olmv1-first} Operators].
|
||||
====
|
||||
|
||||
[discrete]
|
||||
|
||||
Reference in New Issue
Block a user