Merge pull request #48734 from adellape/rename_platform_operators

adellape · web-flow · commit 711041cdd0b4 · 2022-08-22T08:11:43.000-06:00
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -1566,7 +1566,7 @@ Topics:
   - Name: Migrating to Operator SDK v0.1.0
     File: osdk-migrating-to-v0-1-0
     Distros: openshift-origin
-- Name: Platform Operators reference
+- Name: Cluster Operators reference
   File: operator-reference
 ---
 Name: CI/CD
diff --git a/architecture/control-plane.adoc b/architecture/control-plane.adoc
@@ -19,11 +19,11 @@ include::modules/architecture-machine-roles.adoc[leveloffset=+1]
 include::modules/operators-overview.adoc[leveloffset=+1]
 
 ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
-include::modules/arch-platform-operators.adoc[leveloffset=+2]
+include::modules/arch-cluster-operators.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../operators/operator-reference.adoc#platform-operators-ref[Platform Operators reference]
+* xref:../operators/operator-reference.adoc#cluster-operators-ref[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
@@ -98,4 +98,4 @@ To resolve insufficient credentials issues, provide a credential with sufficient
 [id="additional-resources_about-cloud-credential-operator"]
 == Additional resources
 
-* xref:../../operators/operator-reference.adoc#cloud-credential-operator_platform-operators-ref[Platform Operators reference page for the Cloud Credential Operator]
+* xref:../../operators/operator-reference.adoc#cloud-credential-operator_cluster-operators-ref[Cluster Operators reference page for the Cloud Credential Operator]
diff --git a/cicd/gitops/installing-openshift-gitops.adoc b/cicd/gitops/installing-openshift-gitops.adoc
@@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[]
 toc::[]
 
 [role="_abstract"]
-{gitops-title} uses Argo CD to manage specific cluster-scoped resources, including platform Operators, optional Operator Lifecycle Manager (OLM) Operators, and user management.
+{gitops-title} uses Argo CD to manage specific cluster-scoped resources, including cluster Operators, optional Operator Lifecycle Manager (OLM) Operators, and user management.
 
 This guide explains how to install the {gitops-title} Operator to an {product-title} cluster and log in to the Argo CD instance.
 
diff --git a/machine_management/capi-machine-management.adoc b/machine_management/capi-machine-management.adoc
@@ -52,7 +52,7 @@ include::modules/cluster-api-architecture.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../operators/operator-reference.adoc#cluster-capi-operator_platform-operators-ref[Cluster CAPI Operator]
+* xref:../operators/operator-reference.adoc#cluster-capi-operator_cluster-operators-ref[Cluster CAPI Operator]
 
 [id="capi-sample-yaml-files"]
 == Sample YAML files
diff --git a/modules/arch-cluster-operators.adoc b/modules/arch-cluster-operators.adoc
@@ -0,0 +1,10 @@
+// Module included in the following assemblies:
+//
+// * architecture/control-plane.adoc
+
+[id="cluster-operators_{context}"]
+= Cluster Operators
+
+In {product-title}, all cluster functions are divided into a series of default _cluster Operators_. Cluster Operators manage a particular area of cluster functionality, such as cluster-wide application logging, management of the Kubernetes control plane, or the machine provisioning system.
+
+Cluster Operators are represented by a `ClusterOperator` object, which cluster administrators can view in the {product-title} web console from the *Administration* -> *Cluster Settings* page. Each cluster Operator provides a simple API for determining cluster functionality. The Operator hides the details of managing the lifecycle of that component. Operators can manage a single component or tens of components, but the end goal is always to reduce operational burden by automating common actions.
diff --git a/modules/arch-olm-operators.adoc b/modules/arch-olm-operators.adoc
@@ -15,5 +15,5 @@ Developers can use the Operator SDK to help author custom Operators that take ad
 
 [NOTE]
 ====
-OLM does not manage the platform Operators that comprise the {product-title} architecture.
+OLM does not manage the cluster Operators that comprise the {product-title} architecture.
 ====
diff --git a/modules/arch-platform-operators.adoc b/modules/arch-platform-operators.adoc
diff --git a/modules/cluster-api-architecture.adoc b/modules/cluster-api-architecture.adoc
@@ -20,7 +20,7 @@ If a cluster is configured correctly to allow the use of the Cluster API, the Cl
 The Cluster CAPI Operator is distinct from the upstream Cluster API Operator.
 ====
 
-For more information, see the entry for the Cluster CAPI Operator in the platform Operators reference content.
+For more information, see the entry for the Cluster CAPI Operator in the _Cluster Operators reference_ content.
 
 [id="capi-arch-resources"]
 == Primary resources
diff --git a/modules/gitops-in-built-permissions.adoc b/modules/gitops-in-built-permissions.adoc
@@ -5,7 +5,7 @@
 [id="in-built-permissions_{context}"]
 = In-built permissions for Argo CD
 
-This section lists the permissions that are granted to ArgoCD to manage specific cluster-scoped resources which include platform operators, optional OLM operators, and user management. Note that ArgoCD is not granted `cluster-admin` permissions.
+This section lists the permissions that are granted to ArgoCD to manage specific cluster-scoped resources which include cluster operators, optional OLM operators, and user management. Note that ArgoCD is not granted `cluster-admin` permissions.
 
 .Permissions granted to Argo CD
 |==========================
diff --git a/modules/gitops-inbuilt-permissions-for-cluster-config.adoc b/modules/gitops-inbuilt-permissions-for-cluster-config.adoc
@@ -6,7 +6,7 @@
 [id="gitops-inbuilt-permissions-for-cluster-config_{context}"]
 = In-built permissions for cluster configuration
 
-By default, the Argo CD instance has permissions to manage specific cluster-scoped resources such as platform Operators, optional OLM Operators and user management. 
+By default, the Argo CD instance has permissions to manage specific cluster-scoped resources such as cluster Operators, optional OLM Operators and user management. 
 
 [NOTE]
 ====
diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc
@@ -603,7 +603,7 @@ accounts for the dramatically decreased machine performance.
 |The Cloud Credential Operator (CCO) mode. If no mode is specified, the CCO dynamically tries to determine the capabilities of the provided credentials, with a preference for mint mode on the platforms where multiple modes are supported.
 [NOTE]
 ====
-Not all CCO modes are supported for all cloud providers. For more information on CCO modes, see the _Cloud Credential Operator_ entry in the _Platform Operators reference_ content.
+Not all CCO modes are supported for all cloud providers. For more information on CCO modes, see the _Cloud Credential Operator_ entry in the _Cluster Operators reference_ content.
 ====
 |`Mint`, `Passthrough`, `Manual`, or an empty string (`""`).
 ifndef::openshift-origin[]
diff --git a/modules/node-tuning-operator.adoc b/modules/node-tuning-operator.adoc
@@ -4,7 +4,7 @@
 // * operators/operator-reference.adoc
 // * post_installation_configuration/node-tasks.adoc
 
-ifeval::["{context}" == "platform-operators-ref"]
+ifeval::["{context}" == "cluster-operators-ref"]
 :operators:
 endif::[]
 ifeval::["{context}" == "node-tuning-operator"]
diff --git a/modules/olm-architecture.adoc b/modules/olm-architecture.adoc
@@ -4,10 +4,10 @@
 // * operators/operator-reference.adoc
 
 [id="olm-architecture_{context}"]
-ifeval::["{context}" != "platform-operators-ref"]
+ifeval::["{context}" != "cluster-operators-ref"]
 = Component responsibilities
 endif::[]
-ifeval::["{context}" == "platform-operators-ref"]
+ifeval::["{context}" == "cluster-operators-ref"]
 = CRDs
 endif::[]
 
diff --git a/modules/olm-overview.adoc b/modules/olm-overview.adoc
@@ -4,10 +4,10 @@
 // * operators/operator-reference.adoc
 
 [id="olm-overview_{context}"]
-ifeval::["{context}" != "platform-operators-ref"]
+ifeval::["{context}" != "cluster-operators-ref"]
 = What is Operator Lifecycle Manager?
 endif::[]
-ifeval::["{context}" == "platform-operators-ref"]
+ifeval::["{context}" == "cluster-operators-ref"]
 = Purpose
 endif::[]
 
diff --git a/modules/operators-overview.adoc b/modules/operators-overview.adoc
@@ -26,7 +26,7 @@ endif::[]
 
 While both follow similar Operator concepts and goals, Operators in {product-title} are managed by two different systems, depending on their purpose:
 
-* Platform Operators, which are managed by the Cluster Version Operator (CVO), are installed by default to perform cluster functions.
+* Cluster Operators, which are managed by the Cluster Version Operator (CVO), are installed by default to perform cluster functions.
 * Optional add-on Operators, which are managed by Operator Lifecycle Manager (OLM), can be made accessible for users to run in their applications.
 
 ifeval::["{context}" == "operators-overview"]
diff --git 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}" == "platform-operators-ref"]
+ifeval::["{context}" == "cluster-operators-ref"]
 :operators:
 endif::[]
 ifeval::["{context}" == "node-feature-discovery-operator"]
diff --git a/nodes/clusters/nodes-cluster-enabling-features.adoc b/nodes/clusters/nodes-cluster-enabling-features.adoc
@@ -15,7 +15,7 @@ include::modules/nodes-cluster-enabling-features-about.adoc[leveloffset=+1]
 * For more information on the features activated by the `TechPreviewNoUpgrade` feature gate, see the following topics:
 ** xref:../../storage/container_storage_interface/persistent-storage-csi-azure-file.adoc#persistent-storage-csi-azure-file[Azure File CSI Driver Operator]
 ** xref:../../storage/container_storage_interface/persistent-storage-csi-migration.adoc#persistent-storage-csi-migration[CSI automatic migration]
-** xref:../../operators/operator-reference.adoc#cluster-cloud-controller-manager-operator_platform-operators-ref[Cluster Cloud Controller Manager Operator]
+** xref:../../operators/operator-reference.adoc#cluster-cloud-controller-manager-operator_cluster-operators-ref[Cluster Cloud Controller Manager Operator]
 ** xref:../../cicd/builds/build-strategies.adoc#builds-using-build-volumes_build-strategies-s2i[Source-to-image (S2I) build volumes] and xref:../../cicd/builds/build-strategies.adoc#builds-using-build-volumes_build-strategies-docker[Docker build volumes]
 ** xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-swap-memory_nodes-nodes-working[Swap memory on nodes]
 
diff --git a/nodes/edge/nodes-edge-remote-workers.adoc b/nodes/edge/nodes-edge-remote-workers.adoc
@@ -63,4 +63,4 @@ include::modules/nodes-edge-remote-workers-strategies.adoc[leveloffset=+1]
 
 * For more information on replication controllers, see xref:../../applications/deployments/what-deployments-are.html#deployments-replicationcontrollers_what-deployments-are[Replication controllers].
 
-* For more information on the controller manager, see xref:../../operators/operator-reference.html#kube-controller-manager-operator_platform-operators-ref[Kubernetes Controller Manager Operator].
+* For more information on the controller manager, see xref:../../operators/operator-reference.adoc#kube-controller-manager-operator_cluster-operators-ref[Kubernetes Controller Manager Operator].
diff --git a/operators/index.adoc b/operators/index.adoc
@@ -38,7 +38,7 @@ As a cluster administrator, you can perform the following Operator tasks:
 ** xref:../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[Configure proxy support]
 ** xref:../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Use Operator Lifecycle Manager on restricted networks]
 
-To know all about the platform Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#platform-operators-ref[Platform Operators reference].
+To know all about the cluster Operators that Red Hat provides, see xref:../operators/operator-reference.adoc#cluster-operators-ref[Cluster Operators reference].
 
 [id="operators-overview-next-steps"]
 == Next steps
diff --git a/operators/operator-reference.adoc b/operators/operator-reference.adoc
@@ -1,18 +1,18 @@
 :_content-type: ASSEMBLY
-[id="platform-operators-ref"]
-= Platform Operators reference
+[id="cluster-operators-ref"]
+= Cluster Operators reference
 include::_attributes/common-attributes.adoc[]
-:context: platform-operators-ref
+:context: cluster-operators-ref
 
 toc::[]
 
-This reference guide indexes the _platform Operators_, also known as cluster Operators, shipped by Red Hat that serve as the architectural foundation for {product-title}. Platform Operators are installed by default, unless otherwise noted, and are managed by the Cluster Version Operator (CVO). For more details on the control plane architecture, see xref:../architecture/control-plane.adoc#operators-overview_control-plane[Operators in {product-title}].
+This reference guide indexes the _cluster Operators_ shipped by Red Hat that serve as the architectural foundation for {product-title}. Cluster Operators are installed by default, unless otherwise noted, and are managed by the Cluster Version Operator (CVO). For more details on the control plane architecture, see xref:../architecture/control-plane.adoc#operators-overview_control-plane[Operators in {product-title}].
 
-Cluster administrators can view platform Operators in the {product-title} web console from the *Administration* -> *Cluster Settings* page.
+Cluster administrators can view cluster Operators in the {product-title} web console from the *Administration* -> *Cluster Settings* page.
 
 [NOTE]
 ====
-Platform operators are not managed by Operator Lifecycle Manager (OLM) and OperatorHub. OLM and OperatorHub are part of the link:https://operatorframework.io/[Operator Framework] used in {product-title} for installing and running optional xref:../architecture/control-plane.adoc#olm-operators_control-plane[add-on Operators].
+Cluster Operators are not managed by Operator Lifecycle Manager (OLM) and OperatorHub. OLM and OperatorHub are part of the link:https://operatorframework.io/[Operator Framework] used in {product-title} for installing and running optional xref:../architecture/control-plane.adoc#olm-operators_control-plane[add-on Operators].
 ====
 
 include::modules/baremetal-event-relay.adoc[leveloffset=+1]
@@ -58,15 +58,15 @@ include::modules/node-tuning-operator.adoc[leveloffset=+1]
 
 [discrete]
 [role="_additional-resources"]
-[id="platform-operators-ref-nto-addtl-resources"]
+[id="cluster-operators-ref-nto-addtl-resources"]
 === Additional resources
 
 * xref:../scalability_and_performance/cnf-low-latency-tuning.adoc#cnf-understanding-low-latency_cnf-master[Low latency tuning of OCP nodes]
 
 include::modules/openshift-apiserver-operator.adoc[leveloffset=+1]
 include::modules/cluster-openshift-controller-manager-operators.adoc[leveloffset=+1]
 
-[id="platform-operators-ref-olm"]
+[id="cluster-operators-ref-olm"]
 == Operator Lifecycle Manager Operators
 [discrete]
 include::modules/olm-overview.adoc[leveloffset=+2]
@@ -81,7 +81,7 @@ include::modules/olm-arch-catalog-registry.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 [discrete]
-[id="platform-operators-ref-olm-addtl-resources"]
+[id="cluster-operators-ref-olm-addtl-resources"]
 === Additional resources
 
 * For more information, see the sections on xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[understanding Operator Lifecycle Manager (OLM)].
diff --git a/post_installation_configuration/cluster-tasks.adoc b/post_installation_configuration/cluster-tasks.adoc
@@ -611,7 +611,7 @@ include::modules/nodes-pods-pod-disruption-configuring.adoc[leveloffset=+2]
 
 After installing {product-title}, some organizations require the rotation or removal of the cloud provider credentials that were used during the initial installation.
 
-To allow the cluster to use the new credentials, you must update the secrets that the xref:../operators/operator-reference.adoc#cloud-credential-operator_platform-operators-ref[Cloud Credential Operator (CCO)] uses to manage cloud provider credentials.
+To allow the cluster to use the new credentials, you must update the secrets that the xref:../operators/operator-reference.adoc#cloud-credential-operator_cluster-operators-ref[Cloud Credential Operator (CCO)] uses to manage cloud provider credentials.
 
 [id="ccoctl-rotate-remove-cloud-creds"]
 === Rotating cloud provider credentials with the Cloud Credential Operator utility
