Skip to content

Commit 8cd6619

Browse files
authored
Merge pull request #94766 from AedinC/enterprise-4.18
[enterprise-4.18]Manual cherry pick of OSDOCS-14937:Storage breakout from Classic to HCP
2 parents 544e254 + d6c227f commit 8cd6619

12 files changed

+102
-96
lines changed

modules/dynamic-provisioning-available-plugins.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ configured provider's API to create new storage resources:
1717
|Provisioner plugin name
1818
|Notes
1919

20-
ifndef::openshift-dedicated,openshift-rosa[]
20+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2121
|{rh-openstack-first} Cinder
2222
|`kubernetes.io/cinder`
2323
|
2424

2525
|{rh-openstack} Manila Container Storage Interface (CSI)
2626
|`manila.csi.openstack.org`
2727
|Once installed, the OpenStack Manila CSI Driver Operator and ManilaDriver automatically create the required storage classes for all available Manila share types needed for dynamic provisioning.
28-
endif::openshift-dedicated,openshift-rosa[]
28+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2929

3030
|Amazon Elastic Block Store (Amazon EBS)
3131
|`kubernetes.io/aws-ebs`
3232
|For dynamic provisioning when using multiple clusters in different zones,
3333
tag each node with `Key=kubernetes.io/cluster/<cluster_name>,Value=<cluster_id>`
3434
where `<cluster_name>` and `<cluster_id>` are unique per cluster.
3535

36-
ifndef::openshift-dedicated,openshift-rosa[]
36+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3737
|Azure Disk
3838
|`kubernetes.io/azure-disk`
3939
|
@@ -42,9 +42,9 @@ ifndef::openshift-dedicated,openshift-rosa[]
4242
|`kubernetes.io/azure-file`
4343
|The `persistent-volume-binder` service account requires permissions to create
4444
and get secrets to store the Azure storage account and keys.
45-
endif::openshift-dedicated,openshift-rosa[]
45+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4646

47-
ifndef::openshift-rosa[]
47+
ifndef::openshift-rosa,openshift-rosa-hcp[]
4848
|GCE Persistent Disk (gcePD)
4949
|`kubernetes.io/gce-pd`
5050
|In multi-zone configurations, it is advisable to run one {product-title}
@@ -54,7 +54,7 @@ no node in the current cluster exists.
5454
|{ibm-power-server-name} Block
5555
|`powervs.csi.ibm.com`
5656
|After installation, the {ibm-power-server-name} Block CSI Driver Operator and {ibm-power-server-name} Block CSI Driver automatically create the required storage classes for dynamic provisioning.
57-
endif::openshift-rosa[]
57+
endif::openshift-rosa,openshift-rosa-hcp[]
5858

5959
//|GlusterFS
6060
//|`kubernetes.io/glusterfs`
@@ -68,11 +68,11 @@ endif::openshift-rosa[]
6868
//|`netapp.io/trident`
6969
//|Storage orchestrator for NetApp ONTAP, SolidFire, and E-Series storage.
7070

71-
ifndef::openshift-dedicated,openshift-rosa[]
71+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7272
|link:https://www.vmware.com/support/vsphere.html[VMware vSphere]
7373
|`kubernetes.io/vsphere-volume`
7474
|
75-
endif::openshift-dedicated,openshift-rosa[]
75+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
7676

7777
//|HPE Nimble Storage
7878
//|`hpe.com/nimble`

modules/dynamic-provisioning-defining-storage-class.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
`StorageClass` objects are currently a globally scoped object and must be
1111
created by `cluster-admin` or `storage-admin` users.
1212

13-
ifndef::microshift,openshift-rosa[]
13+
ifndef::microshift,openshift-rosa,openshift-rosa-hcp[]
1414
[IMPORTANT]
1515
====
1616
The Cluster Storage Operator might install a default storage class depending
@@ -19,13 +19,13 @@ Operator. It cannot be deleted or modified beyond defining annotations
1919
and labels. If different behavior is desired, you must define a custom
2020
storage class.
2121
====
22-
endif::microshift,openshift-rosa[]
23-
ifdef::openshift-rosa[]
22+
endif::microshift,openshift-rosa,openshift-rosa-hcp[]
23+
ifdef::openshift-rosa,openshift-rosa-hcp[]
2424
[IMPORTANT]
2525
====
2626
The Cluster Storage Operator installs a default storage class. This storage class is owned and controlled by the Operator. It cannot be deleted or modified beyond defining annotations and labels. If different behavior is desired, you must define a custom storage class.
2727
====
28-
endif::openshift-rosa[]
28+
endif::openshift-rosa,openshift-rosa-hcp[]
2929

3030
The following sections describe the basic definition for a
3131
`StorageClass` object and specific examples for each of the supported plugin types.

modules/openshift-storage-common-terms.adoc

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Access modes:: Volume access modes describe volume capabilities. You can use acc
1515
* ReadWriteMany (RWX)
1616
* ReadWriteOncePod (RWOP)
1717
18-
ifndef::openshift-dedicated,openshift-rosa[]
18+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1919
Cinder:: The Block Storage service for {rh-openstack-first} which manages the administration, security, and scheduling of all volumes.
20-
endif::openshift-dedicated,openshift-rosa[]
20+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2121

2222
Config map:: A config map provides a way to inject configuration data into pods. You can reference the data stored in a config map in a volume of type `ConfigMap`. Applications running in a pod can use this data.
2323

@@ -30,18 +30,18 @@ The framework allows you to create storage volumes on-demand, eliminating the ne
3030
Ephemeral storage::
3131
Pods and containers can require temporary or transient local storage for their operation. The lifetime of this ephemeral storage does not extend beyond the life of the individual pod, and this ephemeral storage cannot be shared across pods.
3232

33-
ifndef::openshift-dedicated,openshift-rosa[]
33+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3434
Fiber channel:: A networking technology that is used to transfer data among data centers, computer servers, switches and storage.
3535

3636
FlexVolume:: FlexVolume is an out-of-tree plugin interface that uses an exec-based model to interface with storage drivers. You must install the FlexVolume driver binaries in a pre-defined volume plugin path on each node and in some cases the control plane nodes.
37-
endif::openshift-dedicated,openshift-rosa[]
37+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3838

3939
fsGroup:: The fsGroup defines a file system group ID of a pod.
4040

41-
ifndef::openshift-dedicated,openshift-rosa[]
41+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4242
iSCSI:: Internet Small Computer Systems Interface (iSCSI) is an Internet Protocol-based storage networking standard for linking data storage facilities.
4343
An iSCSI volume allows an existing iSCSI (SCSI over IP) volume to be mounted into your Pod.
44-
endif::openshift-dedicated,openshift-rosa[]
44+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4545

4646
hostPath::
4747
A hostPath volume in an OpenShift Container Platform cluster mounts a file or directory from the host node’s filesystem into your pod.
@@ -50,9 +50,9 @@ KMS key:: The Key Management Service (KMS) helps you achieve the required level
5050

5151
Local volumes:: A local volume represents a mounted local storage device such as a disk, partition or directory.
5252

53-
ifndef::openshift-dedicated,openshift-rosa[]
53+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5454
NFS:: A Network File System (NFS) that allows remote hosts to mount file systems over a network and interact with those file systems as though they are mounted locally. This enables system administrators to consolidate resources onto centralized servers on the network.
55-
endif::openshift-dedicated,openshift-rosa[]
55+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5656

5757
OpenShift Data Foundation::
5858
A provider of agnostic persistent storage for OpenShift Container Platform supporting file, block, and object storage, either in-house or in hybrid clouds
@@ -79,10 +79,16 @@ Stateful applications:: A stateful application is an application program that sa
7979

8080
Static provisioning:: A cluster administrator creates a number of PVs. PVs contain the details of storage. PVs exist in the Kubernetes API and are available for consumption.
8181

82-
Storage:: {product-title} supports many types of storage, both for on-premise and cloud providers. You can manage container storage for persistent and non-persistent data in an {product-title} cluster.
82+
Storage:: {product-title} supports many types of storage, both for on-premise and cloud providers. You can manage container storage for persistent and non-persistent data in
83+
ifdef::openshift-rosa,openshift-rosa-hcp[]
84+
a {product-title} cluster.
85+
endif::openshift-rosa,openshift-rosa-hcp[]
86+
ifndef::openshift-rosa,openshift-rosa-hcp[]
87+
an {product-title} cluster.
88+
endif::openshift-rosa,openshift-rosa-hcp[]
8389

8490
Storage class:: A storage class provides a way for administrators to describe the classes of storage they offer. Different classes might map to quality of service levels, backup policies, arbitrary policies determined by the cluster administrators.
8591

86-
ifndef::openshift-dedicated,openshift-rosa[]
92+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
8793
VMware vSphere’s Virtual Machine Disk (VMDK) volumes:: Virtual Machine Disk (VMDK) is a file format that describes containers for virtual hard disk drives that is used in virtual machines.
88-
endif::openshift-dedicated,openshift-rosa[]
94+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

modules/persistent-storage-csi-drivers-supported.adoc

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,47 @@
99

1010
To create CSI-provisioned persistent volumes that mount to these supported storage assets, {product-title} installs the necessary CSI driver Operator, the CSI driver, and the required storage class by default. For more details about the default namespace of the Operator and driver, see the documentation for the specific CSI Driver Operator.
1111

12-
ifndef::openshift-rosa[]
12+
ifndef::openshift-rosa,openshift-rosa-hcp[]
1313
[IMPORTANT]
1414
====
1515
The AWS EFS and GCP Filestore CSI drivers are not installed by default, and must be installed manually. For instructions on installing the AWS EFS CSI driver, see link:https://access.redhat.com/documentation/en-us/openshift_dedicated/4/html/storage/using-container-storage-interface-csi#osd-persistent-storage-aws-efs-csi[Setting up AWS Elastic File Service CSI Driver Operator]. For instructions on installing the GCP Filestore CSI driver, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html/storage/using-container-storage-interface-csi#persistent-storage-csi-google-cloud-file-overview[Google Compute Platform Filestore CSI Driver Operator].
1616
====
17-
endif::openshift-rosa[]
17+
endif::openshift-rosa,openshift-rosa-hcp[]
1818
The following table describes the CSI drivers that are
1919
ifndef::openshift-dedicated[]
2020
installed with {product-title}
2121
endif::openshift-dedicated[]
22-
ifndef::openshift-rosa[]
22+
ifndef::openshift-rosa,openshift-rosa-hcp[]
2323
supported by {product-title}
24-
endif::openshift-rosa[]
24+
endif::openshift-rosa,openshift-rosa-hcp[]
2525
and which CSI features they support, such as volume snapshots and resize.
2626

27-
ifndef::openshift-rosa[]
27+
ifndef::openshift-rosa,openshift-rosa-hcp[]
2828
[IMPORTANT]
2929
====
3030
If your CSI driver is not listed in the following table, you must follow the installation instructions provided by your CSI storage vendor to use their supported CSI features.
3131
====
32-
endif::openshift-rosa[]
33-
ifdef::openshift-rosa,openshift-aro[]
32+
endif::openshift-rosa,openshift-rosa-hcp[]
33+
ifdef::openshift-rosa,,openshift-rosa-hcp,openshift-aro[]
3434
In addition to the drivers listed in the following table, ROSA functions with CSI drivers from third-party storage vendors. Red Hat does not oversee third-party provisioners or the connected CSI drivers and the vendors fully control source code, deployment, operation, and Kubernetes compatibility. These volume provisioners are considered customer-managed and the respective vendors are responsible for providing support. See the link:https://docs.openshift.com/rosa/rosa_architecture/rosa_policy_service_definition/rosa-policy-responsibility-matrix.html#rosa-policy-responsibilities_rosa-policy-responsibility-matrix[Shared responsibilities for {product-title}] matrix for more information.
35-
endif::openshift-rosa,openshift-aro[]
35+
endif::openshift-rosa,,openshift-rosa-hcp,openshift-aro[]
3636

3737
.Supported CSI drivers and features in {product-title}
3838
[cols=",^v,^v,^v,^v,^v,^v width="100%",options="header"]
3939
|===
4040
|CSI driver |CSI volume snapshots |CSI volume group snapshots ^[1]^ |CSI cloning |CSI resize |Inline ephemeral volumes
4141
|AWS EBS | ✅ | | | ✅|
4242
|AWS EFS | | | | |
43-
ifndef::openshift-rosa[]
43+
ifndef::openshift-rosa,openshift-rosa-hcp[]
4444
|Google Compute Platform (GCP) persistent disk (PD)| ✅| |✅^[2]^ | ✅|
4545
|GCP Filestore | ✅ | | | ✅|
46-
endif::openshift-rosa[]
47-
ifndef::openshift-dedicated,openshift-rosa[]
46+
endif::openshift-rosa,openshift-rosa-hcp[]
47+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4848
|{ibm-power-server-name} Block | | | | ✅ |
4949
|{ibm-cloud-name} Block | ✅^[3]^ | | | ✅^[3]^|
50-
endif::openshift-dedicated,openshift-rosa[]
50+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5151
|LVM Storage | ✅ | | ✅ | ✅ |
52-
ifndef::openshift-dedicated,openshift-rosa[]
52+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5353
|Microsoft Azure Disk | ✅ | | ✅ | ✅|
5454
|Microsoft Azure Stack Hub | ✅ | | ✅ | ✅|
5555
|Microsoft Azure File | ✅^[4]^ | | ✅^[4]^ | ✅| ✅
@@ -59,9 +59,9 @@ ifndef::openshift-dedicated,openshift-rosa[]
5959
|Shared Resource | | | | | ✅
6060
|CIFS/SMB | | | ✅ | |
6161
|VMware vSphere | ✅^[5]^ | | | ✅^[6]^|
62-
endif::openshift-dedicated,openshift-rosa[]
62+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
6363
|===
64-
ifndef::openshift-dedicated,openshift-rosa[]
64+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
6565
--
6666
1.
6767

@@ -95,4 +95,4 @@ include::snippets/technology-preview.adoc[leveloffset=+1]
9595

9696
* Online expansion is supported from vSphere version 7.0 Update 2 and later.
9797
--
98-
endif::openshift-dedicated,openshift-rosa[]
98+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

modules/storage-ephemeral-vols-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ Generic ephemeral volumes have the following features:
2626
====
2727
Generic ephemeral volumes do not support offline snapshots and resize.
2828
29-
ifndef::openshift-dedicated,openshift-rosa,microshift[]
29+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp,microshift[]
3030
Due to this limitation, the following Container Storage Interface (CSI) drivers do not support the following features for generic ephemeral volumes:
3131
3232
* Azure Disk CSI driver does not support resize.
3333
3434
* Cinder CSI driver does not support snapshot.
35-
endif::openshift-dedicated,openshift-rosa,microshift[]
35+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp,microshift[]
3636
====

modules/storage-persistent-storage-block-volume.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,31 @@ The following table displays which volume plugins support block volumes.
2929
|Volume Plugin |Manually provisioned |Dynamically provisioned |Fully supported
3030
|Amazon Elastic Block Store (Amazon EBS) | ✅ | ✅ | ✅
3131
|Amazon Elastic File Storage (Amazon EFS) | | |
32-
ifndef::openshift-dedicated,openshift-rosa[]
32+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3333
|Azure Disk | ✅ | ✅ | ✅
3434
|Azure File | | |
3535
|Cinder | ✅ | ✅ | ✅
3636
|Fibre Channel | ✅ | | ✅
37-
endif::openshift-dedicated,openshift-rosa[]
38-
ifndef::openshift-rosa[]
37+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
38+
ifndef::openshift-rosa,openshift-rosa-hcp[]
3939
|GCP | ✅ | ✅ | ✅
40-
endif::openshift-rosa[]
41-
ifndef::openshift-dedicated,openshift-rosa[]
40+
endif::openshift-rosa,openshift-rosa-hcp[]
41+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4242
|HostPath | | |
4343
|IBM Cloud Block Storage volume | ✅ | ✅ | ✅
4444
|iSCSI | ✅ | | ✅
4545
|Local volume | ✅ || ✅
46-
endif::openshift-dedicated,openshift-rosa[]
46+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4747
|LVM Storage | ✅ | ✅ | ✅
48-
ifndef::openshift-dedicated,openshift-rosa[]
48+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4949
|NFS | | |
5050
|{rh-storage-first} | ✅ | ✅ | ✅
5151
|CIFS/SMB | ✅ | ✅ | ✅
5252
|VMware vSphere | ✅ | ✅ | ✅
53-
endif::openshift-dedicated,openshift-rosa[]
53+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5454
|===
5555

56-
ifndef::openshift-dedicated,openshift-rosa[]
56+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5757
:FeatureName: Using any of the block volumes that can be provisioned manually, but are not provided as fully supported,
5858
include::snippets/technology-preview.adoc[leveloffset=+1]
59-
endif::openshift-dedicated,openshift-rosa[]
59+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

0 commit comments

Comments
 (0)