Skip to content

Commit 5720602

Browse files
dileepdsdileepds
authored
Merge pull request #227 from datamattsson/v252
Initial edits for 2.5.2
2 parents b7b334e + 6f2cf3b commit 5720602

File tree

14 files changed

+406
-196
lines changed

14 files changed

+406
-196
lines changed

‎docs/csi_driver/archive.md

+77-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,85 @@
11
# Unsupported Releases
22

3-
HPE supports up to three minor releases. These release are kept here for historic purposes.
3+
HPE supports up to three historic minor releases on supported versions of upstream and downstream Kubernetes. Releases are kept here for historic purposes.
44

55
[TOC]
66

7+
#### HPE CSI Driver for Kubernetes 2.4.0
8+
9+
Release highlights:
10+
11+
* Kubernetes 1.27 and 1.28 support
12+
* KubeVirt and OpenShift Virtualization support for Nimble/Alletra 5000/6000
13+
* Enhanced scheduling for the NFS Server Provisioner
14+
* Multiarch images (Linux ARM64/AMD64) for the CSI driver components and Alletra 9000 CSP
15+
* Major updates to SIG Storage images
16+
17+
Upgrade considerations:
18+
19+
* Existing claims provisioned with the NFS Server Provisioner [needs to be upgraded](operations.md#upgrade_to_v240).
20+
21+
<table>
22+
<tr>
23+
<th>Kubernetes</th>
24+
<td>1.25-1.28<sup>1</sup></td>
25+
</tr>
26+
<tr>
27+
<th>Helm Chart</th>
28+
<td><a href="https://artifacthub.io/packages/helm/hpe-storage/hpe-csi-driver/2.4.0">v2.4.0</a> on ArtifactHub</td>
29+
</tr>
30+
<tr>
31+
<th>Operators</th>
32+
<td>
33+
<a href="https://operatorhub.io/operator/hpe-csi-operator/stable/hpe-csi-operator.v2.4.0">v2.4.0</a> on OperatorHub<br />
34+
<a href="https://catalog.redhat.com/software/container-stacks/detail/5e9874643f398525a0ceb004">v2.4.0</a> via OpenShift console
35+
</td>
36+
</tr>
37+
<tr>
38+
<th>Worker&nbsp;OS</th>
39+
<td>
40+
RHEL<sup>2</sup> 7.x, 8.x, 9.x, RHCOS 4.12-4.14<br />
41+
Ubuntu 16.04, 18.04, 20.04, 22.04<br />
42+
SLES 15 SP3, SP4, SP5
43+
</tr>
44+
<tr>
45+
<th>Platforms<sup>3</sup></th>
46+
<td>
47+
<!-- Alletra Storage MP (block) 10.2.x<br /-->
48+
Alletra OS 9000 9.3.x - 9.5.x<br />
49+
Alletra OS 5000/6000 6.0.0.x - 6.1.1.x<br />
50+
Nimble OS 5.0.10.x, 5.2.1.x, 6.0.0.x, 6.1.2.x<br />
51+
Primera OS 4.3.x - 4.5.x<br />
52+
3PAR OS 3.3.x
53+
</td>
54+
</tr>
55+
<tr>
56+
<th>Data&nbsp;protocols</th>
57+
<td>Fibre Channel, iSCSI</td>
58+
</tr>
59+
<tr>
60+
<th>Filesystems</th>
61+
<td>XFS, ext3/ext4, btrfs, NFSv4<sup>&ast;</sup></td>
62+
</tr>
63+
<tr>
64+
<th>Release&nbsp;notes</th>
65+
<td><a href=https://github.com/hpe-storage/csi-driver/blob/master/release-notes/v2.4.0.md>v2.4.0</a> on GitHub</td>
66+
</tr>
67+
<tr>
68+
<th>Blogs</th>
69+
<td>
70+
<a href="https://community.hpe.com/t5/around-the-storage-block/introduction-to-new-workload-paradigms-with-hpe-csi-driver-for/ba-p/7196554">Introduction to new workload paradigms with HPE CSI Driver for Kubernetes</a>
71+
</td>
72+
</tr>
73+
</table>
74+
75+
<small>
76+
<sup>&ast;</sup> = The HPE CSI Driver for Kubernetes is a block storage driver primarily. It includes an [NFS Server Provisioner](using.md#using_the_nfs_server_provisioner) that allows "ReadWriteMany" `PersistentVolumeClaims`.<br/>
77+
<sup>1</sup> = For HPE Ezmeral Runtime Enterprise, SUSE Rancher, Mirantis Kubernetes Engine and others; Kubernetes clusters must be deployed within the currently supported range of "Worker OS" platforms listed in the above table. See [partner ecosystems](partners/index.md) for other variations. Lowest tested and known working version is Kubernetes 1.21.<br />
78+
<sup>2</sup> = The HPE CSI Driver will recognize CentOS, AlmaLinux and Rocky Linux as RHEL derives and they are supported by HPE.<br/>
79+
<sup>3</sup> = Learn about each data platform's team [support commitment](../legal/support/index.md#container_storage_providers).<br/>
80+
</small>
81+
82+
783
#### HPE CSI Driver for Kubernetes 2.3.0
884

985
Release highlights:

‎docs/csi_driver/container_storage_provider/hpe_alletra_storage_mp_b10000/index.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,19 @@ The HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR Container Stor
2323

2424
| Port | Protocol | Description |
2525
| ---- | -------- | ----------- |
26-
| 443 | HTTPS | WSAPI (HPE Alletra Storage MP B10000, Alletra 9000/Primera) |
26+
| 443 | HTTPS | WSAPI (HPE Alletra Storage MP B10000, Alletra 9000 and Primera) |
2727
| 8080 | HTTPS | WSAPI (HPE 3PAR) |
28-
| 22 | SSH | Array communication |
28+
| 22 | SSH | Array communication (HPE 3PAR) |
29+
30+
!!! caution "HPE 3PAR"
31+
From HPE CSI Driver v2.5.2 onwards it's recommended to specify "<IP Addr>:443" in the backend `Secret` to avoid using SSH for any HPE Alletra Storage MP B10000 derived platform except 3PAR. See [Deployment](../../deployment.md#secret_parameters) for more information.
2932

3033
### User Role Requirements
3134

32-
The CSP requires access to a local user with either `edit` or the `super` role. It's recommended to use the `edit` role for security best practices.
35+
The CSP requires access to a user with either `edit` or the `super` role. It's recommended to use the `edit` role for security best practices.
3336

3437
!!! note
35-
LDAP users are not supported by the CSP.
38+
LDAP accounts may be used from HPE CSI Driver v2.5.2 onwards.
3639

3740
### Virtual Domains
3841

@@ -60,6 +63,9 @@ Next, make sure domain users are allowed to create hosts outside the domain.
6063
cli% setsys AllowDomainUsersAffectNoDomain hostonly
6164
```
6265

66+
!!! tip
67+
Hosts can be created manually at any point. Make sure the name of the host matches the name of each of the compute (worker) nodes in the Kubernetes cluster.
68+
6369
The next steps involve installing the HPE CSI Driver for Kubernetes with `disableHostDeletion` set to `true`. The steps to supply the parameter depends on if the Helm chart or Operator is being used.
6470

6571
- Helm chart install from [ArtifactHub.io](https://artifacthub.io/packages/helm/hpe-storage/hpe-csi-driver).

‎docs/csi_driver/deployment.md

+62-58
Original file line numberDiff line numberDiff line change
@@ -146,18 +146,19 @@ kubectl get csv -n my-hpe-csi-operator
146146

147147
Next, a `HPECSIDriver` object needs to be instantiated. Create a file named `hpe-csi-operator.yaml`, edit and apply (or copy the command from the top of the content).
148148

149-
```yaml fct_label="HPE CSI Operator v2.5.1"
149+
```yaml fct_label="HPE CSI Operator v2.5.2"
150+
# kubectl apply -n hpe-storage -f {{ config.site_url }}csi_driver/examples/deployment/hpecsidriver-v2.5.2-sample.yaml
151+
{% include "csi_driver/examples/deployment/hpecsidriver-v2.5.2-sample.yaml" %}```
152+
```
153+
154+
```yaml fct_label="v2.5.1"
150155
# kubectl apply -n hpe-storage -f {{ config.site_url }}csi_driver/examples/deployment/hpecsidriver-v2.5.1-sample.yaml
151156
{% include "csi_driver/examples/deployment/hpecsidriver-v2.5.1-sample.yaml" %}```
152157

153158
```yaml fct_label="v2.4.2"
154159
# kubectl apply -n hpe-storage -f {{ config.site_url }}csi_driver/examples/deployment/hpecsidriver-v2.4.2-sample.yaml
155160
{% include "csi_driver/examples/deployment/hpecsidriver-v2.4.2-sample.yaml" %}```
156161

157-
```yaml fct_label="v2.4.1"
158-
# kubectl apply -n hpe-storage -f {{ config.site_url }}csi_driver/examples/deployment/hpecsidriver-v2.4.1-sample.yaml
159-
{% include "csi_driver/examples/deployment/hpecsidriver-v2.4.1-sample.yaml" %}```
160-
161162
!!! tip
162163
The contents depends on which version of the CSI driver is installed. Please visit [OperatorHub](https://operatorhub.io/operator/hpe-csi-operator) or [ArtifactHub](https://artifacthub.io/packages/olm/community-operators/hpe-csi-operator) for more details.
163164

@@ -184,7 +185,7 @@ All parameters are mandatory and described below.
184185

185186
Example:
186187

187-
```yaml fct_label="HPE Alletra Storage MP B10000"
188+
```yaml fct_label="Alletra Storage MP B10000"
188189
apiVersion: v1
189190
kind: Secret
190191
metadata:
@@ -193,12 +194,12 @@ metadata:
193194
stringData:
194195
serviceName: alletrastoragemp-csp-svc
195196
servicePort: "8080"
196-
backend: 10.10.0.20
197+
backend: 10.10.0.20:443
197198
username: 3paradm
198199
password: 3pardata
199200
```
200201

201-
```yaml fct_label="HPE Alletra 5000/6000"
202+
```yaml fct_label="Alletra 5000/6000"
202203
apiVersion: v1
203204
kind: Secret
204205
metadata:
@@ -212,7 +213,7 @@ stringData:
212213
password: admin
213214
```
214215

215-
```yaml fct_label="HPE Alletra 9000"
216+
```yaml fct_label="Alletra 9000"
216217
apiVersion: v1
217218
kind: Secret
218219
metadata:
@@ -221,12 +222,12 @@ metadata:
221222
stringData:
222223
serviceName: alletra9000-csp-svc
223224
servicePort: "8080"
224-
backend: 10.10.0.20
225+
backend: 10.10.0.20:443
225226
username: 3paradm
226227
password: 3pardata
227228
```
228229

229-
```yaml fct_label="HPE Nimble Storage"
230+
```yaml fct_label="Nimble Storage"
230231
apiVersion: v1
231232
kind: Secret
232233
metadata:
@@ -240,7 +241,21 @@ stringData:
240241
password: admin
241242
```
242243

243-
```yaml fct_label="HPE Primera and 3PAR"
244+
```yaml fct_label="Primera"
245+
apiVersion: v1
246+
kind: Secret
247+
metadata:
248+
name: hpe-backend
249+
namespace: hpe-storage
250+
stringData:
251+
serviceName: primera3par-csp-svc
252+
servicePort: "8080"
253+
backend: 10.10.0.2:443
254+
username: 3paradm
255+
password: 3pardata
256+
```
257+
258+
```yaml fct_label="3PAR"
244259
apiVersion: v1
245260
kind: Secret
246261
metadata:
@@ -254,6 +269,9 @@ stringData:
254269
password: 3pardata
255270
```
256271

272+
!!! caution "Improved Security"
273+
From v2.5.2 onwards, all HPE Alletra Storage MP B10000 derived platforms except 3PAR should include port 443 with the backend IP address (i.e "10.10.0.2:443") to prevent the CSP from using SSH.
274+
257275
Create the `Secret` using `kubectl`:
258276

259277
```text
@@ -438,6 +456,8 @@ The following example walks through deployment of the **latest** CSI driver.
438456
!!! caution "Critical"
439457
It's highly recommended to use either the Helm chart or Operator to install the HPE CSI Driver for Kubernetes and the associated Container Storage Providers. Only venture down manual installation if your requirements can't be met by the [Helm chart](deployment.md#helm) or [Operator](deployment.md#operator).
440458

459+
The manifests used below are renders from the latest Helm template with default parameters.
460+
441461
### Manual CSI Driver Install
442462

443463
Deploy the CSI driver and sidecars for the relevant Kubernetes version.
@@ -455,89 +475,70 @@ All components below are deployed in the "hpe-storage" `Namespace`.
455475
kubectl create ns hpe-storage
456476
```
457477

458-
Worker node IO settings and common `CRDs`:
478+
Clone the "co-deployments" repo.
459479

460480
```text
461-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-linux-config.yaml
462-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-volumegroup-snapshotgroup-crds.yaml
481+
git clone https://github.com/hpe-storage/co-deployments
482+
cd co-deployments
483+
```
484+
485+
Worker node IO settings and `CRDs`:
486+
487+
```text
488+
kubectl -n hpe-storage apply -f yaml/csi-driver/edge/hpe-linux-config.yaml
489+
kubectl apply -f yaml/csi-driver/edge/csi-driver-crd.yaml
490+
kubectl apply -f yaml/csi-driver/edge/crds/
463491
```
464492

465493
Container Storage Provider:
466494

467495
```text fct_label="HPE Alletra 5000/6000 and Nimble Storage"
468-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/nimble-csp.yaml
496+
kubectl -n hpe-storage apply -f yaml/csi-driver/edge/nimble-csp.yaml
469497
```
470498

471-
```text fct_label="HPE Alletra Storage MP B10000, HPE Alletra 9000, Primera and 3PAR"
472-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/3par-primera-csp.yaml
473-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/3par-primera-crd.yaml
499+
```text fct_label="HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR"
500+
kubectl -n hpe-storage apply -f yaml/csi-driver/edge/3par-primera-csp.yaml
474501
```
475502

476503
!!! important
477504
The above instructions assumes you have an array with a supported platform OS installed. Please see the requirements section of the respective [CSP](container_storage_provider/index.md).
478505

479506
Install the CSI driver:
480507

481-
```text fct_label="Kubernetes 1.29"
482-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-csi-k8s-1.29.yaml
483-
```
484-
485-
```text fct_label="Kubernetes 1.28"
486-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-csi-k8s-1.28.yaml
487-
```
488-
489-
```text fct_label="Kubernetes 1.27"
490-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-csi-k8s-1.27.yaml
491-
```
492-
493-
```text fct_label="Kubernetes 1.26"
494-
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-csi-k8s-1.26.yaml
508+
```text
509+
kubectl -n hpe-storage apply -f yaml/csi-driver/edge/hpe-csi-rbac.yaml
510+
kubectl -n hpe-storage apply -f yaml/csi-driver/edge/hpe-csi-controller.yaml
511+
kubectl -n hpe-storage apply -f yaml/csi-driver/edge/hpe-csi-node.yaml
495512
```
496513

497-
!!! seealso
498-
Older and unsupported versions of Kubernetes and the CSI driver are [archived on this page](install_legacy.md).
499-
500-
Depending on which version is being deployed, different API objects gets created. Next step: [Add an HPE Storage Backend](#add_an_hpe_storage_backend).
514+
Next step: [Add an HPE Storage Backend](#add_an_hpe_storage_backend).
501515

502516
## Advanced Uninstall
503517

504-
The following steps outline how to uninstall the CSI driver that has been deployed using the [Advanced Install](#advanced_install) above.
518+
The following steps outline how to uninstall the CSI driver that has been deployed using the [Advanced Install](#advanced_install) above and assumes the shell is in the "co-deployments" directory.
505519

506520
Uninstall Worker node settings:
507521

508522
```text
509-
kubectl delete -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-linux-config.yaml
523+
kubectl -n hpe-storage delete -f yaml/csi-driver/edge/hpe-linux-config.yaml
510524
```
511525

512526
Uninstall relevant Container Storage Provider:
513527

514528
```text fct_label="HPE Alletra 5000/6000 and Nimble Storage"
515-
kubectl delete -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/nimble-csp.yaml
529+
kubectl -n hpe-storage delete -f yaml/csi-driver/edge/nimble-csp.yaml
516530
```
517531

518532
```text fct_label="HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR"
519-
kubectl delete -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/3par-primera-csp.yaml
533+
kubectl -n hpe-storage delete -f yaml/csi-driver/edge/3par-primera-csp.yaml
520534
```
521535

522-
!!! error "HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR users"
523-
If you are reinstalling the HPE CSI Driver, **DO NOT** remove the `crd/hpevolumeinfos.storage.hpe.com` resource. This `CustomResourceDefinition` contains important volume metadata used by the HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR CSP. HPE CSI Driver **v2.0.0 and below** share the same YAML file for `crds` and CSP and would require a manual removal of the individual `Service` and `Deployment` in the "hpe-storage" `Namespace`.
524-
525536
Uninstall the CSI driver:
526537

527-
```text fct_label="Kubernetes 1.29"
528-
kubectl delete -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-csi-k8s-1.29.yaml
529-
```
530-
531-
```text fct_label="Kubernetes 1.28"
532-
kubectl delete -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-csi-k8s-1.28.yaml
533-
```
534-
535-
```text fct_label="Kubernetes 1.27"
536-
kubectl delete -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-csi-k8s-1.27.yaml
537-
```
538-
539-
```text fct_label="Kubernetes 1.26"
540-
kubectl delete -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/hpe-csi-k8s-1.26.yaml
538+
```text
539+
kubectl -n hpe-storage delete -f yaml/csi-driver/edge/hpe-csi-controller.yaml
540+
kubectl -n hpe-storage delete -f yaml/csi-driver/edge/hpe-csi-node.yaml
541+
kubectl -n hpe-storage delete -f yaml/csi-driver/edge/hpe-csi-rbac.yaml
541542
```
542543

543544
If no longer needed, delete the "hpe-storage" `Namespace`.
@@ -546,6 +547,9 @@ If no longer needed, delete the "hpe-storage" `Namespace`.
546547
kubectl delete ns hpe-storage
547548
```
548549

550+
!!! error "HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR users"
551+
If you are reinstalling the HPE CSI Driver, **DO NOT** remove the `crd/hpevolumeinfos.storage.hpe.com` resource. This `CustomResourceDefinition` contains important volume metadata used by the HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR CSP.
552+
549553
## Downgrading the CSI driver
550554

551555
Downgrading the CSI driver is currently not supported. It will work between certain minor versions. HPE does not test or document procedures to downgrade between incompatible versions.

0 commit comments

Comments
 (0)