|
| 1 | +# Hitachi Storage Plug-in for Containers |
| 2 | + |
| 3 | +Hitachi Storage Plug-in for Containers lets you create containers and run stateful applications |
| 4 | +inside those containers by using the Hitachi storage volumes as dynamically provisioned |
| 5 | +persistent volumes. |
| 6 | + |
| 7 | + |
| 8 | +## Prerequisites |
| 9 | + |
| 10 | +- A Hitachi Virtual Storage Platform (VSP) array. |
| 11 | + |
| 12 | + |
| 13 | +## Parameters |
| 14 | + |
| 15 | +To deploy the Hitachi HSPC pack, you need to set, at minimum, the following parameters in the pack's YAML. |
| 16 | + |
| 17 | +| Name | Description | Type | Default Value | Required | |
| 18 | +| --- | --- | --- | --- | --- | |
| 19 | +| `hspc.vsp.url` | The URL of your Hitachi VSP management endpoint. | String | - | Yes | |
| 20 | +| `hspc.vsp.user` | The username of a Hitachi VSP account with appropriate permissions. | String | - | Yes | |
| 21 | +| `hspc.vsp.password` | The password of a Hitachi VSP account with appropriate permissions. | String | - | Yes | |
| 22 | +| `hspc.storageClass.parameters.serialNumber` | The serial number of the VSP storage chassis. | String | - | Yes | |
| 23 | +| `hspc.storageClass.parameters.poolID` | The HDP Pool ID (omit for VSP One SDS Block). | String | - | Yes | |
| 24 | +| `hspc.storageClass.parameters.portID` | The port ID (omit for VSP One SDS Block). Use a comma separator for multipath. If an NVMe over FC is used, don't set this option. | String | - | Yes | |
| 25 | +| `hspc.storageClass.parameters.connectionType` | Storage connection type. fc, iscsi, and nvme-fc are supported. Defaults to fc if not set. | String | fc | No | |
| 26 | +| `hspc.storageClass.parameters.storageEfficiency` | Adaptive data reduction. "Compression", "CompressionDeduplication", and "Disabled" are supported. | String | - | Yes | |
| 27 | +| `hspc.storageClass.parameters.storageEfficiencyMode` | Compression execution mode. "Inline" and "PostProcess" are supported. | String | - | No | |
| 28 | +| `hspc.storageClass.parameters.storageType` | For VSP One SDS Block, set the "storagetype" parameter to "vsp-one-sds-block". | String | - | No | |
| 29 | +| `hspc.storageClass.parameters.csi.storage.k8s.io/fstype` | Filesystem type, ext4 and xfs are supported. Defaults to ext4 if not set. | String | ext4 | No | |
| 30 | + |
| 31 | + |
| 32 | +Review the [Hitachi Storage Plug-in for Containers Quick Reference Guide](https://docs.hitachivantara.com/v/u/en-us/adapters-and-drivers/3.16.x/mk-92adptr142) for more details on parameters. |
| 33 | + |
| 34 | +## Upgrade |
| 35 | + |
| 36 | +This pack deploys an operator, which takes care of phased upgrades |
| 37 | + |
| 38 | + |
| 39 | +## Usage |
| 40 | + |
| 41 | +To use the Hitachi Storage Plug-in for Containers pack, first create a new [infrastructure cluster profile](https://docs.spectrocloud.com/profiles/cluster-profiles/create-cluster-profiles/create-infrastructure-profile/), select MAAS for the Infrastructure Provider and when you get to the Storage pack, search for the **Hitachi Storage Plug-in for Containers** pack in the Palete Community Registry. Then configure the `hspc.vsp` and `hspc.storageClass` sections in the pack YAML: |
| 42 | + |
| 43 | +```yaml |
| 44 | +charts: |
| 45 | + hspc: |
| 46 | + ... |
| 47 | + vsp: |
| 48 | + url: http://172.16.1.1 |
| 49 | + user: "User01" |
| 50 | + password: "*******" |
| 51 | + storageClass: |
| 52 | + name: spectro-storage-class |
| 53 | + isDefaultStorageClass: true |
| 54 | + allowVolumeExpansion: true |
| 55 | + reclaimPolicy: Delete |
| 56 | + volumeBindingMode: Immediate |
| 57 | + parameters: |
| 58 | + serialNumber: "54321" |
| 59 | + poolID: "1" |
| 60 | + portID : CL1-A,CL2-A |
| 61 | + connectionType: fc |
| 62 | + storageEfficiency: "CompressionDeduplication" |
| 63 | + storageEfficiencyMode: "Inline" |
| 64 | +``` |
| 65 | +
|
| 66 | +Once you have confiogured the pack, you can deploy a cluster with it. |
| 67 | +
|
| 68 | +In order to use this CSI for snapshots, the following `VolumeSnapshotClass` can be created (manually, not part of this pack): |
| 69 | +``` |
| 70 | +apiVersion: snapshot.storage.k8s.io/v1 |
| 71 | +kind: VolumeSnapshotClass |
| 72 | +metadata: |
| 73 | + name: hspc-snapshotclass |
| 74 | +driver: hspc.csi.hitachi.com |
| 75 | +deletionPolicy: Delete |
| 76 | +parameters: |
| 77 | + poolID: "1" |
| 78 | + csi.storage.k8s.io/snapshotter-secret-name: "hspc-secret" |
| 79 | + csi.storage.k8s.io/snapshotter-secret-namespace: "hspc-system" |
| 80 | +``` |
| 81 | +
|
| 82 | +## References |
| 83 | +
|
| 84 | +- [Hitachi Vantara website](https://www.hitachivantara.com/) |
| 85 | +- [Hitachi HSPC Quick Reference Guide](https://docs.hitachivantara.com/v/u/en-us/adapters-and-drivers/3.16.x/mk-92adptr142) |
0 commit comments