Overview¶
The HPE COSI Driver for Kubernetes is deployed by using industry standard means, a Helm chart.
Delivery Vehicles¶
Helm is currently the only supported delivery vehicle for the deployment of the HPE COSI Driver.
Helm¶
Helm is the package manager for Kubernetes. Software is being delivered in a format designated as a "chart". Helm is a standalone CLI that interacts with the Kubernetes API server using your KUBECONFIG
file.
The official Helm chart for the HPE COSI Driver for Kubernetes is hosted on Artifact Hub. The chart supports Helm 3 from version 1.0.0 of the HPE COSI Driver. In an effort to avoid duplicate documentation, please see the chart for instructions on how to deploy the COSI driver using Helm.
- Go to the chart on Artifact Hub.
Add an HPE Storage Backend¶
Once the COSI driver is deployed, you must create a Secret
with the following details before you can use the COSI API resources.
Secret Parameters¶
All parameters are mandatory and described below.
Parameter | Description |
---|---|
accessKey | The access key of the S3 user with bucket creation, bucket-tagging and deletion permissions. |
secretKey | The secret key for the S3 user who has bucket creation, bucket-tagging and deletion permissions. |
endpoint | The S3 frontend network DNS subdomains address of the backend object storage system; that is, an HPE Alletra Storage MP X10000 system. |
glcpUserClientId | The HPE Green Lake API client ID. |
glcpUserSecretKey | The HPE Green Lake API client secret. |
dsccZone | The fully qualified domain name (FQDN) of the HPE Data Services Cloud Console zone. |
clusterSerialNumber | The backend storage system cluster serial number. |
Note
The Kubernetes compute nodes where the HPE COSI Driver is allowed to run need to be able to access the Data Services Cloud Console zone specified.
Example Secret
manifest named "hpe-object-backend.yaml":
apiVersion: v1
kind: Secret
metadata:
name: hpe-object-backend
namespace: default
stringData:
accessKey: testuser
secretKey: testkey
endpoint: http://192.168.1.100:8080
glcpUserClientId: 00000000-0000-0000-0000-000000000000
glcpUserSecretKey: 00000000000000000000000000000000
dsccZone: us1.data.cloud.hpe.com
clusterSerialNumber: 0000000000
Create the Secret
.
kubectl create -f hpe-object-backend.yaml
See Also
The COSI source code repository contains a parameterized script that can assist in creating a correctly formatted Secret
. See github.com/hpe-storage/cosi-driver/scripts/cosi_secret for more details.
Creating and Locating Resources¶
- To create the S3 user:
- Follow the steps in the HPE documentation to create an access policy.
- Choose All Buckets.
- Add custom actions for the policy:
CreateBucket
,DeleteBucket
,PutBucketTagging
.
- To create the user, refer to the HPE documentation for this purpose and select the access policy created in the previous step.
- Save the user name and password. These will be used as the S3 access key and S3 secret key respectively in the COSI secret.
- Follow the steps in the HPE documentation to create an access policy.
- To create the HPE Green Lake API client ID and secret, refer to the following HPE documentation.
- To locate the Data Services Cloud Console zone FQDN:
- Log into HPE Data Services Cloud Console.
- On the Services page, click My Services to view all services available in your workspace.
- Select the service that your HPE Alletra Storage MP X10000 device is assigned to and click Launch.
- After the service is launched, save the value of the URL from the browser. E.g.:
https://console-us1.data.cloud.hpe.com
. - After dropping the prefix
https://console-
, the Data Services Cloud Console zone FQDN value to be used in theSecret
should have the following format:us1.data.cloud.hpe.com
. - Supported Data Services Cloud Console zone FQDNs as of January 2025 are:
- us1.data.cloud.hpe.com
- jp1.data.cloud.hpe.com
- eu1.data.cloud.hpe.com
- uk1.data.cloud.hpe.com
- To locate the S3 endpoint:
- Log into HPE Data Services Cloud Console.
- Launch the service that your HPE Alletra Storage MP X10000 device is assigned to.
- Select Data Ops Manager.
- From the menu on the left, select Systems. From the list click on the name of the system you want to use for COSI operations.
- Click on the Networking tab. Under the Frontend Network section, save the value of the Network DNS Subdomains field.
- The S3 endpoint can be constructed from the Network DNS Subdomains value by using the format:
http://<Network DNS Subdomains>
.
- To locate the cluster serial number of the HPE Alletra Storage MP X10000 system, refer to the following HPE documentation.
Tip
In a real world scenario it's more practical to name the Secret
something that makes sense for the organization. It could be the hostname of the backend or the role it carries; i.e., "hpe-alletra-sanjose-prod".
Next Steps¶
Next you need to create a BucketClass.