Skip to content

Commit eea1596

Browse files
author
Lisa Pettyjohn
committed
OSDOC-1175
1 parent fa53a03 commit eea1596

9 files changed

+116
-3
lines changed

‎_topic_map.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1092,6 +1092,8 @@ Topics:
10921092
File: persistent-storage-csi-snapshots
10931093
- Name: CSI volume cloning
10941094
File: persistent-storage-csi-cloning
1095+
- Name: CSI automatic migration
1096+
File: persistent-storage-csi-migration
10951097
- Name: AWS Elastic Block Store CSI Driver Operator
10961098
File: persistent-storage-csi-ebs
10971099
- Name: GCP PD CSI Driver Operator

‎modules/persistent-storage-csi-cinder-storage-class.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
[id="persistent-storage-csi-cinder_{context}"]
66
= Making OpenStack Cinder CSI the default storage class
77

8-
In {product-title}, the default storage class references the in-tree Cinder driver. The storage class will default to referencing OpenStack Cinder CSI in a subsequent update of {product-title}. Volumes provisioned using the existing in-tree storage class are planned for migration to the OpenStack Cinder CSI storage class at that time.
9-
108
The OpenStack Cinder CSI driver uses the `cinder.csi.openstack.org` parameter key to support dynamic provisioning.
119

1210
To enable OpenStack Cinder CSI provisioning in {product-title}, it is recommended that you overwrite the default in-tree storage class with `standard-csi`. Alternatively, you can create the persistent volume claim (PVC) and specify the storage class as "standard-csi".
1311

12+
In {product-title}, the default storage class references the in-tree Cinder driver. However, with xref:../container_storage_interface/persistent-storage-csi-migration.adoc#persistent-storage-csi-migration[CSI automatic migration] enabled, volumes created using the default storage class actually use the CSI driver.
13+
1414
.Recommended procedure
1515
Use the following steps to apply the `standard-csi` storage class by overwriting the default in-tree storage class.
1616

‎modules/persistent-storage-csi-migration-enable.adoc‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * storage/container_storage_interface/persistent-storage-csi-migration.adoc
4+
5+
[id="persistent-storage-csi-migration-enable_{context}"]
6+
= Enabling CSI automatic migration
7+
8+
[NOTE]
9+
====
10+
Enabling CSI automatic migration drains, and then restarts, all nodes in the cluster in sequence. This might take some time.
11+
====
12+
13+
.Procedure
14+
15+
* Enable feature gates (see _Nodes -> Enabling features using feature gates_).
16+
+
17+
[IMPORTANT]
18+
====
19+
After turning on Technology Preview features using feature gates, they cannot be turned off. As a result, cluster upgrades are prevented.
20+
====
21+
+
22+
The following configuration example enables CSI automatic migration to both CSI drivers (AWS EBS and Cinder):
23+
+
24+
[source,yaml]
25+
----
26+
apiVersion: config.openshift.io/v1
27+
kind: FeatureGate
28+
metadata:
29+
name: cluster
30+
spec:
31+
featureSet: TechPreviewNoUpgrade <1>
32+
...
33+
----
34+
<1> Enables automatic migration for AWS EBS and Cinder.
35+
+
36+
You can specify CSI automatic migration for a selected CSI driver by setting `CustomNoUpgrade` `featureSet` and for `featuregates` either:
37+
+
38+
--
39+
* CSIMigrationAWS
40+
41+
* CSIMigrationOpenStack
42+
--
43+
+
44+
The following configuration example enables automatic migration to the AWS EBS CSI driver only:
45+
+
46+
[source,yaml]
47+
----
48+
apiVersion: config.openshift.io/v1
49+
kind: FeatureGate
50+
metadata:
51+
name: cluster
52+
spec:
53+
featureSet: CustomNoUpgrade
54+
customNoUpgrade:
55+
enabled:
56+
- CSIMigrationAWS <1>
57+
...
58+
----
59+
<1> Enables automatic migration for AWS EBS only.

‎modules/persistent-storage-csi-migration-overview.adoc‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * storage/container_storage_interface/persistent-storage-csi-migration.adoc
4+
5+
[id="persistent-storage-csi-migration-overview_{context}"]
6+
= Overview
7+
8+
With the automatic migration feature enabled, volumes provisioned using in-tree storage plug-ins supported by this feature are migrated to their counterpart CSI drivers.
9+
10+
The following drivers are supported:
11+
12+
* Amazon Web Services (AWS) Elastic Block Storage (EBS)
13+
14+
* OpenStack Cinder
15+
16+
CSI automatic migration should be seamless. Enabling this feature does not change how you use all existing API objects (for example, `PersistentVolumes`, `PersistentVolumeClaims`, and `StorageClasses`).
17+
18+
By default, automatic migration is disabled.
19+
20+
[IMPORTANT]
21+
====
22+
CSI automatic migration will be enabled by default in a future {product-title} release, so it is highly recommended that you test it now and report any issues.
23+
====

‎storage/container_storage_interface/persistent-storage-csi-cinder.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ To create CSI-provisioned PVs that mount to OpenStack Cinder storage assets, {pr
1717

1818
* The _OpenStack Cinder CSI driver_ enables you to create and mount OpenStack Cinder PVs.
1919

20+
For {product-title}, automatic migration from OpenStack Cinder in-tree to the CSI driver is available as a Technology Preview (TP) feature.
21+
With migration enabled, volumes provisioned using the existing in-tree plug-in are automatically migrated to use the OpenStack Cinder CSI driver. For more information, see xref:persistent-storage-csi-migration.adoc#persistent-storage-csi-migration[CSI automatic migration feature].
22+
2023
include::modules/persistent-storage-csi-about.adoc[leveloffset=+1]
2124
include::modules/persistent-storage-csi-cinder-storage-class.adoc[leveloffset=+1]
2225

‎storage/container_storage_interface/persistent-storage-csi-ebs.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ include::modules/persistent-storage-csi-about.adoc[leveloffset=+1]
2929

3030
[IMPORTANT]
3131
====
32-
{product-title} defaults to using an in-tree, or non-CSI, driver to provision AWS EBS storage. This in-tree driver will be removed in a subsequent update of {product-title}. Volumes provisioned using the existing in-tree driver are planned for migration to the CSI driver at that time.
32+
{product-title} defaults to using an in-tree, or non-CSI, driver to provision AWS EBS storage. Automatic migration from AWS EBS in-tree to the CSI driver is available as a Technology Preview feature.
33+
With automatic migration enabled, volumes provisioned using the existing in-tree driver are automatically migrated to use the AWS EBS CSI driver. For more information, see xref:persistent-storage-csi-migration.adoc#persistent-storage-csi-migration[CSI automatic migration].
3334
====
3435

3536
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].

‎storage/container_storage_interface/persistent-storage-csi-migration.adoc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[id="persistent-storage-csi-migration"]
2+
= CSI automatic migration
3+
include::modules/common-attributes.adoc[]
4+
:context: persistent-storage-csi-migration
5+
6+
toc::[]
7+
8+
{product-title} provides automatic migration for supported in-tree volume plug-ins to their equivalent Container Storage Interface (CSI) drivers.
9+
10+
:FeatureName: CSI automatic migration
11+
include::modules/technology-preview.adoc[leveloffset=+1]
12+
13+
include::modules/persistent-storage-csi-migration-overview.adoc[leveloffset=+1]
14+
15+
include::modules/persistent-storage-csi-migration-enable.adoc[leveloffset=+1]
16+
17+
== Additional Resources
18+
19+
* xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc[Enabling features using feature gates]

‎storage/persistent_storage/persistent-storage-aws.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ High-availability of storage in the infrastructure is left to the underlying
2424
storage provider.
2525
====
2626

27+
For {product-title}, automatic migration from AWS EBS in-tree to the Container Storage Interface (CSI) driver is available as a Technology Preview (TP) feature.
28+
With migration enabled, volumes provisioned using the existing in-tree driver are automatically migrated to use the AWS EBS CSI driver For more information, see xref:../container_storage_interface/persistent-storage-csi-migration.adoc#persistent-storage-csi-migration[CSI automatic migration feature].
29+
2730
== Additional resources
2831

2932
* See xref:../../storage/container_storage_interface/persistent-storage-csi-ebs.adoc#persistent-storage-csi-ebs[AWS Elastic Block Store CSI Driver Operator] for information about accessing additional storage options, such as volume snapshots, that are not possible with in-tree volume plug-ins.

‎storage/persistent_storage/persistent-storage-cinder.adoc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ shared across the {product-title} cluster.
1313
Persistent volume claims are specific to a project or namespace and can be
1414
requested by users.
1515

16+
For {product-title}, automatic migration from OpenStack Cinder in-tree to the Container Storage Interface (CSI) driver is available as a Technology Preview (TP) feature.
17+
With migration enabled, volumes provisioned using the existing in-tree plug-in are automatically migrated to use the OpenStack Cinder CSI driver. For more information, see xref:../container_storage_interface/persistent-storage-csi-migration.adoc#persistent-storage-csi-migration[CSI automatic migration feature].
18+
1619
.Additional resources
1720
* For more information about how OpenStack Block Storage provides persistent block storage management for virtual hard drives, see link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/8/html-single/architecture_guide/index#comp-cinder[OpenStack Cinder].
1821

0 commit comments

Comments
 (0)