openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

OSDOCS-1176 - Update CSI driver operator docs

Browse Source
This commit is contained in:
Bob Furu
2020-08-13 17:08:35 -04:00
committed by openshift-cherrypick-robot
parent cad6726074
commit a4f5a9291c
8 changed files with 61 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
_topic_map.yml
View File

@@ -735,6 +735,8 @@ Topics:
File: persistent-storage-csi-ebs
- Name: OpenStack Manila CSI Driver Operator
File: persistent-storage-csi-manila
- Name: Red Hat Virtualization (oVirt) CSI Driver Operator
File: persistent-storage-csi-ovirt
- Name: Expanding persistent volumes
File: expanding-persistent-volumes
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated

11
modules/persistent-storage-csi-about.adoc Normal file
View File

@@ -0,0 +1,11 @@
// Module included in the following assemblies:
//
// * storage/container_storage_interface/persistent-storage-csi-ebs.adoc
// * storage/container_storage_interface/persistent-storage-csi-manila.adoc
// * storage/container_storage_interface/persistent-storage-csi-ovirt.adoc
[id="csi-about_{context}"]
= About CSI
Storage vendors have traditionally provided storage drivers as part of Kubernetes. With the implementation of the Container Storage Interface (CSI), third-party providers can instead deliver storage plug-ins using a standard interface without ever having to change the core Kubernetes code.
CSI Operators give {product-title} users storage options, such as volume snapshots, that are not possible with in-tree volume plug-ins.

2
modules/persistent-storage-csi-dynamic-provisioning.adoc
View File

@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * storage/container_storage_interface/persistent_storage-csi.adoc
// * storage/container_storage_interface/persistent-storage-csi.adoc
[id="csi-dynamic-provisioning_{context}"]
= Dynamic Provisioning

28
modules/persistent-storage-csi-ebs-operator-uninstall.adoc
View File

@@ -1,28 +0,0 @@
// Module included in the following assemblies:
//
// * storage/container_storage_interface/persistent-storage-csi-ebs.adoc
[id="persistent-storage-csi-ebs-operator-uninstall_{context}"]
= Uninstalling the AWS Elastic Block Store CSI Driver Operator
Before you uninstall the AWS EBS CSI Driver Operator, you must delete all persistent volume claims (PVCs) that are in use by the Operator.
.Prerequisites
* Access to the {product-title} web console.
.Procedure
To uninstall the AWS EBS CSI Driver Operator from the web console:
. Log in to the web console.
. Navigate to *Storage* -> *Persistent Volume Claims*.
. Select any PVCs that are in use by the AWS EBS CSI Driver Operator and click *Delete*.
. From the *Operators* -> *Installed Operators* page, scroll or type *AWS EBS CSI* into the *Filter by name* field to find the Operator. Then, click on it.
. On the right-hand side of the *Installed Operators* details page, select *Uninstall Operator* from the *Actions* drop-down menu.
. When prompted by the *Uninstall Operator* window, click the *Uninstall* button to remove the Operator from the namespace. Any applications deployed by the Operator on the cluster will need to be cleaned up manually.
Once finished, the AWS EBS CSI Driver Operator is no longer listed in the *Installed Operators* section of the web console.

6
modules/storage-create-storage-class.adoc
View File

@@ -31,6 +31,12 @@ persistent volumes.
.. Select the reclaim policy.
.. Select `{Provisioner}` from the drop down list.
+
[NOTE]
====
For Container Storage Interface (CSI) provisioning, select `ebs.csi.aws.com`.
====
.. Enter additional parameters for the storage class as desired.

28
storage/container_storage_interface/persistent-storage-csi-ebs.adoc
View File

@@ -9,20 +9,23 @@ toc::[]
{product-title} is capable of provisioning persistent volumes (PVs) using the Container Storage Interface (CSI) driver for AWS Elastic Block Store (EBS).
Familiarity with link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/[PVs], link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[persistent volume claims (PVCs)], link:http://blog.kubernetes.io/2016/10/dynamic-provisioning-and-storage-in-kubernetes.html[dynamic
provisioning], and link:https://kubernetes.io/docs/admin/authorization/rbac/[RBAC authorization] is recommended.
Before PVCs can be created, you must install the AWS EBS CSI Driver Operator. The Operator provides a default StorageClass that you can use to create PVCs. You also have the option to create the EBS StorageClass as described in xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent Storage Using AWS Elastic Block Store].
After the Operator is installed, you must also create the AWS EBS CSI custom resource (CR) that is required in the {product-title} cluster.
:FeatureName: AWS EBS CSI Driver Operator
include::modules/technology-preview.adoc[leveloffset=+1]
== About CSI
Storage vendors have traditionally provided storage drivers as part of Kubernetes. With the implementation of the Container Storage Interface (CSI), third-party providers can instead deliver storage plug-ins using a standard interface without ever having to change the core Kubernetes code.
Familiarity with xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] and xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[configuring CSI volumes] is recommended when working with a Container Storage Interface (CSI) Operator and driver.
CSI Operators give {product-title} users storage options, such as volume snapshots, that are not possible with in-tree volume plug-ins.
To create CSI-provisioned PVs that mount to AWS EBS storage assets, {product-title} installs the AWS EBS CSI Driver Operator and the AWS EBS CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
* The _AWS EBS CSI Driver Operator_ provides a StorageClass by default that you can use to create PVCs. You also have the option to create the AWS EBS StorageClass as described in xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent Storage Using AWS Elastic Block Store].
* The _AWS EBS CSI driver_ enables you to create and mount AWS EBS PVs.
[NOTE]
====
If you installed the AWS EBS CSI Operator and driver on a {product-title} 4.5 cluster, you must uninstall the 4.5 Operator and driver before you update to {product-title} {product-version}.
====
include::modules/persistent-storage-csi-about.adoc[leveloffset=+1]
[IMPORTANT]
====
@@ -31,11 +34,6 @@ CSI Operators give {product-title} users storage options, such as volume snapsho
For information about dynamically provisioning AWS EBS persistent volumes in {product-title}, see xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent Storage Using AWS Elastic Block Store].
include::modules/persistent-storage-csi-ebs-operator-install.adoc[leveloffset=+1]
include::modules/persistent-storage-csi-ebs-operator-install-driver.adoc[leveloffset=+1]
include::modules/persistent-storage-csi-ebs-operator-uninstall.adoc[leveloffset=+1]
//include::modules/persistent-storage-csi-ebs-operator-install-driver.adoc[leveloffset=+1]
.Additional resources
* xref:../../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-aws[Persistent Storage Using AWS Elastic Block Store]
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]

13
storage/container_storage_interface/persistent-storage-csi-manila.adoc
View File

@@ -9,20 +9,17 @@ toc::[]
{product-title} is capable of provisioning persistent volumes (PVs) using the Container Storage Interface (CSI) driver for the link:https://wiki.openstack.org/wiki/Manila[OpenStack Manila] shared file system service.
Familiarity with link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/[PVs], link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[persistent volume claims (PVCs)], link:http://blog.kubernetes.io/2016/10/dynamic-provisioning-and-storage-in-kubernetes.html[dynamic
provisioning], and link:https://kubernetes.io/docs/admin/authorization/rbac/[RBAC authorization] is recommended.
Familiarity with xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] and xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[configuring CSI volumes] is recommended when working with a Container Storage Interface (CSI) Operator and driver.
Before PVCs can be created, you must install the Manila CSI Driver Operator. The Operator creates the required storage classes for all available Manila share types needed for dynamic provisioning.
To create CSI-provisioned PVs that mount to Manila storage assets, {product-title} installs the Manila CSI Driver Operator and the Manila CSI driver by default on any OpenStack cluster that has the Manila service enabled.
After the Operator is installed, you must also create the ManilaDriver Custom Resource (CR) that is required in the {product-title} cluster.
* The _Manila CSI Driver Operator_ creates the required storage class that is needed to create PVCs for all available Manila share types. The Operator is installed in the `openshift-cluster-csi-drivers` namespace.
include::modules/persistent-storage-csi-manila-install-operator.adoc[leveloffset=+1]
* The _Manila CSI driver_ enables you to create and mount Manila PVs. The driver is installled in the `openshift-manila-csi-driver` namespace.
include::modules/persistent-storage-csi-manila-install-driver.adoc[leveloffset=+1]
include::modules/persistent-storage-csi-about.adoc[leveloffset=+1]
include::modules/persistent-storage-csi-manila-dynamic-provisioning.adoc[leveloffset=+1]
include::modules/persistent-storage-csi-manila-uninstall-operator.adoc[leveloffset=+1]
.Additional resources
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]

23
storage/container_storage_interface/persistent-storage-csi-ovirt.adoc Normal file
View File

@@ -0,0 +1,23 @@
[id="persistent-storage-csi-ovirt"]
= Red Hat Virtualization (oVirt) CSI Driver Operator
include::modules/common-attributes.adoc[]
:context: persistent-storage-csi-ovirt
toc::[]
== Overview
{product-title} is capable of provisioning persistent volumes (PVs) using the Container Storage Interface (CSI) driver for Red Hat Virtualization (oVirt).
Familiarity with xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] and xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[configuring CSI volumes] is recommended when working with a Container Storage Interface (CSI) Operator and driver.
To create CSI-provisioned PVs that mount to Red Hat Virtualization (oVirt) storage assets, {product-title} installs the oVirt CSI Driver Operator and the oVirt CSI driver by default in the `openshift-cluster-csi-drivers` namespace.
* The _oVirt CSI Driver Operator_ provides a default StorageClass that you can use to create PVCs.
* The _oVirt CSI driver_ enables you to create and mount oVirt PVs.
include::modules/persistent-storage-csi-about.adoc[leveloffset=+1]
.Additional resources
* xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-csi[Configuring CSI volumes]