1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 15:46:57 +01:00
Files
openshift-docs/modules/cluster-storage-operator.adoc
Kathryn Alexander 470601c7c9 moving install files
2024-07-30 14:45:34 -04:00

70 lines
2.0 KiB
Plaintext

// Module included in the following assemblies:
//
// * operators/operator-reference.adoc
// * installing/overview/cluster-capabilities.adoc
ifeval::["{context}" == "cluster-operators-ref"]
:operator-ref:
endif::[]
ifeval::["{context}" == "cluster-capabilities"]
:cluster-caps:
endif::[]
[id="cluster-storage-operator_{context}"]
ifdef::operator-ref[= Cluster Storage Operator]
ifdef::cluster-caps[= Cluster storage capability]
ifdef::operator-ref[]
[NOTE]
====
The Cluster Storage Operator is an optional cluster capability that can be disabled by cluster administrators during installation. For more information about optional cluster capabilities, see "Cluster capabilities" in _Installing_.
====
endif::operator-ref[]
[discrete]
== Purpose
ifdef::cluster-caps[]
The Cluster Storage Operator provides the features for the `Storage` capability.
endif::cluster-caps[]
The Cluster Storage Operator sets {product-title} cluster-wide storage defaults. It ensures a default `storageclass` exists for {product-title} clusters. It also installs Container Storage Interface (CSI) drivers which enable your cluster to use various storage backends.
ifdef::cluster-caps[]
[IMPORTANT]
====
If the cluster storage capability is disabled, the cluster will not have a default `storageclass` or any CSI drivers. Users with administrator privileges can create a default `storageclass` and manually install CSI drivers if the cluster storage capability is disabled.
====
endif::cluster-caps[]
ifdef::operator-ref[]
[discrete]
== Project
link:https://github.com/openshift/cluster-storage-operator[cluster-storage-operator]
[discrete]
== Configuration
No configuration is required.
endif::operator-ref[]
[discrete]
== 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.
ifeval::["{context}" == "cluster-operators-ref"]
:!operator-ref:
endif::[]
ifeval::["{context}" == "cluster-caps"]
:!cluster-caps:
endif::[]