doc: document building the Chart

As part of #257 a new script introduced for building helm charts for release. This commit adds documentation for the script. Signed-off-by: faganihajizada <[email protected]>
NVIDIA · Mar 7, 2025 · be03e17 · be03e17
1 parent 6861583
commit be03e17
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/deployments/helm/nvidia-dra-driver-gpu/README.md b/deployments/helm/nvidia-dra-driver-gpu/README.md
@@ -2,7 +2,7 @@
 
 Dynamic Resource Allocation (DRA) for NVIDIA GPUs in Kubernetes
 
-![Version: v25.2.0](https://img.shields.io/badge/Version-v25.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v25.2.0](https://img.shields.io/badge/AppVersion-v25.2.0-informational?style=flat-square)
+![Version: v25.3.0](https://img.shields.io/badge/Version-v25.3.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v25.3.0](https://img.shields.io/badge/AppVersion-v25.3.0-informational?style=flat-square)
 
 ## Dynamic Resource Allocation (DRA) for NVIDIA GPUs in Kubernetes
 
@@ -29,6 +29,10 @@ $ helm upgrade -i --create-namespace --namespace nvidia nvidia-dra-driver-gpu .
 
 > Note: The controller is designed to run as a single instance per cluster. Please avoid running multiple instances of the controller in the same cluster at same time.
 
+## Building the Chart
+
+The [package-helm-charts.sh](./hack/package-helm-charts) helper script can be used to build the helm chart
+
 ## Values
 
 | Key | Type | Default | Description |

diff --git a/deployments/helm/nvidia-dra-driver-gpu/README.md.gotmpl b/deployments/helm/nvidia-dra-driver-gpu/README.md.gotmpl
@@ -28,6 +28,10 @@ $ helm upgrade -i --create-namespace --namespace nvidia nvidia-dra-driver-gpu .
 
 > Note: The controller is designed to run as a single instance per cluster. Please avoid running multiple instances of the controller in the same cluster at same time.
 
+## Building the Chart
+
+The [package-helm-charts.sh](./hack/package-helm-charts) helper script can be used to build the helm chart
+
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}