Skip to content

Commit

Permalink
Virtual Domain docs, rebrand and others (#218)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Mattsson <[email protected]>
  • Loading branch information
datamattsson authored Dec 4, 2024
1 parent 551c01a commit a5c78f8
Show file tree
Hide file tree
Showing 12 changed files with 65 additions and 37 deletions.
Original file line number Diff line number Diff line change
@@ -1,32 +1,29 @@
# Introduction

The HPE Alletra Storage MP, Alletra 9000 and Primera and 3PAR Storage Container Storage Provider (CSP) for Kubernetes is part of the [HPE CSI Driver for Kubernetes](../../csi_driver/index.md). The CSP abstract the data management capabilities of the array for use by Kubernetes.

!!! note
The HPE CSI Driver for Kubernetes is only compatible with HPE Alletra Storage MP running with block services, such as HPE GreenLake for Block Storage.
The HPE Alletra Storage MP B10000, Alletra 9000 and Primera and 3PAR Storage Container Storage Provider (CSP) for Kubernetes is part of the [HPE CSI Driver for Kubernetes](../../csi_driver/index.md). The CSP abstract the data management capabilities of the array for use by Kubernetes.

[TOC]

!!! note
For help getting started with deploying the HPE CSI Driver using HPE Alletra Storage MP, Alletra 9000, Primera or 3PAR storage, check out the [tutorial over at HPE Developer](https://developer.hpe.com/blog/9o7zJkqlX5cErkrzgopL/tutorial-how-to-get-started-with-the-hpe-csi-driver-and-hpe-primera-and-).
For help getting started with deploying the HPE CSI Driver using HPE Alletra Storage MP B10000, Alletra 9000, Primera or 3PAR storage, check out the [tutorial over at HPE Developer](https://developer.hpe.com/blog/9o7zJkqlX5cErkrzgopL/tutorial-how-to-get-started-with-the-hpe-csi-driver-and-hpe-primera-and-).

## Platform Requirements

Check the corresponding CSI driver version in the [compatibility and support](../../csi_driver/index.md#compatibility_and_support) table for the latest updates on supported Kubernetes version, orchestrators and host OS.
<!-- Refer to the HPE Single Point of Connectivity Knowledge (SPOCK) for specific platform details (requires an HPE Passport account) of the CSP. The documentation reflected here always corresponds to the latest supported version and may contain references to future features and capabilities.
* [HPE Alletra Storage MP](https://h20272.www2.hpe.com/SPOCK/Pages/spock2Html.aspx?htmlFile=hw_greenlake_block.html)
* [HPE Alletra Storage MP B10000](https://h20272.www2.hpe.com/SPOCK/Pages/spock2Html.aspx?htmlFile=hw_greenlake_block.html)
* [HPE Alletra 9000](https://h20272.www2.hpe.com/SPOCK/Pages/spock2Html.aspx?htmlFile=hw_alletra.html)
* [HPE Primera](https://h20272.www2.hpe.com/SPOCK/Pages/spock2Html.aspx?htmlFile=hw_primera.html)
* [HPE 3PAR](https://h20272.www2.hpe.com/SPOCK/Pages/spock2Html.aspx?htmlFile=hw_3par.html) -->

### Network Port Requirements

The HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR Container Storage Provider requires the following TCP ports to be open inbound to the array from the Kubernetes cluster worker nodes running the HPE CSI Driver for Kubernetes.
The HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR Container Storage Provider requires the following TCP ports to be open inbound to the array from the Kubernetes cluster worker nodes running the HPE CSI Driver for Kubernetes.

| Port | Protocol | Description |
| ---- | -------- | ----------- |
| 443 | HTTPS | WSAPI (HPE Alletra Storage MP, Alletra 9000/Primera) |
| 443 | HTTPS | WSAPI (HPE Alletra Storage MP B10000, Alletra 9000/Primera) |
| 8080 | HTTPS | WSAPI (HPE 3PAR) |
| 22 | SSH | Array communication |

Expand All @@ -41,6 +38,35 @@ The CSP requires access to a local user with either `edit` or the `super` role.

Virtual Domains are not yet fully supported by the CSP. From HPE CSI Driver v2.5.0, it's possible to manually create the Kubernetes hosts connecting to storage within the Virtual Domain. Once the hosts have been created, deploy the CSI driver with the Helm chart using the "disableHostDeletion" parameter set to "true". The Virtual Domain user may create the hosts through the Virtual Domain if the "AllowDomainUsersAffectNoDomain" parameter is set to either "hostonly" or "yes" on the array.

#### Detailed steps to use Virtual Domains

These steps assumes access to the storage platform with privileges to create domains and change settings.

Login to the storage platform with SSH. Create an new domain:

```text
cli% createdomain -comment "This is a test domain." my-kubernetes-domain-0
```

Then, create a new user and assign to the domain. These credentials will be used by the CSI driver.

```text
cli% createuser -c my-password-0 domain-user-0 my-kubernetes-domain-0 edit
```

Next, make sure domain users are allowed to create hosts outside the domain.

```text
cli% setsys AllowDomainUsersAffectNoDomain hostonly
```

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.

- Helm chart install from [ArtifactHub.io](https://artifacthub.io/packages/helm/hpe-storage/hpe-csi-driver).
- Operator install for [OpenShift](../../partners/redhat_openshift/index.md).

Once the CSI driver is installed and running, [add an HPE storage backend](../../csi_driver/deployment.md#add_an_hpe_storage_backend) with the credentials provided in the steps above.

!!! note
Remote Copy Groups managed by the CSP have not been tested with Virtual Domains at this time.

Expand Down Expand Up @@ -401,4 +427,4 @@ These are the current limitations of the Remote Copy Peer Persistence integratio

## Support

Please refer to the HPE Alletra Storage MP, Alletra 9000 and Primera and 3PAR Storage CSP [support statement](../../legal/support/index.md#hpe_primera_and_hpe_3par_container_storage_provider_support).
Please refer to the HPE Alletra Storage MP B10000, Alletra 9000 and Primera and 3PAR Storage CSP [support statement](../../legal/support/index.md#hpe_primera_and_hpe_3par_container_storage_provider_support).
2 changes: 1 addition & 1 deletion docs/container_storage_provider/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Container Storage Providers

* [HPE Alletra 5000/6000 and Nimble Storage](hpe_alletra_6000/index.md)
* [HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR](hpe_alletra_storage_mp/index.md)
* [HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR](hpe_alletra_storage_mp_b10000/index.md)
12 changes: 6 additions & 6 deletions docs/csi_driver/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ All parameters are mandatory and described below.

Example:

```yaml fct_label="HPE Alletra Storage MP"
```yaml fct_label="HPE Alletra Storage MP B10000"
apiVersion: v1
kind: Secret
metadata:
Expand Down Expand Up @@ -290,7 +290,7 @@ This `Secret` is used by the CSI sidecars in the `StorageClass` to authenticate

To create a new `Secret`, specify the name, `Namespace`, backend username, backend password and the backend IP address to be used by the CSP and save it as `custom-secret.yaml` (a detailed description of the parameters are [available above](#secret_parameters)).

```yaml fct_label="HPE Alletra Storage MP"
```yaml fct_label="HPE Alletra Storage MP B10000"
apiVersion: v1
kind: Secret
metadata:
Expand Down Expand Up @@ -468,7 +468,7 @@ Container Storage Provider:
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/nimble-csp.yaml
```

```text fct_label="HPE Alletra Storage MP, HPE Alletra 9000, Primera and 3PAR"
```text fct_label="HPE Alletra Storage MP B10000, HPE Alletra 9000, Primera and 3PAR"
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/3par-primera-csp.yaml
kubectl apply -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/3par-primera-crd.yaml
```
Expand Down Expand Up @@ -515,12 +515,12 @@ Uninstall relevant Container Storage Provider:
kubectl delete -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.4.2/nimble-csp.yaml
```

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

!!! error "HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR users"
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, 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`.
!!! error "HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR users"
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`.

Uninstall the CSI driver:

Expand Down
4 changes: 2 additions & 2 deletions docs/csi_driver/diagnostics.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ hpe-storage hpe-csi-node-pwq2d 2/2 Running 0
hpe-storage nimble-csp-546c9c4dd4-5lsdt 1/1 Running 0 15s
```

```text fct_label="HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR"
```text fct_label="HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR"
kubectl get pods --all-namespaces -l 'app in (primera3par-csp, hpe-csi-node, hpe-csi-controller)'
NAMESPACE NAME READY STATUS RESTARTS AGE
hpe-storage hpe-csi-controller-7d9cd6b855-fqppd 9/9 Running 0 14s
Expand Down Expand Up @@ -170,7 +170,7 @@ CSP logs can be accessed from their respective services.
kubectl logs -f deploy/nimble-csp -n hpe-storage
```

```text fct_label="HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR"
```text fct_label="HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR"
kubectl logs -f deploy/primera3par-csp -n hpe-storage
```

Expand Down
2 changes: 1 addition & 1 deletion docs/csi_driver/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Upgrade considerations:

* Existing claims provisioned with the NFS Server Provisioner [needs to be upgraded](operations.md#upgrade_to_v250).
* Current users of CHAP needs to review the [iSCSI CHAP Considerations](#iscsi_chap_considerations)
* The `importVol` parameter has been renamed `importVolumeName` for [HPE Alletra Storage MP and Alletra 9000/Primera/3PAR](../container_storage_provider/hpe_alletra_storage_mp/index.md)
* The `importVol` parameter has been renamed `importVolumeName` for [HPE Alletra Storage MP and Alletra 9000/Primera/3PAR](../container_storage_provider/hpe_alletra_storage_mp_b10000/index.md)

!!! caution "note"
HPE CSI Driver v2.5.0 is deployed with **v2.5.1** of the Helm chart and Operator
Expand Down
2 changes: 1 addition & 1 deletion docs/csi_driver/using.md
Original file line number Diff line number Diff line change
Expand Up @@ -1126,7 +1126,7 @@ Any workload provisioning `PVCs` from the above `StorageClass` will now be sched
How to map an existing backend volume to a `PersistentVolume` differs between the CSP implementations.

- [HPE Alletra 5000/6000 and Nimble Storage](../container_storage_provider/hpe_alletra_6000/index.md#static_provisioning)
- [HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR](../container_storage_provider/hpe_alletra_storage_mp/index.md#static_provisioning)
- [HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR](../container_storage_provider/hpe_alletra_storage_mp_b10000/index.md#static_provisioning)

## Further Reading

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
-->
## HPE Storage Container Orchestrator Documentation

This is an umbrella documentation project for the HPE CSI Driver for Kubernetes and neighboring ecosystems for HPE primary storage including HPE Alletra Storage MP, Alletra 9000, Alletra 5000/6000, Nimble Storage, Primera and 3PAR storage systems. The documentation is tailored for IT Ops, developers and technology partners.
This is an umbrella documentation project for the HPE CSI Driver for Kubernetes and neighboring ecosystems for HPE primary storage including HPE Alletra Storage MP B10000, Alletra 9000, Alletra 5000/6000, Nimble Storage, Primera and 3PAR storage systems. The documentation is tailored for IT Ops, developers and technology partners.

![HPE CSI Driver for Kubernetes](img/csi-driver-overview.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/legal/support/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Example cases where support may not be possible include:

<small>* = In the event where other vendors need to be consulted, the HPE Nimble Support team will not disengage from the Support Action. HPE Nimble Support will continue to partner with the customer and other vendors to search for the correct answers to the issue.</small>

### HPE Alletra Storage MP, Alletra 9000 and Primera and 3PAR Container Storage Provider support
### HPE Alletra Storage MP B10000, Alletra 9000 and Primera and 3PAR Container Storage Provider support

Limited to the HPE Alletra Storage MP, Alletra 9000 and Primera and 3PAR Storage Container Storage Provider (CSP) only. Best effort support is available for the CSP for HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR Storage with All-inclusive Single or Multi-System software and an active HPE Pointnext support agreement. Since HPE Pointnext support for the CSP is best effort only, any other support levels like Warranty, Foundation Care, Proactive Care, Proactive Care Advanced and Datacenter Care or other support levels do not apply. Best effort response times are based on local standard business days and working hours. If your location is outside the customary service zone, response time may be longer.
Limited to the HPE Alletra Storage MP B10000, Alletra 9000 and Primera and 3PAR Storage Container Storage Provider (CSP) only. Best effort support is available for the CSP for HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR Storage with All-inclusive Single or Multi-System software and an active HPE Pointnext support agreement. Since HPE Pointnext support for the CSP is best effort only, any other support levels like Warranty, Foundation Care, Proactive Care, Proactive Care Advanced and Datacenter Care or other support levels do not apply. Best effort response times are based on local standard business days and working hours. If your location is outside the customary service zone, response time may be longer.

| HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR Hardware Contract Type | Phone Number |
| HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR Hardware Contract Type | Phone Number |
| ----------------------------------------------------------------------------- | ------------ |
| **Warranty and Foundation Care** | 800-633-3600 |
| **Proactive Care (PC)** | 866-211-5211 |
Expand Down
10 changes: 5 additions & 5 deletions docs/partners/redhat_openshift/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,15 +191,15 @@ deployment "hpe-csi-driver-operator" successfully rolled out
The next step is to create a `HPECSIDriver` object.

```yaml fct_label="HPE CSI Operator v2.5.1"
# oc apply -f {{ config.site_url }}csi_driver/examples/deployment/hpecsidriver-v2.5.1-sample.yaml
# oc apply -n hpe-storage -f {{ config.site_url }}csi_driver/examples/deployment/hpecsidriver-v2.5.1-sample.yaml
{% include "../../csi_driver/examples/deployment/hpecsidriver-v2.5.1-sample.yaml" %}```

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

```yaml fct_label="v2.4.1"
# oc apply -f {{ config.site_url }}csi_driver/examples/deployment/hpecsidriver-v2.4.1-sample.yaml
# oc apply -n hpe-storage -f {{ config.site_url }}csi_driver/examples/deployment/hpecsidriver-v2.4.1-sample.yaml
{% include "../../csi_driver/examples/deployment/hpecsidriver-v2.4.1-sample.yaml" %}```

The CSI driver is now ready for use. Next, an [HPE storage backend needs to be added](../../csi_driver/deployment.md#add_an_hpe_storage_backend) along with a [`StorageClass`](../../csi_driver/using.md#base_storageclass_parameter).
Expand Down Expand Up @@ -314,9 +314,9 @@ oc get pvc -n openshift-virtualization-os-images -w
!!! hint
The "accessMode" transformation for block volumes from RWO PVC to RWX clone has been resolved in HPE CSI Driver v2.5.0. Regardless, using source RWX PVs will simplify the workflows for users.

# Live VM migrations for Alletra Storage MP
# Live VM migrations for Alletra Storage MP B10000

With HPE CSI Operator for Kubernetes v2.4.2 and older there's an issue that prevents live migrations of VMs that has `PVCs` attached that has been clones from an OS image residing on Alletra Storage MP backends including 3PAR, Primera and Alletra 9000.
With HPE CSI Operator for Kubernetes v2.4.2 and older there's an issue that prevents live migrations of VMs that has `PVCs` attached that has been clones from an OS image residing on Alletra Storage MP B10000 backends including 3PAR, Primera and Alletra 9000.

Identify the `PVC` that that has been cloned from an OS image. The VM name is "centos7-silver-bedbug-14" in this case.

Expand Down
4 changes: 2 additions & 2 deletions docs/partners/vmware/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ CNS fully supports Storage Policy-Based Management (SPBM) to provision volumes.

### Feature Comparison

Volume parameters available to the vSphere Container Storage Plug-in will be dependent upon options exposed through the vSphere SPBM and may not include all volume features available. Please refer to the [HPE Primera: VMware ESXi Implementation Guide](https://support.hpe.com/hpesc/public/docDisplay?docId=sd00001341en_us&docLocale=en_US&page=index.html) (includes HPE Alletra Storage MP, Alletra 9000 and 3PAR) or [VMware vSphere Virtual Volumes on HPE Nimble Storage Implementation Guide](https://www.hpe.com/psnow/doc/a00044881enw) (includes HPE Alletra 5000/6000 and dHCI) for list of available features.
Volume parameters available to the vSphere Container Storage Plug-in will be dependent upon options exposed through the vSphere SPBM and may not include all volume features available. Please refer to the [HPE Primera: VMware ESXi Implementation Guide](https://support.hpe.com/hpesc/public/docDisplay?docId=sd00001341en_us&docLocale=en_US&page=index.html) (includes HPE Alletra Storage MP B10000, Alletra 9000 and 3PAR) or [VMware vSphere Virtual Volumes on HPE Nimble Storage Implementation Guide](https://www.hpe.com/psnow/doc/a00044881enw) (includes HPE Alletra 5000/6000 and dHCI) for list of available features.

For a list of available volume parameters in the HPE CSI Driver for Kubernetes, refer to the respective [CSP](../../container_storage_provider/index.md).

Expand Down Expand Up @@ -38,7 +38,7 @@ For a list of available volume parameters in the HPE CSI Driver for Kubernetes,
<small>
<sup>1</sup> = Feature comparison based upon HPE CSI Driver for Kubernetes 2.4.0 and the vSphere Container Storage Plug-in 3.1.2<br />
<sup>2</sup> = HPE and VMware fully support features listed as GA for their respective CSI drivers.<br />
<sup>3</sup> = The HPE Remote Copy Peer Persistence feature of the HPE CSI Driver for Kubernetes is only available with HPE Alletra Storage MP, Alletra 9000, Primera and 3PAR storage systems.<br />
<sup>3</sup> = The HPE Remote Copy Peer Persistence feature of the HPE CSI Driver for Kubernetes is only available with HPE Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR storage systems.<br />
<sup>4</sup> = Peer Persistence is an HPE Storage specific platform feature that isn't abstracted up to the vSphere Container Storage Plug-in. Peer Persistence works with the vSphere Container Storage Plug-in when using VMFS datastores.
</small>

Expand Down
Loading

0 comments on commit a5c78f8

Please sign in to comment.