diff --git a/modules/cloud-credential-operator.adoc b/modules/cloud-credential-operator.adoc index 2e87654d42d..0bc0c4db30f 100644 --- a/modules/cloud-credential-operator.adoc +++ b/modules/cloud-credential-operator.adoc @@ -12,8 +12,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="cloud-credential-operator_{context}"] -ifdef::operators[= Cloud Credential Operator] -ifdef::cluster-caps[= Cloud credential capability] += Cloud Credential Operator [role="_abstract"] ifdef::cluster-caps[] @@ -30,10 +29,6 @@ The Cloud Credential Operator (CCO) manages cloud provider credentials as Kubern By setting different values for the `credentialsMode` parameter in the `install-config.yaml` file, the CCO can be configured to operate in several different modes. If no mode is specified, or the `credentialsMode` parameter is set to an empty string (`""`), the CCO operates in its default mode. ifdef::operators[] -Project:: - -See "openshift-cloud-credential-operator" in the _Additional resources_ section. - CRDs:: * `credentialsrequests.cloudcredential.openshift.io` diff --git a/modules/cluster-authentication-operator.adoc b/modules/cluster-authentication-operator.adoc index 9bd03b3032f..e198e05027c 100644 --- a/modules/cluster-authentication-operator.adoc +++ b/modules/cluster-authentication-operator.adoc @@ -6,14 +6,10 @@ [id="cluster-authentication-operator_{context}"] = Cluster Authentication Operator -The Cluster Authentication Operator installs and maintains the `Authentication` custom resource in a cluster and can be viewed with: +[role="_abstract"] +The Cluster Authentication Operator installs and maintains the `Authentication` custom resource in a cluster. [source,terminal] ---- $ oc get clusteroperator authentication -o yaml ---- - - -== Project - -link:https://github.com/openshift/cluster-authentication-operator[cluster-authentication-operator] diff --git a/modules/cluster-autoscaler-operator.adoc b/modules/cluster-autoscaler-operator.adoc index 411facbd37a..2da9b1ce5da 100644 --- a/modules/cluster-autoscaler-operator.adoc +++ b/modules/cluster-autoscaler-operator.adoc @@ -6,14 +6,9 @@ [id="cluster-autoscaler-operator_{context}"] = Cluster Autoscaler Operator +[role="_abstract"] The Cluster Autoscaler Operator manages deployments of the OpenShift Cluster Autoscaler using the `cluster-api` provider. - -== Project - -link:https://github.com/openshift/cluster-autoscaler-operator[cluster-autoscaler-operator] - - == CRDs * `ClusterAutoscaler`: This is a singleton resource, which controls the configuration autoscaler instance for the cluster. The Operator only responds to the `ClusterAutoscaler` resource named `default` in the managed namespace, the value of the `WATCH_NAMESPACE` environment variable. diff --git a/modules/cluster-bare-metal-operator.adoc b/modules/cluster-bare-metal-operator.adoc index 683739b519f..d1e781d8fe8 100644 --- a/modules/cluster-bare-metal-operator.adoc +++ b/modules/cluster-bare-metal-operator.adoc @@ -13,8 +13,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="cluster-bare-metal-operator_{context}"] -ifdef::operator-ref[= Cluster Baremetal Operator] -ifdef::cluster-caps[= Bare-metal capability] += Cluster Baremetal Operator [role="_abstract"] ifdef::operator-ref[] @@ -42,12 +41,6 @@ Red{nbsp}Hat recommends that cluster administrators only disable the bare-metal ==== endif::cluster-caps[] -ifdef::operator-ref[] -Project:: - -link:https://github.com/openshift/cluster-baremetal-operator[cluster-baremetal-operator] -endif::operator-ref[] - ifeval::["{context}" == "operator-reference"] :!operator-ref: endif::[] diff --git a/modules/cluster-capi-operator.adoc b/modules/cluster-capi-operator.adoc index d4c2975e1db..6a94b1077a5 100644 --- a/modules/cluster-capi-operator.adoc +++ b/modules/cluster-capi-operator.adoc @@ -6,6 +6,7 @@ [id="cluster-capi-operator_{context}"] = {cluster-capi-operator} +[role="_abstract"] 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] @@ -13,12 +14,6 @@ The {cluster-capi-operator} maintains the lifecycle of Cluster API resources. Th 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. ==== - -== Project - -link:https://github.com/openshift/cluster-capi-operator[cluster-capi-operator] - - == CRDs * `awsmachines.infrastructure.cluster.x-k8s.io` diff --git a/modules/cluster-cloud-controller-manager-operator.adoc b/modules/cluster-cloud-controller-manager-operator.adoc index b41138d6c65..a498783aadb 100644 --- a/modules/cluster-cloud-controller-manager-operator.adoc +++ b/modules/cluster-cloud-controller-manager-operator.adoc @@ -11,8 +11,7 @@ endif::[] :_mod-docs-content-type: CONCEPT [id="cluster-cloud-controller-manager-operator_{context}"] -ifdef::operators[= Cloud Controller Manager Operator] -ifdef::cluster-caps[= Cloud controller manager capability] += Cloud Controller Manager Operator [role="_abstract"] ifdef::cluster-caps[] @@ -54,13 +53,6 @@ The Cloud Controller Manager Operator includes the following components: By default, the Operator exposes Prometheus metrics through the `metrics` service. -ifdef::operators[] - -Project:: - -See "cluster-cloud-controller-manager-operator" in the _Additional resources_ section. -endif::operators[] - ifeval::["{context}" == "operator-reference"] :!operators: endif::[] diff --git a/modules/cluster-config-operator.adoc b/modules/cluster-config-operator.adoc index 7a8d51d712a..7e38e3fd0b9 100644 --- a/modules/cluster-config-operator.adoc +++ b/modules/cluster-config-operator.adoc @@ -6,14 +6,5 @@ [id="cluster-config-operator_{context}"] = Cluster Config Operator -The Cluster Config Operator performs the following tasks related to `config.openshift.io`: - -* Creates CRDs. -* Renders the initial custom resources. -* Handles migrations. - - - -== Project - -link:https://github.com/openshift/cluster-config-operator[cluster-config-operator] +[role="_abstract"] +The Cluster Config Operator creates custom resource definitions (CRDs), renders initial custom resources (CRs), and handles migrations for the `config.openshift.io` API group. diff --git a/modules/cluster-csi-snapshot-controller-operator.adoc b/modules/cluster-csi-snapshot-controller-operator.adoc index 721a80bf7b5..2ade381d855 100644 --- a/modules/cluster-csi-snapshot-controller-operator.adoc +++ b/modules/cluster-csi-snapshot-controller-operator.adoc @@ -13,8 +13,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="cluster-csi-snapshot-controller-operator_{context}"] -ifdef::operator-ref[= Cluster CSI Snapshot Controller Operator] -ifdef::cluster-caps[= CSI snapshot controller capability] += Cluster CSI Snapshot Controller Operator [role="_abstract"] ifdef::operator-ref[] @@ -27,12 +26,6 @@ endif::cluster-caps[] The Cluster CSI Snapshot Controller Operator installs and maintains the CSI Snapshot Controller. The CSI Snapshot Controller is responsible for watching the `VolumeSnapshot` CRD objects and manages the creation and deletion lifecycle of volume snapshots. -ifdef::operator-ref[] -Project:: -+ -`cluster-csi-snapshot-controller-operator` -endif::operator-ref[] - ifeval::["{context}" == "operator-reference"] :!operator-ref: endif::[] diff --git a/modules/cluster-dns-operator.adoc b/modules/cluster-dns-operator.adoc index 92aeee5d797..a0bf0eb9a84 100644 --- a/modules/cluster-dns-operator.adoc +++ b/modules/cluster-dns-operator.adoc @@ -6,6 +6,7 @@ [id="dns-operator_{context}"] = DNS Operator +[role="_abstract"] 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. @@ -14,8 +15,3 @@ The Operator creates a working default deployment based on the cluster's configu * Configuration of the CoreDNS Corefile or Kubernetes plugin is not yet supported. The DNS Operator manages CoreDNS as a Kubernetes daemon set exposed as a service with a static IP. CoreDNS runs on all nodes in the cluster. - - -== Project - -link:https://github.com/openshift/cluster-dns-operator[cluster-dns-operator] diff --git a/modules/cluster-image-registry-operator.adoc b/modules/cluster-image-registry-operator.adoc index d7e43248263..4b6de022870 100644 --- a/modules/cluster-image-registry-operator.adoc +++ b/modules/cluster-image-registry-operator.adoc @@ -15,8 +15,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="cluster-image-registry-operator_{context}"] -ifdef::operator-ref[= Cluster Image Registry Operator] -ifdef::cluster-caps[= Cluster Image Registry capability] += Cluster Image Registry Operator [role="_abstract"] ifdef::cluster-caps[] @@ -42,10 +41,6 @@ If you disable the `ImageRegistry` capability or if you disable the integrated { If you disable the `ImageRegistry` capability, you can reduce the overall resource footprint of {product-title} in Telco environments. Depending on your deployment, you can disable this component if you do not need it. endif::[] -Project:: -+ -See "cluster-image-registry-operator". - ifeval::["{context}" == "operator-reference"] :!operator-ref: endif::[] diff --git a/modules/cluster-kube-scheduler-operator.adoc b/modules/cluster-kube-scheduler-operator.adoc index 5e7bfa371bf..05ae2d26686 100644 --- a/modules/cluster-kube-scheduler-operator.adoc +++ b/modules/cluster-kube-scheduler-operator.adoc @@ -6,6 +6,7 @@ [id="cluster-kube-scheduler-operator_{context}"] = Kubernetes Scheduler Operator +[role="_abstract"] 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: @@ -17,12 +18,6 @@ The Kubernetes Scheduler Operator contains the following components: By default, the Operator exposes Prometheus metrics through the metrics service. - -== Project - -link:https://github.com/openshift/cluster-kube-scheduler-operator[cluster-kube-scheduler-operator] - - == Configuration The configuration for the Kubernetes Scheduler is the result of merging: diff --git a/modules/cluster-kube-storage-version-migrator-operator.adoc b/modules/cluster-kube-storage-version-migrator-operator.adoc index 1b42f13f3e6..6d677f42bb0 100644 --- a/modules/cluster-kube-storage-version-migrator-operator.adoc +++ b/modules/cluster-kube-storage-version-migrator-operator.adoc @@ -6,9 +6,5 @@ [id="cluster-kube-storage-version-migrator-operator_{context}"] = Kubernetes Storage Version Migrator Operator +[role="_abstract"] 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. - - -== Project - -link:https://github.com/openshift/cluster-kube-storage-version-migrator-operator[cluster-kube-storage-version-migrator-operator] diff --git a/modules/cluster-machine-approver-operator.adoc b/modules/cluster-machine-approver-operator.adoc index bd24d379ab3..4e062c0b151 100644 --- a/modules/cluster-machine-approver-operator.adoc +++ b/modules/cluster-machine-approver-operator.adoc @@ -6,14 +6,10 @@ [id="cluster-machine-approver-operator_{context}"] = Cluster Machine Approver Operator +[role="_abstract"] The Cluster Machine Approver Operator automatically approves the CSRs requested for a new worker node after cluster installation. [NOTE] ==== For the control plane node, the `approve-csr` service on the bootstrap node automatically approves all CSRs during the cluster bootstrapping phase. ==== - - -== Project - -link:https://github.com/openshift/cluster-machine-approver[cluster-machine-approver-operator] diff --git a/modules/cluster-monitoring-operator.adoc b/modules/cluster-monitoring-operator.adoc index f5c00bea0f9..b2f8440c4b2 100644 --- a/modules/cluster-monitoring-operator.adoc +++ b/modules/cluster-monitoring-operator.adoc @@ -6,15 +6,10 @@ [id="cluster-monitoring-operator_{context}"] = {cmo-full} +[role="_abstract"] The {cmo-first} manages and updates the Prometheus-based cluster monitoring stack deployed on top of {product-title}. -[discrete] -== Project - -link:https://github.com/openshift/cluster-monitoring-operator[openshift-monitoring] - -[discrete] -== CRDs +CRDs:: * `alertmanagers.monitoring.coreos.com` ** Scope: Namespaced @@ -33,8 +28,7 @@ link:https://github.com/openshift/cluster-monitoring-operator[openshift-monitori ** CR: `servicemonitor` ** Validation: Yes -[discrete] -== Configuration objects +Configuration objects:: [source,terminal] ---- diff --git a/modules/cluster-network-operator.adoc b/modules/cluster-network-operator.adoc index de304d86dac..56d242c7120 100644 --- a/modules/cluster-network-operator.adoc +++ b/modules/cluster-network-operator.adoc @@ -6,4 +6,5 @@ [id="cluster-network-operator_{context}"] = Cluster Network Operator +[role="_abstract"] 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 1d2458ee43c..bec968e40b8 100644 --- a/modules/cluster-openshift-controller-manager-operators.adoc +++ b/modules/cluster-openshift-controller-manager-operators.adoc @@ -6,7 +6,8 @@ [id="cluster-openshift-controller-manager-operator_{context}"] = OpenShift Controller Manager Operator -The OpenShift Controller Manager Operator installs and maintains the `OpenShiftControllerManager` custom resource in a cluster and can be viewed with: +[role="_abstract"] +The OpenShift Controller Manager Operator installs and maintains the `OpenShiftControllerManager` custom resource in a cluster. [source,terminal] ---- @@ -19,8 +20,3 @@ The custom resource definition (CRD) `openshiftcontrollermanagers.operator.opens ---- $ oc get crd openshiftcontrollermanagers.operator.openshift.io -o yaml ---- - - -== Project - -link:https://github.com/openshift/cluster-openshift-controller-manager-operator[cluster-openshift-controller-manager-operator] diff --git a/modules/cluster-operators-ref-olm-intro.adoc b/modules/cluster-operators-ref-olm-intro.adoc new file mode 100644 index 00000000000..d1eed2213b1 --- /dev/null +++ b/modules/cluster-operators-ref-olm-intro.adoc @@ -0,0 +1,10 @@ +// Module included in the following assemblies: +// +// * operators/operator-reference.adoc + +:_mod-docs-content-type: CONCEPT +[id="cluster-operators-ref-olm_{context}"] += {olmv0-first} Operators + +[role="_abstract"] +{olmv0-first} has been included with {product-title} 4 since its initial release and manages the lifecycle of cluster Operators and add-on Operators. diff --git a/modules/cluster-operators-ref-olm-list.adoc b/modules/cluster-operators-ref-olm-list.adoc new file mode 100644 index 00000000000..b5f1a278647 --- /dev/null +++ b/modules/cluster-operators-ref-olm-list.adoc @@ -0,0 +1,14 @@ +// Module included in the following assemblies: +// +// * operators/operator-reference.adoc + +:_mod-docs-content-type: REFERENCE +[id="cluster-operators-ref-olm-list_{context}"] += Cluster Operators + +[role="_abstract"] +{olmv0-first} functionality in {product-title} is provided by a set of cluster Operators. + +`operator-lifecycle-manager`:: Provides the OLM Operator. Also informs cluster administrators if there are any installed Operators blocking cluster upgrade, based on their `olm.maxOpenShiftVersion` properties. For more information, see "Controlling Operator compatibility with {product-title} versions". +`operator-lifecycle-manager-catalog`:: Provides the Catalog Operator. +`operator-lifecycle-manager-packageserver`:: Represents an API extension server responsible for collecting metadata from all catalogs on the cluster and serves the user-facing `PackageManifest` API. diff --git a/modules/cluster-samples-operator.adoc b/modules/cluster-samples-operator.adoc index 7a73c6dce76..51750c13474 100644 --- a/modules/cluster-samples-operator.adoc +++ b/modules/cluster-samples-operator.adoc @@ -15,8 +15,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="cluster-samples-operator_{context}"] -ifdef::operator-ref[= Cluster Samples Operator] -ifdef::cluster-caps[= OpenShift samples capability] += Cluster Samples Operator [role="_abstract"] ifdef::operator-ref[] @@ -54,10 +53,6 @@ The samples resource includes a finalizer, which cleans up the following upon it * Cluster status resources Upon deletion of the samples resource, the Cluster Samples Operator recreates the resource using the default configuration. - -Project:: -+ -`cluster-samples-operator` endif::operator-ref[] ifeval::["{context}" == "operator-reference"] diff --git a/modules/cluster-storage-operator.adoc b/modules/cluster-storage-operator.adoc index 07a436937b3..3499db1fc18 100644 --- a/modules/cluster-storage-operator.adoc +++ b/modules/cluster-storage-operator.adoc @@ -13,8 +13,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="cluster-storage-operator_{context}"] -ifdef::operator-ref[= Cluster Storage Operator] -ifdef::cluster-caps[= Cluster storage capability] += Cluster Storage Operator [role="_abstract"] ifdef::operator-ref[] @@ -37,10 +36,6 @@ endif::cluster-caps[] ifdef::operator-ref[] -Project:: -+ -See "cluster-storage-operator". - Configuration:: + No configuration is required. @@ -49,7 +44,7 @@ endif::operator-ref[] Notes:: + -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. +The storage class that the Operator creates can be made non-default by editing its annotation, but this storage class cannot be deleted if the Operator runs. ifeval::["{context}" == "operator-reference"] :!operator-ref: diff --git a/modules/cluster-version-operator.adoc b/modules/cluster-version-operator.adoc index 8c9b0ee4185..fadf24c7ceb 100644 --- a/modules/cluster-version-operator.adoc +++ b/modules/cluster-version-operator.adoc @@ -6,13 +6,9 @@ [id="cluster-version-operator_{context}"] = Cluster Version Operator +[role="_abstract"] 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. For more information regarding cluster version condition types, see "Understanding cluster version condition types". - - -== Project - -link:https://github.com/openshift/cluster-version-operator[cluster-version-operator] diff --git a/modules/console-operator.adoc b/modules/console-operator.adoc index 1610599f5df..3eef1c96df9 100644 --- a/modules/console-operator.adoc +++ b/modules/console-operator.adoc @@ -14,8 +14,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="console-operator_{context}"] -ifdef::operator-ref[= Console Operator] -ifdef::cluster-caps[= Console capability] += Console Operator [role="_abstract"] ifdef::operator-ref[] @@ -30,14 +29,6 @@ endif::cluster-caps[] The Console Operator installs and maintains the {product-title} web console on a cluster. The Console Operator is installed by default and automatically maintains a console. -ifdef::operator-ref[] - -Project:: -+ -See "console-operator". - -endif::operator-ref[] - ifeval::["{context}" == "operator-reference"] :!operator-ref: endif::[] diff --git a/modules/control-plane-machine-set-operator.adoc b/modules/control-plane-machine-set-operator.adoc index f060f5265d3..aa245c32c6b 100644 --- a/modules/control-plane-machine-set-operator.adoc +++ b/modules/control-plane-machine-set-operator.adoc @@ -6,6 +6,7 @@ [id="control-plane-machine-set-operator_{context}"] = Control Plane Machine Set Operator +[role="_abstract"] The Control Plane Machine Set Operator automates the management of control plane machine resources within an {product-title} cluster. [NOTE] @@ -13,12 +14,6 @@ The Control Plane Machine Set Operator automates the management of control plane This Operator is available for Amazon Web Services (AWS), {gcp-first}, Microsoft Azure, Nutanix, and VMware vSphere. ==== - -== Project - -link:https://github.com/openshift/cluster-control-plane-machine-set-operator[cluster-control-plane-machine-set-operator] - - == CRDs * `controlplanemachineset.machine.openshift.io` diff --git a/modules/etcd-operator.adoc b/modules/etcd-operator.adoc index 020eb825e23..1829a83d32c 100644 --- a/modules/etcd-operator.adoc +++ b/modules/etcd-operator.adoc @@ -6,13 +6,9 @@ [id="etcd-cluster-operator_{context}"] = etcd cluster Operator +[role="_abstract"] The etcd cluster Operator automates etcd cluster scaling, enables etcd monitoring and metrics, and simplifies disaster recovery procedures. -== Project - -link:https://github.com/openshift/cluster-etcd-operator/[cluster-etcd-operator] - - == CRDs * `etcds.operator.openshift.io` @@ -20,7 +16,6 @@ link:https://github.com/openshift/cluster-etcd-operator/[cluster-etcd-operator] ** CR: `etcd` ** Validation: Yes - == Configuration objects [source,terminal] diff --git a/modules/ingress-operator.adoc b/modules/ingress-operator.adoc index b6b32bce902..7b2df6a87a2 100644 --- a/modules/ingress-operator.adoc +++ b/modules/ingress-operator.adoc @@ -13,8 +13,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="ingress-operator_{context}"] -ifdef::operator-ref[= Ingress Operator] -ifdef::cluster-caps[= Ingress Capability] += Ingress Operator [role="_abstract"] ifdef::cluster-caps[] @@ -24,10 +23,6 @@ The Ingress Operator provides the features for the `Ingress` capability. endif::cluster-caps[] The Ingress Operator configures and manages the {product-title} router. -Project:: -+ -`openshift-ingress-operator` - CRDs:: + * `clusteringresses.ingress.openshift.io` diff --git a/modules/insights-operator.adoc b/modules/insights-operator.adoc index 6406c5b54a1..e199c346d1e 100644 --- a/modules/insights-operator.adoc +++ b/modules/insights-operator.adoc @@ -13,8 +13,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="insights-operator_{context}"] -ifdef::operator-ref[= Insights Operator] -ifdef::cluster-caps[= Insights capability] += Insights Operator [role="_abstract"] ifdef::operator-ref[] @@ -28,10 +27,6 @@ endif::cluster-caps[] The {insights-operator} gathers {product-title} configuration data and sends it to Red{nbsp}Hat. The data is used to produce proactive insights recommendations about potential issues that a cluster might be exposed to. These insights are communicated to cluster administrators through the {red-hat-lightspeed} advisor service on link:https://console.redhat.com/[console.redhat.com]. ifdef::operator-ref[] -Project:: -+ -`insights-operator` - Configuration:: + No configuration is required. diff --git a/modules/kube-apiserver-operator.adoc b/modules/kube-apiserver-operator.adoc index 057962c6de0..4875a59005f 100644 --- a/modules/kube-apiserver-operator.adoc +++ b/modules/kube-apiserver-operator.adoc @@ -6,14 +6,9 @@ [id="kube-apiserver-operator_{context}"] = Kubernetes API Server Operator +[role="_abstract"] 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). - -== Project - -link:https://github.com/openshift/cluster-kube-apiserver-operator[openshift-kube-apiserver-operator] - - == CRDs * `kubeapiservers.operator.openshift.io` @@ -21,7 +16,6 @@ link:https://github.com/openshift/cluster-kube-apiserver-operator[openshift-kube ** CR: `kubeapiserver` ** Validation: Yes - == Configuration objects [source,terminal] diff --git a/modules/kube-controller-manager-operator.adoc b/modules/kube-controller-manager-operator.adoc index 985e57c1073..b06eb3778dc 100644 --- a/modules/kube-controller-manager-operator.adoc +++ b/modules/kube-controller-manager-operator.adoc @@ -6,6 +6,7 @@ [id="kube-controller-manager-operator_{context}"] = Kubernetes Controller Manager Operator +[role="_abstract"] 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: @@ -15,9 +16,4 @@ It contains the following components: * Installer based on static pods * Configuration observer -By default, the Operator exposes Prometheus metrics through the `metrics` service. - - -== Project - -link:https://github.com/openshift/cluster-kube-controller-manager-operator[cluster-kube-controller-manager-operator] +By default, the Operator exposes Prometheus metrics through the `metrics` service. \ No newline at end of file diff --git a/modules/machine-api-operator.adoc b/modules/machine-api-operator.adoc index 84d59a33ad7..b247a53ae1f 100644 --- a/modules/machine-api-operator.adoc +++ b/modules/machine-api-operator.adoc @@ -6,13 +6,8 @@ [id="machine-api-operator_{context}"] = Machine API Operator -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. - - -== Project - -link:https://github.com/openshift/machine-api-operator[machine-api-operator] - +[role="_abstract"] +The Machine API Operator manages the lifecycle of specific purpose custom resource definitions (CRD), controllers, and role based access control (RBAC) objects that extend the Kubernetes API and declare the desired state of machines in a cluster. == CRDs diff --git a/modules/machine-config-operator.adoc b/modules/machine-config-operator.adoc index 671697e9550..2ae4d012859 100644 --- a/modules/machine-config-operator.adoc +++ b/modules/machine-config-operator.adoc @@ -6,6 +6,7 @@ [id="machine-config-operator_{context}"] = Machine Config Operator +[role="_abstract"] 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: @@ -16,8 +17,3 @@ There are four components: * `machine-config`: Provides a complete source of machine configuration at installation, first start up, and updates for a machine. 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 89f3ac90b5f..01cc4c8d353 100644 --- a/modules/node-tuning-operator.adoc +++ b/modules/node-tuning-operator.adoc @@ -17,15 +17,8 @@ endif::[] :_mod-docs-content-type: CONCEPT [id="about-node-tuning-operator_{context}"] -ifdef::operators[] = Node Tuning Operator -endif::operators[] -ifdef::perf[] -= About the Node Tuning Operator - -endif::perf[] -ifdef::cluster-caps[= Node Tuning capability] [role="_abstract"] ifdef::cluster-caps[] The Node Tuning Operator provides features for the `NodeTuning` capability. @@ -56,10 +49,4 @@ The Node Tuning Operator is part of a standard {product-title} installation in v ==== In earlier versions of {product-title}, the Performance Addon Operator was used to implement automatic tuning to achieve low latency performance for OpenShift applications. In {product-title} 4.11 and later, this functionality is part of the Node Tuning Operator. ==== -endif::cluster-caps[] - -ifdef::operators[] -Project:: -+ -`cluster-node-tuning-operator` -endif::operators[] +endif::cluster-caps[] \ No newline at end of file diff --git a/modules/olm-architecture.adoc b/modules/olm-architecture.adoc index 4dd39b5d788..10ee11025fe 100644 --- a/modules/olm-architecture.adoc +++ b/modules/olm-architecture.adoc @@ -5,15 +5,8 @@ :_mod-docs-content-type: REFERENCE [id="olm-architecture_{context}"] -ifeval::["{context}" != "operator-reference"] -= Component responsibilities - -endif::[] -ifeval::["{context}" == "operator-reference"] = CRDs -endif::[] - [role="_abstract"] Operator Lifecycle Manager (OLM) and the Catalog Operator manage the following custom resource definitions (CRDs) that form the basis of the Operator Framework. diff --git a/modules/olm-overview.adoc b/modules/olm-overview.adoc index e1f7f8d71a4..e6b418b4766 100644 --- a/modules/olm-overview.adoc +++ b/modules/olm-overview.adoc @@ -13,16 +13,7 @@ endif::[] :_mod-docs-content-type: CONCEPT [id="olm-overview_{context}"] -ifndef::operators[] -ifndef::cluster-caps[] -= What is {olmv0-first}? - -endif::[] -endif::[] -ifdef::cluster-caps[] -= {olmv0-first} capability - -endif::[] += About {olmv0-first} [role="_abstract"] ifdef::cluster-caps[] diff --git a/modules/olmv1-clusteroperator.adoc b/modules/olmv1-clusteroperator.adoc index f81e61fbce9..baef6c65199 100644 --- a/modules/olmv1-clusteroperator.adoc +++ b/modules/olmv1-clusteroperator.adoc @@ -13,15 +13,8 @@ endif::[] :_mod-docs-content-type: CONCEPT [id="cluster-operators-ref-olmv1_{context}"] -ifdef::operators[] = {olmv1-first} Operator -endif::[] -ifdef::cluster-caps[] -= {olmv1-first} capability - -endif::[] - [role="_abstract"] ifdef::cluster-caps[] {olmv1} provides the features for the `OperatorLifecycleManagerV1` capability. diff --git a/modules/openshift-apiserver-operator.adoc b/modules/openshift-apiserver-operator.adoc index c45301277a4..38511818841 100644 --- a/modules/openshift-apiserver-operator.adoc +++ b/modules/openshift-apiserver-operator.adoc @@ -6,14 +6,9 @@ [id="openshift-apiserver-operator_{context}"] = OpenShift API Server Operator +[role="_abstract"] The OpenShift API Server Operator installs and maintains the `openshift-apiserver` on a cluster. - -== Project - -link:https://github.com/openshift/cluster-openshift-apiserver-operator[openshift-apiserver-operator] - - == CRDs * `openshiftapiservers.operator.openshift.io` diff --git a/modules/openshift-service-ca-operator.adoc b/modules/openshift-service-ca-operator.adoc index 2b50573a3c3..c5d6d4acc12 100644 --- a/modules/openshift-service-ca-operator.adoc +++ b/modules/openshift-service-ca-operator.adoc @@ -6,9 +6,5 @@ [id="openshift-service-ca-operator_{context}"] = OpenShift Service CA Operator +[role="_abstract"] The OpenShift Service CA Operator mints and manages serving certificates for Kubernetes services. - - -== Project - -link:https://github.com/openshift/service-ca-operator[openshift-service-ca-operator] diff --git a/modules/operator-marketplace.adoc b/modules/operator-marketplace.adoc index 4e8a84e9165..5d82c341b74 100644 --- a/modules/operator-marketplace.adoc +++ b/modules/operator-marketplace.adoc @@ -15,8 +15,7 @@ endif::[] :_mod-docs-content-type: REFERENCE [id="marketplace-operator_{context}"] -ifdef::operator-ref[= Marketplace Operator] -ifdef::cluster-caps[= Marketplace capability] += Marketplace Operator [role="_abstract"] ifdef::operator-ref[] @@ -35,12 +34,6 @@ If you disable the `marketplace` capability, the Marketplace Operator does not c If you enable the `marketplace` capability, you can enable and disable individual catalogs by configuring the Marketplace Operator. endif::cluster-caps[] -ifdef::operator-ref[] -Project:: -+ -`operator-marketplace` -endif::operator-ref[] - ifeval::["{context}" == "operator-reference"] :!operator-ref: endif::[] diff --git a/modules/vsphere-problem-detector-operator.adoc b/modules/vsphere-problem-detector-operator.adoc index 6579ca0bd77..5e9eb520210 100644 --- a/modules/vsphere-problem-detector-operator.adoc +++ b/modules/vsphere-problem-detector-operator.adoc @@ -4,9 +4,11 @@ :operator-name: vSphere Problem Detector Operator +:_mod-docs-content-type: REFERENCE [id="vsphere-problem-detector-operator_{context}"] = {operator-name} +[role="_abstract"] 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/operators/operator-reference.adoc b/operators/operator-reference.adoc index 8ba11cb072d..994977f771b 100644 --- a/operators/operator-reference.adoc +++ b/operators/operator-reference.adoc @@ -6,54 +6,95 @@ include::_attributes/common-attributes.adoc[] toc::[] -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}]. +[role="_abstract"] +Cluster Operators are the architectural foundation for {product-title} and are installed and managed by default by the Cluster Version Operator (CVO). Cluster administrators can view cluster Operators in the {product-title} web console from the *Administration* -> *Cluster Settings* page. [NOTE] ==== -Cluster Operators are not managed by Operator Lifecycle Manager (OLM) and the software catalog. OLM and the software catalog 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 the software catalog. OLM and the software catalog are part of the Operator Framework used in {product-title} for installing and running optional add-on Operators. ==== -Some of the following cluster Operators can be disabled prior to installation. For more information see xref:../installing/overview/cluster-capabilities.adoc#cluster-capabilities[cluster capabilities]. +Some of the following cluster Operators can be disabled before installation. For more information see cluster capabilities. + +[role="_additional-resources"] +.Additional resources +* xref:../architecture/control-plane.adoc#operators-overview_control-plane[Operators in {product-title}] +* link:https://operatorframework.io/[Operator Framework] +* xref:../architecture/control-plane.adoc#olm-operators_control-plane[add-on Operators] +* xref:../installing/overview/cluster-capabilities.adoc#cluster-capabilities[cluster capabilities] include::modules/cluster-bare-metal-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../installing/overview/cluster-capabilities.adoc#cluster-bare-metal-operator_cluster-capabilities[Bare-metal capability] +* link:https://github.com/openshift/cluster-baremetal-operator[cluster-baremetal-operator] include::modules/cloud-credential-operator.adoc[leveloffset=+1] [role="_additional-resources"] - -[id="additional-resources_cluster-op-ref-cco"] -=== Additional resources +.Additional resources * xref:../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[About the Cloud Credential Operator] * xref:../rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest` custom resource] +* link:https://github.com/openshift/cloud-credential-operator[openshift-cloud-credential-operator] include::modules/cluster-authentication-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-authentication-operator[`cluster-authentication-operator`] + include::modules/cluster-autoscaler-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-autoscaler-operator[cluster-autoscaler-operator] + include::modules/cluster-cloud-controller-manager-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-cloud-controller-manager-operator[cluster-cloud-controller-manager-operator] + include::modules/cluster-capi-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-capi-operator[cluster-capi-operator] + include::modules/cluster-config-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-config-operator[cluster-config-operator] + include::modules/cluster-csi-snapshot-controller-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../installing/overview/cluster-capabilities.adoc#cluster-csi-snapshot-controller-operator_cluster-capabilities[CSI snapshot controller capability] +* link:https://github.com/openshift/cluster-csi-snapshot-controller-operator[cluster-csi-snapshot-controller-operator] include::modules/cluster-image-registry-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-image-registry-operator[cluster-image-registry-operator] + include::modules/cluster-machine-approver-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-machine-approver[cluster-machine-approver-operator] + include::modules/cluster-monitoring-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-monitoring-operator[openshift-monitoring] + include::modules/cluster-network-operator.adoc[leveloffset=+1] include::modules/cluster-samples-operator.adoc[leveloffset=+1] @@ -62,86 +103,127 @@ include::modules/cluster-samples-operator.adoc[leveloffset=+1] .Additional resources * xref:../installing/overview/cluster-capabilities.adoc#cluster-samples-operator_cluster-capabilities[OpenShift samples capability] +* link:https://github.com/openshift/cluster-samples-operator[cluster-samples-operator] include::modules/cluster-storage-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../installing/overview/cluster-capabilities.adoc#cluster-storage-operator_cluster-capabilities[Storage capability] +* link:https://github.com/openshift/cluster-storage-operator[cluster-storage-operator] include::modules/cluster-version-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../updating/understanding_updates/intro-to-updates.adoc#understanding-clusterversion-conditiontypes_understanding-openshift-updates[Understanding cluster version condition types] +* link:https://github.com/openshift/cluster-version-operator[cluster-version-operator] include::modules/console-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../installing/overview/cluster-capabilities.adoc#console-operator_cluster-capabilities[Web console capability] +* link:https://github.com/openshift/console-operator[console-operator] include::modules/control-plane-machine-set-operator.adoc[leveloffset=+1] [role="_additional-resources"] - -[id="additional-resources_cluster-op-ref-cpmso"] -=== Additional resources - +.Additional resources * xref:../machine_management/control_plane_machine_management/cpmso-about.adoc#cpmso-about[About control plane machine sets] * xref:../rest_api/machine_apis/controlplanemachineset-machine-openshift-io-v1.adoc#controlplanemachineset-machine-openshift-io-v1[`ControlPlaneMachineSet` custom resource] +* link:https://github.com/openshift/cluster-control-plane-machine-set-operator[cluster-control-plane-machine-set-operator] include::modules/cluster-dns-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-dns-operator[cluster-dns-operator] + include::modules/etcd-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-etcd-operator/[cluster-etcd-operator] + include::modules/ingress-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-ingress-operator[openshift-ingress-operator] + include::modules/insights-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../installing/overview/cluster-capabilities.adoc#insights-operator_cluster-capabilities[Insights capability] * xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] +* link:https://github.com/openshift/insights-operator[insights-operator] include::modules/kube-apiserver-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-kube-apiserver-operator[`openshift-kube-apiserver-operator`] + include::modules/kube-controller-manager-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-kube-controller-manager-operator[`cluster-kube-controller-manager-operator`] + include::modules/cluster-kube-scheduler-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-kube-scheduler-operator[cluster-kube-scheduler-operator] + include::modules/cluster-kube-storage-version-migrator-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-kube-storage-version-migrator-operator[cluster-kube-storage-version-migrator-operator] + include::modules/machine-api-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/machine-api-operator[machine-api-operator] + include::modules/machine-config-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/machine-config-operator[openshift-machine-config-operator] + include::modules/operator-marketplace.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../installing/overview/cluster-capabilities.adoc#marketplace-operator_cluster-capabilities[Marketplace capability] +* link:https://github.com/operator-framework/operator-marketplace[operator-marketplace] include::modules/node-tuning-operator.adoc[leveloffset=+1] [role="_additional-resources"] -[id="cluster-operators-ref-nto-addtl-resources"] -=== Additional resources +.Additional resources * xref:../scalability_and_performance/cnf-understanding-low-latency.adoc#cnf-understanding-low-latency_cnf-understanding-low-latency[About low latency] +* link:https://github.com/openshift/cluster-node-tuning-operator[cluster-node-tuning-operator] include::modules/openshift-apiserver-operator.adoc[leveloffset=+1] -include::modules/cluster-openshift-controller-manager-operators.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-openshift-apiserver-operator[openshift-apiserver-operator] -[id="cluster-operators-ref-olm"] -== {olmv0-first} Operators +include::modules/cluster-openshift-controller-manager-operators.adoc[leveloffset=+1] -[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_operator-reference[{olmv1-first} Operators]. -==== +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/cluster-openshift-controller-manager-operator[cluster-openshift-controller-manager-operator] +include::modules/cluster-operators-ref-olm-intro.adoc[leveloffset=+1] include::modules/olm-overview.adoc[leveloffset=+2] @@ -153,32 +235,25 @@ include::modules/olm-arch-catalog-registry.adoc[leveloffset=+2] include::modules/olm-architecture.adoc[leveloffset=+2] - -=== Cluster Operators - -In {product-title}, OLM functionality is provided across a set of cluster Operators: - -`operator-lifecycle-manager`:: Provides the OLM Operator. Also informs cluster administrators if there are any installed Operators blocking cluster upgrade, based on their `olm.maxOpenShiftVersion` properties. For more information, see "Controlling Operator compatibility with {product-title} versions". -`operator-lifecycle-manager-catalog`:: Provides the Catalog Operator. -`operator-lifecycle-manager-packageserver`:: Represents an API extension server responsible for collecting metadata from all catalogs on the cluster and serves the user-facing `PackageManifest` API. +include::modules/cluster-operators-ref-olm-list.adoc[leveloffset=+2] [role="_additional-resources"] - -[id="cluster-operators-ref-olm-addtl-resources"] -=== Additional resources +.Additional resources * xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Understanding Operator Lifecycle Manager (OLM)] include::modules/olmv1-clusteroperator.adoc[leveloffset=+1] [role="_additional-resources"] - -[id="cluster-operators-ref-olmv1-addtl-resources"] -=== Additional resources +.Additional resources * xref:../extensions/index.adoc#extensions-overview[Extensions overview] * xref:../extensions/ce/update-paths.adoc#olmv1-ocp-compat_update-paths[Compatibility with {product-title} versions] include::modules/openshift-service-ca-operator.adoc[leveloffset=+1] +[role="_additional-resources"] +.Additional resources +* link:https://github.com/openshift/service-ca-operator[openshift-service-ca-operator] + include::modules/vsphere-problem-detector-operator.adoc[leveloffset=+1] [role="_additional-resources"]