From ff433427a37f7fed1607213ec9d0e8d64c03a70d Mon Sep 17 00:00:00 2001 From: Bob Furu Date: Tue, 14 Apr 2020 16:46:50 -0400 Subject: [PATCH] OSDOCS-960 - Create h2 section for Storage -> CSI --- _topic_map.yml | 16 +++++---- .../planning-migration-3-to-4.adoc | 2 +- .../persistent-storage-csi-architecture.adoc | 3 +- ...rsistent-storage-csi-cloning-overview.adoc | 2 +- ...tent-storage-csi-cloning-provisioning.adoc | 2 +- .../persistent-storage-csi-cloning-using.adoc | 2 +- ...rsistent-storage-csi-driver-daemonset.adoc | 22 ++++++------- ...tent-storage-csi-dynamic-provisioning.adoc | 2 +- ...tent-storage-csi-external-controllers.adoc | 33 +++++++++---------- .../persistent-storage-csi-mysql-example.adoc | 7 ++-- ...rage-csi-snapshots-controller-sidecar.adoc | 2 +- ...rsistent-storage-csi-snapshots-create.adoc | 2 +- ...rsistent-storage-csi-snapshots-delete.adoc | 2 +- ...istent-storage-csi-snapshots-operator.adoc | 2 +- ...istent-storage-csi-snapshots-overview.adoc | 2 +- ...stent-storage-csi-snapshots-provision.adoc | 2 +- ...sistent-storage-csi-snapshots-restore.adoc | 2 +- storage/container_storage_interface/images | 1 + .../persistent-storage-csi-cloning.adoc | 2 +- .../persistent-storage-csi-snapshots.adoc | 2 +- .../persistent-storage-csi.adoc | 2 +- welcome/index.adoc | 2 +- 22 files changed, 58 insertions(+), 56 deletions(-) create mode 120000 storage/container_storage_interface/images rename storage/{persistent_storage => container_storage_interface}/persistent-storage-csi-cloning.adoc (94%) rename storage/{persistent_storage => container_storage_interface}/persistent-storage-csi-snapshots.adoc (95%) rename storage/{persistent_storage => container_storage_interface}/persistent-storage-csi.adoc (94%) diff --git a/_topic_map.yml b/_topic_map.yml index 670c5f32e4..ee9308683a 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -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 diff --git a/migration/migrating_3_4/planning-migration-3-to-4.adoc b/migration/migrating_3_4/planning-migration-3-to-4.adoc index 9b2cd08b5f..3944c9fe4d 100644 --- a/migration/migrating_3_4/planning-migration-3-to-4.adoc +++ b/migration/migrating_3_4/planning-migration-3-to-4.adoc @@ -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 diff --git a/modules/persistent-storage-csi-architecture.adoc b/modules/persistent-storage-csi-architecture.adoc index ae937303f7..0561cf4ff9 100644 --- a/modules/persistent-storage-csi-architecture.adoc +++ b/modules/persistent-storage-csi-architecture.adoc @@ -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. - diff --git a/modules/persistent-storage-csi-cloning-overview.adoc b/modules/persistent-storage-csi-cloning-overview.adoc index b8cdccd778..1e6425df86 100644 --- a/modules/persistent-storage-csi-cloning-overview.adoc +++ b/modules/persistent-storage-csi-cloning-overview.adoc @@ -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 diff --git a/modules/persistent-storage-csi-cloning-provisioning.adoc b/modules/persistent-storage-csi-cloning-provisioning.adoc index 89e0b4088b..3d53d5cfa7 100644 --- a/modules/persistent-storage-csi-cloning-provisioning.adoc +++ b/modules/persistent-storage-csi-cloning-provisioning.adoc @@ -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 diff --git a/modules/persistent-storage-csi-cloning-using.adoc b/modules/persistent-storage-csi-cloning-using.adoc index 4d1dd7564e..e28e7e1e18 100644 --- a/modules/persistent-storage-csi-cloning-using.adoc +++ b/modules/persistent-storage-csi-cloning-using.adoc @@ -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 diff --git a/modules/persistent-storage-csi-driver-daemonset.adoc b/modules/persistent-storage-csi-driver-daemonset.adoc index 523fb22d5a..5757bd8f54 100644 --- a/modules/persistent-storage-csi-driver-daemonset.adoc +++ b/modules/persistent-storage-csi-driver-daemonset.adoc @@ -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. diff --git a/modules/persistent-storage-csi-dynamic-provisioning.adoc b/modules/persistent-storage-csi-dynamic-provisioning.adoc index b0c76a5967..eaf780adf0 100644 --- a/modules/persistent-storage-csi-dynamic-provisioning.adoc +++ b/modules/persistent-storage-csi-dynamic-provisioning.adoc @@ -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 diff --git a/modules/persistent-storage-csi-external-controllers.adoc b/modules/persistent-storage-csi-external-controllers.adoc index e9694d2af0..5a2c54e0c1 100644 --- a/modules/persistent-storage-csi-external-controllers.adoc +++ b/modules/persistent-storage-csi-external-controllers.adoc @@ -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. ==== - diff --git a/modules/persistent-storage-csi-mysql-example.adoc b/modules/persistent-storage-csi-mysql-example.adoc index bcb3a83931..47906e4d38 100644 --- a/modules/persistent-storage-csi-mysql-example.adoc +++ b/modules/persistent-storage-csi-mysql-example.adoc @@ -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 ---- - diff --git a/modules/persistent-storage-csi-snapshots-controller-sidecar.adoc b/modules/persistent-storage-csi-snapshots-controller-sidecar.adoc index ef281413bf..612e7ac9d8 100644 --- a/modules/persistent-storage-csi-snapshots-controller-sidecar.adoc +++ b/modules/persistent-storage-csi-snapshots-controller-sidecar.adoc @@ -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 diff --git a/modules/persistent-storage-csi-snapshots-create.adoc b/modules/persistent-storage-csi-snapshots-create.adoc index 2984e6dd34..ee545dca71 100644 --- a/modules/persistent-storage-csi-snapshots-create.adoc +++ b/modules/persistent-storage-csi-snapshots-create.adoc @@ -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 diff --git a/modules/persistent-storage-csi-snapshots-delete.adoc b/modules/persistent-storage-csi-snapshots-delete.adoc index 2725ae2b56..bd1e6d41ad 100644 --- a/modules/persistent-storage-csi-snapshots-delete.adoc +++ b/modules/persistent-storage-csi-snapshots-delete.adoc @@ -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 diff --git a/modules/persistent-storage-csi-snapshots-operator.adoc b/modules/persistent-storage-csi-snapshots-operator.adoc index 7b04cf7745..700e790763 100644 --- a/modules/persistent-storage-csi-snapshots-operator.adoc +++ b/modules/persistent-storage-csi-snapshots-operator.adoc @@ -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 diff --git a/modules/persistent-storage-csi-snapshots-overview.adoc b/modules/persistent-storage-csi-snapshots-overview.adoc index f89c8ef321..02d1a364e6 100644 --- a/modules/persistent-storage-csi-snapshots-overview.adoc +++ b/modules/persistent-storage-csi-snapshots-overview.adoc @@ -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 diff --git a/modules/persistent-storage-csi-snapshots-provision.adoc b/modules/persistent-storage-csi-snapshots-provision.adoc index 3086e628b2..04172c87f8 100644 --- a/modules/persistent-storage-csi-snapshots-provision.adoc +++ b/modules/persistent-storage-csi-snapshots-provision.adoc @@ -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 diff --git a/modules/persistent-storage-csi-snapshots-restore.adoc b/modules/persistent-storage-csi-snapshots-restore.adoc index 06e5894790..5ed131079a 100644 --- a/modules/persistent-storage-csi-snapshots-restore.adoc +++ b/modules/persistent-storage-csi-snapshots-restore.adoc @@ -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 diff --git a/storage/container_storage_interface/images b/storage/container_storage_interface/images new file mode 120000 index 0000000000..5e67573196 --- /dev/null +++ b/storage/container_storage_interface/images @@ -0,0 +1 @@ +../images \ No newline at end of file diff --git a/storage/persistent_storage/persistent-storage-csi-cloning.adoc b/storage/container_storage_interface/persistent-storage-csi-cloning.adoc similarity index 94% rename from storage/persistent_storage/persistent-storage-csi-cloning.adoc rename to storage/container_storage_interface/persistent-storage-csi-cloning.adoc index 2670c2134c..0ec7cbd1e8 100644 --- a/storage/persistent_storage/persistent-storage-csi-cloning.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-cloning.adoc @@ -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 diff --git a/storage/persistent_storage/persistent-storage-csi-snapshots.adoc b/storage/container_storage_interface/persistent-storage-csi-snapshots.adoc similarity index 95% rename from storage/persistent_storage/persistent-storage-csi-snapshots.adoc rename to storage/container_storage_interface/persistent-storage-csi-snapshots.adoc index 24198553a3..5beea738e1 100644 --- a/storage/persistent_storage/persistent-storage-csi-snapshots.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-snapshots.adoc @@ -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 diff --git a/storage/persistent_storage/persistent-storage-csi.adoc b/storage/container_storage_interface/persistent-storage-csi.adoc similarity index 94% rename from storage/persistent_storage/persistent-storage-csi.adoc rename to storage/container_storage_interface/persistent-storage-csi.adoc index 1405ec801a..75da87f8c7 100644 --- a/storage/persistent_storage/persistent-storage-csi.adoc +++ b/storage/container_storage_interface/persistent-storage-csi.adoc @@ -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 diff --git a/welcome/index.adoc b/welcome/index.adoc index d6c41d3e59..f1ce2c1930 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -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]