mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-960 - Create h2 section for Storage -> CSI
This commit is contained in:
Bob Furu
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
3a82380d40
commit
ff433427a3
@@ -517,12 +517,6 @@ Topics:
|
||||
File: persistent-storage-azure-file
|
||||
- Name: Persistent storage using Cinder
|
||||
File: persistent-storage-cinder
|
||||
- Name: Persistent storage using Container Storage Interface (CSI)
|
||||
File: persistent-storage-csi
|
||||
- Name: Persistent storage using CSI volume cloning
|
||||
File: persistent-storage-csi-cloning
|
||||
- Name: Persistent storage using CSI volume snapshots
|
||||
File: persistent-storage-csi-snapshots
|
||||
- Name: Persistent storage using Fibre Channel
|
||||
File: persistent-storage-fibre
|
||||
- Name: Persistent storage using FlexVolume
|
||||
@@ -543,6 +537,16 @@ Topics:
|
||||
# File: persistent-storage-manila
|
||||
- Name: Persistent storage using VMware vSphere
|
||||
File: persistent-storage-vsphere
|
||||
- Name: Using Container Storage Interface (CSI)
|
||||
Dir: container_storage_interface
|
||||
Distros: openshift-enterprise,openshift-webscale,openshift-origin
|
||||
Topics:
|
||||
- Name: Configuring CSI volumes
|
||||
File: persistent-storage-csi
|
||||
- Name: Using CSI volume snapshots
|
||||
File: persistent-storage-csi-snapshots
|
||||
- Name: Using CSI volume cloning
|
||||
File: persistent-storage-csi-cloning
|
||||
- Name: Expanding persistent volumes
|
||||
File: expanding-persistent-volumes
|
||||
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated
|
||||
|
||||
@@ -101,7 +101,7 @@ For more information, see xref:../../storage/persistent_storage/persistent-stora
|
||||
|
||||
Persistent storage using the Container Storage Interface (CSI) was link:https://access.redhat.com/support/offerings/techpreview[Technology Preview] in {product-title} 3.11. CSI version 1.1.0 is fully supported in {product-title} 4.4, but does not ship with any CSI drivers. You must install your own driver.
|
||||
|
||||
For more information, see xref:../../storage/persistent_storage/persistent-storage-csi.adoc#persistent-storage-using-csi[Persistent storage using the Container Storage Interface (CSI)].
|
||||
For more information, see xref:../../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-using-csi[Persistent storage using the Container Storage Interface (CSI)].
|
||||
|
||||
[discrete]
|
||||
==== Red Hat OpenShift Container Storage
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent_storage-csi.adoc
|
||||
// * storage/container_storage_interface/persistent_storage-csi.adoc
|
||||
|
||||
[id="persistent-storage-csi-architecture_{context}"]
|
||||
= CSI Architecture
|
||||
@@ -19,4 +19,3 @@ image::csi-arch.png["Architecture of CSI components"]
|
||||
It is possible to run multiple CSI drivers for different storage backends.
|
||||
Each driver needs its own external controllers' deployment and DaemonSet
|
||||
with the driver and CSI registrar.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi-cloning.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-cloning.adoc
|
||||
|
||||
[id="persistent-storage-csi-cloning-overview_{context}"]
|
||||
= Overview of CSI volume cloning
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi-cloning.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-cloning.adoc
|
||||
|
||||
[id="persistent-storage-csi-cloning-provisioning_{context}"]
|
||||
= Provisioning a CSI volume clone
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi-cloning.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-cloning.adoc
|
||||
|
||||
[id="persistent-storage-csi-cloning-using_{context}"]
|
||||
= Using a cloned PVC as a storage volume
|
||||
|
||||
@@ -1,22 +1,22 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi.adoc
|
||||
// * storage/container_storage_interface/persistent_storage-csi.adoc
|
||||
|
||||
[id="csi-driver-daemonset_{context}"]
|
||||
= CSI Driver DaemonSet
|
||||
|
||||
The CSI driver DaemonSet runs a pod on every node that allows
|
||||
{product-title} to mount storage provided by the CSI driver to the node
|
||||
and use it in user workloads (pods) as persistent volumes (PVs). The pod
|
||||
with the CSI driver installed contains the following containers:
|
||||
The CSI driver DaemonSet runs a pod on every node that allows
|
||||
{product-title} to mount storage provided by the CSI driver to the node
|
||||
and use it in user workloads (pods) as persistent volumes (PVs). The pod
|
||||
with the CSI driver installed contains the following containers:
|
||||
|
||||
* A CSI driver registrar, which registers the CSI driver into the
|
||||
`openshift-node` service running on the node. The `openshift-node` process
|
||||
running on the node then directly connects with the CSI driver using the
|
||||
* A CSI driver registrar, which registers the CSI driver into the
|
||||
`openshift-node` service running on the node. The `openshift-node` process
|
||||
running on the node then directly connects with the CSI driver using the
|
||||
UNIX Domain Socket available on the node.
|
||||
* A CSI driver.
|
||||
|
||||
The CSI driver deployed on the node should have as few credentials to the
|
||||
storage backend as possible. {product-title} will only use the node plug-in
|
||||
set of CSI calls such as `NodePublish`/`NodeUnpublish` and
|
||||
The CSI driver deployed on the node should have as few credentials to the
|
||||
storage backend as possible. {product-title} will only use the node plug-in
|
||||
set of CSI calls such as `NodePublish`/`NodeUnpublish` and
|
||||
`NodeStage`/`NodeUnstage`, if these calls are implemented.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi.adoc
|
||||
// * storage/container_storage_interface/persistent_storage-csi.adoc
|
||||
|
||||
[id="csi-dynamic-provisioning_{context}"]
|
||||
= Dynamic Provisioning
|
||||
|
||||
@@ -1,41 +1,40 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi.adoc
|
||||
// * storage/container_storage_interface/persistent_storage-csi.adoc
|
||||
|
||||
[id="external-csi-contollers_{context}"]
|
||||
= External CSI controllers
|
||||
|
||||
External CSI Controllers is a deployment that deploys one or more pods
|
||||
External CSI Controllers is a deployment that deploys one or more pods
|
||||
with three containers:
|
||||
|
||||
* An external CSI attacher container translates `attach` and `detach`
|
||||
calls from {product-title} to respective `ControllerPublish` and
|
||||
* An external CSI attacher container translates `attach` and `detach`
|
||||
calls from {product-title} to respective `ControllerPublish` and
|
||||
`ControllerUnpublish` calls to the CSI driver.
|
||||
* An external CSI provisioner container that translates `provision` and
|
||||
`delete` calls from {product-title} to respective `CreateVolume` and
|
||||
* An external CSI provisioner container that translates `provision` and
|
||||
`delete` calls from {product-title} to respective `CreateVolume` and
|
||||
`DeleteVolume` calls to the CSI driver.
|
||||
* A CSI driver container
|
||||
|
||||
The CSI attacher and CSI provisioner containers communicate with the CSI
|
||||
driver container using UNIX Domain Sockets, ensuring that no CSI
|
||||
communication leaves the pod. The CSI driver is not accessible from
|
||||
The CSI attacher and CSI provisioner containers communicate with the CSI
|
||||
driver container using UNIX Domain Sockets, ensuring that no CSI
|
||||
communication leaves the pod. The CSI driver is not accessible from
|
||||
outside of the pod.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
`attach`, `detach`, `provision`, and `delete` operations typically require
|
||||
the CSI driver to use credentials to the storage backend. Run the CSI
|
||||
`attach`, `detach`, `provision`, and `delete` operations typically require
|
||||
the CSI driver to use credentials to the storage backend. Run the CSI
|
||||
controller pods on infrastructure nodes so the credentials are never leaked
|
||||
to user processes, even in the event of a catastrophic security breach
|
||||
to user processes, even in the event of a catastrophic security breach
|
||||
on a compute node.
|
||||
====
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The external attacher must also run for CSI drivers that do not support
|
||||
third-party `attach` or `detach` operations. The external attacher will
|
||||
not issue any `ControllerPublish` or `ControllerUnpublish` operations to
|
||||
the CSI driver. However, it still must run to implement the necessary
|
||||
The external attacher must also run for CSI drivers that do not support
|
||||
third-party `attach` or `detach` operations. The external attacher will
|
||||
not issue any `ControllerPublish` or `ControllerUnpublish` operations to
|
||||
the CSI driver. However, it still must run to implement the necessary
|
||||
{product-title} attachment API.
|
||||
====
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi.adoc
|
||||
// * storage/container_storage_interface/persistent_storage-csi.adoc
|
||||
|
||||
[id="csi-example-usage_{context}"]
|
||||
= Example using the CSI driver
|
||||
@@ -23,9 +23,8 @@ changes to the template.
|
||||
...
|
||||
|
||||
# oc get pvc
|
||||
NAME STATUS VOLUME CAPACITY
|
||||
NAME STATUS VOLUME CAPACITY
|
||||
ACCESS MODES STORAGECLASS AGE
|
||||
mysql Bound kubernetes-dynamic-pv-3271ffcb4e1811e8 1Gi
|
||||
mysql Bound kubernetes-dynamic-pv-3271ffcb4e1811e8 1Gi
|
||||
RWO cinder 3s
|
||||
----
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent-storage/persistent-storage-snapshots.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-snapshots.adoc
|
||||
|
||||
[id="persistent-storage-csi-snapshots-controller-sidecar_{context}"]
|
||||
= CSI snapshot controller and sidecar
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi-snapshots.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-snapshots.adoc
|
||||
|
||||
[id="persistent-storage-csi-snapshots-create_{context}"]
|
||||
= Creating a volume snapshot
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi-snapshots.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-snapshots.adoc
|
||||
|
||||
[id="persistent-storage-csi-snapshots-delete_{context}"]
|
||||
= Deleting a volume snapshot
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent-storage/persistent-storage-snapshots.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-snapshots.adoc
|
||||
|
||||
[id="persistent-storage-csi-snapshots-operator_{context}"]
|
||||
= About the CSI Snapshot Controller Operator
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-snapshots.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-snapshots.adoc
|
||||
|
||||
[id="persistent-storage-csi-snapshots-overview_{context}"]
|
||||
= Overview of CSI volume snapshots
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi-snapshots.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-snapshots.adoc
|
||||
|
||||
[id="persistent-storage-csi-snapshots-provision_{context}"]
|
||||
= Volume snapshot provisioning
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * storage/persistent_storage/persistent-storage-csi-snapshots.adoc
|
||||
// * storage/container_storage_interface/persistent-storage-csi-snapshots.adoc
|
||||
|
||||
[id="persistent-storage-csi-snapshots-restore_{context}"]
|
||||
= Restoring a volume snapshot
|
||||
|
||||
1
storage/container_storage_interface/images
Symbolic link
1
storage/container_storage_interface/images
Symbolic link
@@ -0,0 +1 @@
|
||||
../images
|
||||
@@ -1,5 +1,5 @@
|
||||
[id="persistent-storage-csi-cloning"]
|
||||
= Persistent storage using CSI volume cloning
|
||||
= Using CSI volume cloning
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: persistent-storage-csi-cloning
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
[id="persistent-storage-csi-snapshots"]
|
||||
= Persistent storage using CSI volume snapshots
|
||||
= Using CSI volume snapshots
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: persistent-storage-csi-snapshots
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
[id="persistent-storage-using-csi"]
|
||||
= Persistent storage using the Container Storage Interface (CSI)
|
||||
= Configuring CSI volumes
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: persistent-storage-csi
|
||||
|
||||
@@ -190,7 +190,7 @@ xref:../storage/persistent_storage/persistent-storage-ocs.adoc#red-hat-openshift
|
||||
xref:../storage/persistent_storage/persistent-storage-aws.adoc#persistent-storage-using-aws-ebs[AWS Elastic Block Store],
|
||||
xref:../storage/persistent_storage/persistent-storage-nfs.adoc#persistent-storage-using-nfs[NFS],
|
||||
xref:../storage/persistent_storage/persistent-storage-iscsi.adoc#persistent-storage-using-iscsi[iSCSI],
|
||||
xref:../storage/persistent_storage/persistent-storage-csi.adoc#persistent-storage-using-csi[Container Storage Interface (CSI)],
|
||||
xref:../storage/container_storage_interface/persistent-storage-csi.adoc#persistent-storage-using-csi[Container Storage Interface (CSI)],
|
||||
and more.
|
||||
As needed, you can
|
||||
xref:../storage/expanding-persistent-volumes.adoc#expanding-persistent-volumes[expand persistent volumes]
|
||||
|
||||
Reference in New Issue
Block a user