diff --git a/_unused_topics/windows-machine-config-operator.adoc b/_unused_topics/windows-machine-config-operator.adoc index f315ccefb8..5f356407e9 100644 --- a/_unused_topics/windows-machine-config-operator.adoc +++ b/_unused_topics/windows-machine-config-operator.adoc @@ -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] diff --git a/architecture/control-plane.adoc b/architecture/control-plane.adoc index 12ded4b890..fd9c8183d3 100644 --- a/architecture/control-plane.adoc +++ b/architecture/control-plane.adoc @@ -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] diff --git a/authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc b/authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc index 741c5bc5c8..cbbe138c66 100644 --- a/authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc +++ b/authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc @@ -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] diff --git a/edge_computing/day_2_core_cnf_clusters/troubleshooting/telco-troubleshooting-mco.adoc b/edge_computing/day_2_core_cnf_clusters/troubleshooting/telco-troubleshooting-mco.adoc index 669eeb0bc3..e69c530470 100644 --- a/edge_computing/day_2_core_cnf_clusters/troubleshooting/telco-troubleshooting-mco.adoc +++ b/edge_computing/day_2_core_cnf_clusters/troubleshooting/telco-troubleshooting-mco.adoc @@ -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] \ No newline at end of file +include::modules/telco-troubleshooting-mco-apply-several-mcs.adoc[leveloffset=+1] diff --git a/extensions/ce/update-paths.adoc b/extensions/ce/update-paths.adoc index 02164122ab..f7379c311f 100644 --- a/extensions/ce/update-paths.adoc +++ b/extensions/ce/update-paths.adoc @@ -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] diff --git a/hosted_control_planes/hcp-authentication-authorization.adoc b/hosted_control_planes/hcp-authentication-authorization.adoc index 97debd82b5..5487a74048 100644 --- a/hosted_control_planes/hcp-authentication-authorization.adoc +++ b/hosted_control_planes/hcp-authentication-authorization.adoc @@ -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] diff --git a/installing/overview/cluster-capabilities.adoc b/installing/overview/cluster-capabilities.adoc index 5722fda001..56ab3998f1 100644 --- a/installing/overview/cluster-capabilities.adoc +++ b/installing/overview/cluster-capabilities.adoc @@ -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] diff --git a/machine_management/cluster_api_machine_management/cluster-api-about.adoc b/machine_management/cluster_api_machine_management/cluster-api-about.adoc index b57f0f3ac7..151c0231f7 100644 --- a/machine_management/cluster_api_machine_management/cluster-api-about.adoc +++ b/machine_management/cluster_api_machine_management/cluster-api-about.adoc @@ -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] \ No newline at end of file +include::modules/capi-arch-resources.adoc[leveloffset=+2] diff --git a/machine_management/control_plane_machine_management/cpmso-about.adoc b/machine_management/control_plane_machine_management/cpmso-about.adoc index f53f9405c8..4b75ef6d72 100644 --- a/machine_management/control_plane_machine_management/cpmso-about.adoc +++ b/machine_management/control_plane_machine_management/cpmso-about.adoc @@ -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] \ No newline at end of file +* 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] diff --git a/modules/cloud-credential-operator.adoc b/modules/cloud-credential-operator.adoc index ba0ef20e45..3798f2d0e3 100644 --- a/modules/cloud-credential-operator.adoc +++ b/modules/cloud-credential-operator.adoc @@ -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::[] \ No newline at end of file +endif::[] diff --git a/modules/cluster-authentication-operator.adoc b/modules/cluster-authentication-operator.adoc index 0056de181e..e1562de337 100644 --- a/modules/cluster-authentication-operator.adoc +++ b/modules/cluster-authentication-operator.adoc @@ -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] diff --git a/modules/cluster-autoscaler-operator.adoc b/modules/cluster-autoscaler-operator.adoc index c37e338537..3475b3fc79 100644 --- a/modules/cluster-autoscaler-operator.adoc +++ b/modules/cluster-autoscaler-operator.adoc @@ -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] diff --git a/modules/cluster-bare-metal-operator.adoc b/modules/cluster-bare-metal-operator.adoc index 43ef4bb0b4..60da638eac 100644 --- a/modules/cluster-bare-metal-operator.adoc +++ b/modules/cluster-bare-metal-operator.adoc @@ -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::[] diff --git a/modules/cluster-capi-operator.adoc b/modules/cluster-capi-operator.adoc index 4929557582..6a050d837d 100644 --- a/modules/cluster-capi-operator.adoc +++ b/modules/cluster-capi-operator.adoc @@ -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` \ No newline at end of file +** CR: `metal3machinetemplate` diff --git a/modules/cluster-cloud-controller-manager-operator.adoc b/modules/cluster-cloud-controller-manager-operator.adoc index 6d6f84bd82..04a737bff3 100644 --- a/modules/cluster-cloud-controller-manager-operator.adoc +++ b/modules/cluster-cloud-controller-manager-operator.adoc @@ -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::[] \ No newline at end of file +endif::[] diff --git a/modules/cluster-config-operator.adoc b/modules/cluster-config-operator.adoc index a2635eb7f3..3d6c06b5df 100644 --- a/modules/cluster-config-operator.adoc +++ b/modules/cluster-config-operator.adoc @@ -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. diff --git a/modules/cluster-csi-snapshot-controller-operator.adoc b/modules/cluster-csi-snapshot-controller-operator.adoc index 16469b8776..727718cd8b 100644 --- a/modules/cluster-csi-snapshot-controller-operator.adoc +++ b/modules/cluster-csi-snapshot-controller-operator.adoc @@ -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::[] \ No newline at end of file +endif::[] diff --git a/modules/cluster-dns-operator.adoc b/modules/cluster-dns-operator.adoc index fa88268d5f..f61081a1fe 100644 --- a/modules/cluster-dns-operator.adoc +++ b/modules/cluster-dns-operator.adoc @@ -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. diff --git a/modules/cluster-image-registry-operator.adoc b/modules/cluster-image-registry-operator.adoc index dff8bf10ba..9be67ef80c 100644 --- a/modules/cluster-image-registry-operator.adoc +++ b/modules/cluster-image-registry-operator.adoc @@ -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"] diff --git a/modules/cluster-kube-scheduler-operator.adoc b/modules/cluster-kube-scheduler-operator.adoc index b5e8d14bfd..56fff2e219 100644 --- a/modules/cluster-kube-scheduler-operator.adoc +++ b/modules/cluster-kube-scheduler-operator.adoc @@ -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: diff --git a/modules/cluster-kube-storage-version-migrator-operator.adoc b/modules/cluster-kube-storage-version-migrator-operator.adoc index a92f417013..ac9625659c 100644 --- a/modules/cluster-kube-storage-version-migrator-operator.adoc +++ b/modules/cluster-kube-storage-version-migrator-operator.adoc @@ -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] diff --git a/modules/cluster-machine-approver-operator.adoc b/modules/cluster-machine-approver-operator.adoc index e1a3953c68..0d534396c7 100644 --- a/modules/cluster-machine-approver-operator.adoc +++ b/modules/cluster-machine-approver-operator.adoc @@ -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] diff --git a/modules/cluster-monitoring-operator.adoc b/modules/cluster-monitoring-operator.adoc index 4d01b0a59c..f3101500cf 100644 --- a/modules/cluster-monitoring-operator.adoc +++ b/modules/cluster-monitoring-operator.adoc @@ -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] diff --git a/modules/cluster-network-operator.adoc b/modules/cluster-network-operator.adoc index e5027d4ea0..676a7db881 100644 --- a/modules/cluster-network-operator.adoc +++ b/modules/cluster-network-operator.adoc @@ -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. diff --git a/modules/cluster-openshift-controller-manager-operators.adoc b/modules/cluster-openshift-controller-manager-operators.adoc index acc14fee1b..2124569ae0 100644 --- a/modules/cluster-openshift-controller-manager-operators.adoc +++ b/modules/cluster-openshift-controller-manager-operators.adoc @@ -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] diff --git a/modules/cluster-samples-operator.adoc b/modules/cluster-samples-operator.adoc index 5156f4bd45..d012f0a52e 100644 --- a/modules/cluster-samples-operator.adoc +++ b/modules/cluster-samples-operator.adoc @@ -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::[] \ No newline at end of file +endif::[] diff --git a/modules/cluster-storage-operator.adoc b/modules/cluster-storage-operator.adoc index 83159a13fd..18c46fa052 100644 --- a/modules/cluster-storage-operator.adoc +++ b/modules/cluster-storage-operator.adoc @@ -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::[] \ No newline at end of file +endif::[] diff --git a/modules/cluster-version-operator.adoc b/modules/cluster-version-operator.adoc index c6e5eeac30..2e3114fa15 100644 --- a/modules/cluster-version-operator.adoc +++ b/modules/cluster-version-operator.adoc @@ -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". diff --git a/modules/console-operator.adoc b/modules/console-operator.adoc index fc2fa7a86e..83852a80b1 100644 --- a/modules/console-operator.adoc +++ b/modules/console-operator.adoc @@ -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"] diff --git a/modules/control-plane-machine-set-operator.adoc b/modules/control-plane-machine-set-operator.adoc index 23fe485c84..d55585fcaa 100644 --- a/modules/control-plane-machine-set-operator.adoc +++ b/modules/control-plane-machine-set-operator.adoc @@ -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 \ No newline at end of file +** Validation: Yes diff --git a/modules/etcd-operator.adoc b/modules/etcd-operator.adoc index 7c8600c604..32882175e3 100644 --- a/modules/etcd-operator.adoc +++ b/modules/etcd-operator.adoc @@ -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 diff --git a/modules/ingress-operator.adoc b/modules/ingress-operator.adoc index c8cab751a9..41683eb955 100644 --- a/modules/ingress-operator.adoc +++ b/modules/ingress-operator.adoc @@ -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::[] \ No newline at end of file +endif::[] diff --git a/modules/insights-operator.adoc b/modules/insights-operator.adoc index 23293ec980..af7fde91bc 100644 --- a/modules/insights-operator.adoc +++ b/modules/insights-operator.adoc @@ -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::[] \ No newline at end of file +endif::[] diff --git a/modules/kube-apiserver-operator.adoc b/modules/kube-apiserver-operator.adoc index a23ce6fc66..0d5233096f 100644 --- a/modules/kube-apiserver-operator.adoc +++ b/modules/kube-apiserver-operator.adoc @@ -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] diff --git a/modules/kube-controller-manager-operator.adoc b/modules/kube-controller-manager-operator.adoc index 77b71aa2d2..ac1405aac4 100644 --- a/modules/kube-controller-manager-operator.adoc +++ b/modules/kube-controller-manager-operator.adoc @@ -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: diff --git a/modules/machine-api-capability.adoc b/modules/machine-api-capability.adoc index 6ec53d36aa..f41fb95876 100644 --- a/modules/machine-api-capability.adoc +++ b/modules/machine-api-capability.adoc @@ -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. diff --git a/modules/machine-api-operator.adoc b/modules/machine-api-operator.adoc index 58679ccd0c..f0f01e7250 100644 --- a/modules/machine-api-operator.adoc +++ b/modules/machine-api-operator.adoc @@ -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] diff --git a/modules/machine-config-operator.adoc b/modules/machine-config-operator.adoc index 513112e7a6..c235af2cd2 100644 --- a/modules/machine-config-operator.adoc +++ b/modules/machine-config-operator.adoc @@ -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] - diff --git a/modules/node-tuning-operator.adoc b/modules/node-tuning-operator.adoc index 85a0db78a7..123c6d7097 100644 --- a/modules/node-tuning-operator.adoc +++ b/modules/node-tuning-operator.adoc @@ -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[] diff --git a/modules/olm-architecture.adoc b/modules/olm-architecture.adoc index 5b1bca46c4..41844100b1 100644 --- a/modules/olm-architecture.adoc +++ b/modules/olm-architecture.adoc @@ -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::[] diff --git a/modules/olm-overview.adoc b/modules/olm-overview.adoc index 189f3ab085..b1d08c277d 100644 --- a/modules/olm-overview.adoc +++ b/modules/olm-overview.adoc @@ -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::[] \ No newline at end of file +endif::[] diff --git a/modules/olmv1-clusteroperator.adoc b/modules/olmv1-clusteroperator.adoc index 35d1c516bd..a18587d12a 100644 --- a/modules/olmv1-clusteroperator.adoc +++ b/modules/olmv1-clusteroperator.adoc @@ -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::[] diff --git a/modules/openshift-apiserver-operator.adoc b/modules/openshift-apiserver-operator.adoc index 5a01af6dab..52d2a59324 100644 --- a/modules/openshift-apiserver-operator.adoc +++ b/modules/openshift-apiserver-operator.adoc @@ -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] diff --git a/modules/openshift-service-ca-operator.adoc b/modules/openshift-service-ca-operator.adoc index bc0c592415..cc86ad8eea 100644 --- a/modules/openshift-service-ca-operator.adoc +++ b/modules/openshift-service-ca-operator.adoc @@ -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] diff --git a/modules/operator-marketplace.adoc b/modules/operator-marketplace.adoc index c7f7eed27a..a698a1b842 100644 --- a/modules/operator-marketplace.adoc +++ b/modules/operator-marketplace.adoc @@ -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::[] diff --git a/modules/prometheus-operator.adoc b/modules/prometheus-operator.adoc index e4cadf6758..ef0556211f 100644 --- a/modules/prometheus-operator.adoc +++ b/modules/prometheus-operator.adoc @@ -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: diff --git a/modules/psap-node-feature-discovery-operator.adoc b/modules/psap-node-feature-discovery-operator.adoc index 76494bf635..af3e0ae4a5 100644 --- a/modules/psap-node-feature-discovery-operator.adoc +++ b/modules/psap-node-feature-discovery-operator.adoc @@ -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”. diff --git a/modules/vsphere-problem-detector-operator.adoc b/modules/vsphere-problem-detector-operator.adoc index e80c9e98e7..740f9ce9cb 100644 --- a/modules/vsphere-problem-detector-operator.adoc +++ b/modules/vsphere-problem-detector-operator.adoc @@ -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] diff --git a/nodes/edge/nodes-edge-remote-workers.adoc b/nodes/edge/nodes-edge-remote-workers.adoc index e2542a03d9..d702e1c65d 100644 --- a/nodes/edge/nodes-edge-remote-workers.adoc +++ b/nodes/edge/nodes-edge-remote-workers.adoc @@ -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]. diff --git a/observability/network_observability/installing-operators.adoc b/observability/network_observability/installing-operators.adoc index 6e06fef8f2..9a8b74459e 100644 --- a/observability/network_observability/installing-operators.adoc +++ b/observability/network_observability/installing-operators.adoc @@ -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"] diff --git a/operators/index.adoc b/operators/index.adoc index 58003a7fa6..9fc02790c5 100644 --- a/operators/index.adoc +++ b/operators/index.adoc @@ -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"] diff --git a/operators/operator-reference.adoc b/operators/operator-reference.adoc index a202f2f522..8519600a7c 100644 --- a/operators/operator-reference.adoc +++ b/operators/operator-reference.adoc @@ -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]