Merge pull request #3 from shafinhasnat/main

Helm chart v0.0.2, chart updated

Author: shahedex

.gitignore

@@ -5,5 +5,4 @@ dist/
 
 docker-compose.local.yml
 
-values.yaml
 dev-test/

README.md

@@ -23,15 +23,36 @@ Before you begin, ensure you have the following tools installed:
   go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest
   ```
 
-## Usage
+## Development
+
+Run `go mod tidy` before starting the gRPC server:
+
+```bash
+go run main.go start \
+  --endpoint="unix://tmp/csi-hyperstack.sock" \
+  --hyperstack-api-address="<API_BASE_URL>" \
+  --hyperstack-api-key="<API_KEY>" \
+  --service-controller-enabled \
+  --service-node-enabled
+```
+
+To list the available gRPC calls:
 
-You can install the Hyperstack CSI Driver using the provided Helm chart. Before that clone the repository.
+```bash
+grpcurl --plaintext unix:///tmp/csi-hyperstack.sock list
+```
+
+You can invoke a specific RPC method for a given operation using `grpcurl`.
 
+To build the project:
 
 ```bash
-helm upgrade --install csi-hyperstack --values ./deploy/helm/values.yaml -n csi-driver-test --create-namespace ./deploy/helm
+task build
 ```
-After installation, verify that all pods in the `csi-driver` namespace are running successfully. For example usage, please refer to [example/manifest](./example/manifest.yaml)
+
+## Usage
+
+Refer to the [charts/csi-hyperstack](./charts/csi-hyperstack/README.md) documentation for details on installation and usage with Helm.
 
 
 ## Documentation

charts/csi-hyperstack/Chart.yaml

@@ -3,5 +3,5 @@ name: csi-hyperstack
 description: |
   HELM chart for Hyperstack CSI drvier deployment
 type: application
-version: 0.0.1
+version: 0.0.2
 appVersion: 0.0.1

charts/csi-hyperstack/README.md

@@ -1,5 +1,4 @@
 # **CSI Hyperstack Helm Chart**  
-[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)  
 [![Helm](https://img.shields.io/badge/helm-chart-blue)](https://helm.sh/)  
 [![Kubernetes](https://img.shields.io/badge/kubernetes-1.24+-green)](https://kubernetes.io/)
 
@@ -9,19 +8,6 @@ This Helm chart simplifies installing, upgrading, and managing the CSI driver re
 
 ---
 
-## **Table of Contents**
-- [Overview](#overview)
-- [Features](#features)
-- [Prerequisites](#prerequisites)
-- [Installation](#installation)
-- [Upgrading](#upgrading)
-- [Uninstalling](#uninstalling)
-- [Configuration](#configuration)
-- [Development](#development)
-- [License](#license)
-
----
-
 ## **Overview**
 The **CSI Hyperstack Helm Chart** enables seamless integration between your **Kubernetes cluster** and **Hyperstack**.  
 It deploys all required CSI components, including:
@@ -36,7 +22,7 @@ It deploys all required CSI components, including:
 ✅ Deploys the **Hyperstack CSI driver**  
 ✅ Supports **dynamic volume provisioning**  
 ✅ Works with **Helm 3+**  
-✅ Kubernetes **1.24+** tested  
+✅ Kubernetes **1.24+**  
 ✅ Easily configurable via `values.yaml`
 
 ---
@@ -53,18 +39,18 @@ Before installing, ensure you have:
 
 ### **1. Add the Helm Repository**
 ```bash
-helm repo add nexgencloud https://nexgencloud.github.io/csi-hyperstack-helm-chart
+helm repo add nexgencloud https://nexgencloud.github.io/csi-hyperstack
 helm repo update
 ```
 
 ### **2. Install the Chart**
 ```bash
-helm install csi-hyperstack nexgencloud/csi-hyperstack-helm-chart   --namespace kube-system   --create-namespace
+helm install csi-hyperstack nexgencloud/csi-hyperstack --namespace kube-system --create-namespace --set hyperstack.apiKey=<YOUR_HS_API_KEY>
 ```
 
 ### **3. Verify Installation**
 ```bash
-kubectl get pods -n kube-system -l app.kubernetes.io/name=csi-hyperstack
+kubectl get pods -n kube-system
 ```
 
 You should see all CSI controller and node pods in **Running** state.
@@ -75,7 +61,7 @@ You should see all CSI controller and node pods in **Running** state.
 To upgrade to the latest chart version:
 
 ```bash
-helm upgrade csi-hyperstack nexgencloud/csi-hyperstack-helm-chart   --namespace kube-system
+helm upgrade csi-hyperstack nexgencloud/csi-hyperstack --namespace kube-system
 ```
 
 ---
@@ -93,47 +79,32 @@ helm uninstall csi-hyperstack -n kube-system
 This chart supports custom configuration via a `values.yaml` file.  
 Here are the most commonly used options:
 
-| **Parameter**                 | **Description**                    | **Default**          |
-|------------------------------|------------------------------------|----------------------|
-| `controller.replicas`       | Number of controller replicas      | `2`                  |
-| `node.tolerations`          | Tolerations for node pods          | `[]`                 |
-| `storageClass.name`         | Default StorageClass name          | `hyperstack-csi`     |
-| `storageClass.reclaimPolicy`| PVC reclaim policy                 | `Delete`             |
-| `hyperstack.apiKey`         | API key for Hyperstack            | `""`                 |
-| `hyperstack.endpoint`      | Hyperstack API endpoint           | `""`                 |
+Mandetory value during chart installations.
 
-To override defaults:
+| Key                 | Type   | Description                                        | Example                            |
+| ------------------- | ------ | -------------------------------------------------- | ---------------------------------- |
+| `hyperstack.apiKey` | string | API key for authenticating with the Hyperstack API | `hyperstack.apiKey=abcd1234` |
+
+Other commonly used optional values
+
+| Key                              | Type   | Description                                                 | Default                           |
+| -------------------------------- | ------ | ----------------------------------------------------------- | ------------------------------------------- |
+| `components.csiHyperstack.tag`          | string | CSI Hyperstack Image tag                              | `latest` |
+| `hyperstack.apiAddress`          | string | Base URL of the Hyperstack API                              | `https://infrahub-api.nexgencloud.com/v1` |
+| `storageClass.enabled`           | bool   | Whether to create a default `StorageClass`                  | `true`                                      |
+| `storageClass.name`              | string | Name of the `StorageClass`                                  | `csi-hyperstack`                          |
+| `storageClass.volumeBindingMode` | string | Volume binding mode (`Immediate` or `WaitForFirstConsumer`) | `Immediate`                               |
+| `storageClass.reclaimPolicy`     | string | Reclaim policy (`Delete` or `Retain`)                       | `Delete`                                  |
 
-```bash
-helm install csi-hyperstack nexgencloud/csi-hyperstack-helm-chart   --namespace kube-system   --set hyperstack.apiKey=YOUR_API_KEY   --set hyperstack.endpoint=https://infrahub-api.nexgencloud.com
-```
 
 ---
 
 ## **Development**
 If you want to make changes to the chart:
 
 ```bash
-# Clone the repository
-git clone https://github.com/NexGenCloud/csi-hyperstack-helm-chart.git
-cd csi-hyperstack-helm-chart
-
 # Lint the chart
 helm lint .
-
 # Test install locally
-helm install csi-hyperstack ./ --dry-run --debug
-```
-
----
-
-## **License**
-This project is licensed under the **Apache 2.0 License**.  
-See [LICENSE](LICENSE) for details.
-
----
-
-## **Next Steps**
-- [Helm Documentation](https://helm.sh/docs/)
-- [Kubernetes CSI Docs](https://kubernetes-csi.github.io/docs/)
-- [NexGen Cloud Hyperstack](https://nexgencloud.com)
+helm install csi-hyperstack --set hyperstack.apiKey=<YOUR_HS_API_key> . --dry-run --debug
+```

charts/csi-hyperstack/templates/daemonset-node.yaml

@@ -14,16 +14,16 @@ spec:
       labels:
         {{- include "csi-hyperstack.selectorLabels" . | nindent 8 }}
     spec:
-      {{- if .Values.hyperstack.imagePullSecret }}
+      {{- if .Values.imagePullSecrets }}
       imagePullSecrets:
-        - name: {{ .Values.hyperstack.imagePullSecret }}
+        - name: {{ .Values.imagePullSecrets }}
       {{- end }}
       serviceAccountName: csi-hyperstack-node-sa
       hostNetwork: true
       containers:
         - name: csi-hyperstack-node
-          image: reg.digitalocean.ngbackend.cloud/hyperstack-csi-driver/csi:v0.0.1
-          imagePullPolicy: {{ .Values.components.csiHyperstack.imagePullPolicy }}
+          image: {{ .Values.components.csiHyperstack.image }}:{{ .Values.components.csiHyperstack.tag }}
+          imagePullPolicy: {{ .Values.components.csiHyperstack.imagePullPolicy}}
           securityContext:
             privileged: true
             runAsUser: 0
@@ -32,8 +32,8 @@ spec:
           args:
             - "start"
             - "--endpoint=unix:///csi/csi.sock"
-            - "--hyperstack-api-address={{ .Values.components.csiHyperstack.hyperstackApiAddress }}"
-            - "--hyperstack-api-key={{ .Values.components.csiHyperstack.hyperstackApiKey }}"
+            - "--hyperstack-api-address={{ .Values.hyperstack.apiKey }}"
+            - "--hyperstack-api-key={{ .Values.hyperstack.apiAddress }}"
             - "--service-node-enabled"
           env:
             - name: KUBE_NODE_NAME

charts/csi-hyperstack/templates/deployment-controller.yaml

@@ -15,15 +15,15 @@ spec:
       labels:
         {{- include "csi-hyperstack.selectorLabels" . | nindent 8 }}
     spec:
-      {{- if .Values.hyperstack.imagePullSecret }}
+      {{- if .Values.imagePullSecrets }}
       imagePullSecrets:
-        - name: {{ .Values.hyperstack.imagePullSecret }}
+        - name: {{ .Values.imagePullSecrets }}
       {{- end }}
       serviceAccountName: csi-hyperstack-controller-sa
       containers:
         - name: csi-hyperstack
-          image: reg.digitalocean.ngbackend.cloud/hyperstack-csi-driver/csi:v0.0.1
-          imagePullPolicy:  {{ .Values.components.csiHyperstack.imagePullPolicy }}
+          image: {{ .Values.components.csiHyperstack.image }}:{{ .Values.components.csiHyperstack.tag }}
+          imagePullPolicy: {{ .Values.components.csiHyperstack.imagePullPolicy }}
           command: ["csi-hyperstack"]
           args:
             - "start"
@@ -65,7 +65,6 @@ spec:
             - mountPath: /var/lib/kubelet/plugins
               mountPropagation: Bidirectional
               name: plugins-dir
-        {{- if .Values.components.csiAttacher.enabled }}
         - name: csi-attacher
           image: {{ .Values.components.csiAttacher.image }}
           args:
@@ -76,8 +75,6 @@ spec:
           volumeMounts:
             - mountPath: /csi
               name: socket-dir
-        {{- end }}
-        {{- if .Values.components.csiProvisioner.enabled }}
         - name: csi-provisioner
           image: {{ .Values.components.csiProvisioner.image }}
           args:
@@ -89,8 +86,6 @@ spec:
           volumeMounts:
             - mountPath: /csi
               name: socket-dir
-        {{- end }}
-        {{- if .Values.components.csiResizer.enabled }}
         - name: csi-resizer
           image: {{ .Values.components.csiResizer.image }}
           args:
@@ -101,8 +96,6 @@ spec:
           volumeMounts:
             - mountPath: /csi
               name: socket-dir
-        {{- end }}
-        {{- if .Values.components.csiSnapshotter.enabled }}
         - name: csi-snapshotter
           image: {{ .Values.components.csiSnapshotter.image }}
           args:
@@ -113,7 +106,6 @@ spec:
           volumeMounts:
             - mountPath: /csi
               name: socket-dir
-        {{- end }}
       volumes:
         - name: socket-dir
           hostPath:

charts/csi-hyperstack/values.yaml.exmple charts/csi-hyperstack/values.yamlcharts/csi-hyperstack/values.yaml.exmple renamed to charts/csi-hyperstack/values.yaml

@@ -1,30 +1,24 @@
 components:
   csiHyperstack:
     imagePullPolicy: Always
-    image: reg.digitalocean.ngbackend.cloud/hyperstack-csi-driver/csi:v0.0.1
+    image: ghcr.io/nexgencloud/csi-hyperstack/csi
+    tag: latest
   nodeDriverRegistrar:
-    enabled: true
     image: registry.k8s.io/sig-storage/csi-node-driver-registrar:v2.10.1
   csiAttacher:
-    enabled: true
     image: registry.k8s.io/sig-storage/csi-attacher:v4.6.1
   csiProvisioner:
-    enabled: true
     image: registry.k8s.io/sig-storage/csi-provisioner:v5.0.1
   csiResizer:
-    enabled: true
     image: registry.k8s.io/sig-storage/csi-resizer:v1.11.1
   csiSnapshotter:
-    enabled: true
     image: registry.k8s.io/sig-storage/csi-snapshotter:v8.0.1
 
 hyperstack:
-  apiKey: ""
-  apiAddress: ""
-  imagePullSecret: ""
+  apiAddress: "https://infrahub-api.nexgencloud.com/v1"
 
 storageClass:
   enabled: true
-  name: "
+  name: "csi-hyperstack"
   volumeBindingMode: "Immediate"
-  reclaimPolicy: "Delete"
+  reclaimPolicy: "Delete"