Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions modules/cloud-credential-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand All @@ -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`
Expand Down
8 changes: 2 additions & 6 deletions modules/cluster-authentication-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
7 changes: 1 addition & 6 deletions modules/cluster-autoscaler-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 1 addition & 8 deletions modules/cluster-bare-metal-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down Expand Up @@ -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::[]
Expand Down
7 changes: 1 addition & 6 deletions modules/cluster-capi-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,14 @@
[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]
====
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`
Expand Down
10 changes: 1 addition & 9 deletions modules/cluster-cloud-controller-manager-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down Expand Up @@ -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::[]
Expand Down
13 changes: 2 additions & 11 deletions modules/cluster-config-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
9 changes: 1 addition & 8 deletions modules/cluster-csi-snapshot-controller-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand All @@ -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::[]
Expand Down
6 changes: 1 addition & 5 deletions modules/cluster-dns-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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]
7 changes: 1 addition & 6 deletions modules/cluster-image-registry-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand All @@ -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::[]
Expand Down
7 changes: 1 addition & 6 deletions modules/cluster-kube-scheduler-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
6 changes: 1 addition & 5 deletions modules/cluster-kube-storage-version-migrator-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
6 changes: 1 addition & 5 deletions modules/cluster-machine-approver-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
12 changes: 3 additions & 9 deletions modules/cluster-monitoring-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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]
----
Expand Down
1 change: 1 addition & 0 deletions modules/cluster-network-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 2 additions & 6 deletions modules/cluster-openshift-controller-manager-operators.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -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]
10 changes: 10 additions & 0 deletions modules/cluster-operators-ref-olm-intro.adoc
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 14 additions & 0 deletions modules/cluster-operators-ref-olm-list.adoc
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 1 addition & 6 deletions modules/cluster-samples-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down Expand Up @@ -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"]
Expand Down
9 changes: 2 additions & 7 deletions modules/cluster-storage-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand All @@ -39,10 +38,6 @@ endif::cluster-caps[]

ifdef::operator-ref[]

Project::
+
See "cluster-storage-operator".

Configuration::
+
No configuration is required.
Expand All @@ -51,7 +46,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:
Expand Down
6 changes: 1 addition & 5 deletions modules/cluster-version-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Loading