refactor: enhance instance persistent volume type

Signed-off-by: thxCode <thxcode0824@gmail.com>

Author: thxCode

api/worker/v1/generated.pb.go

@@ -56,7 +56,7 @@ type NFSInstancePersistentVolumeSource struct {
 	// +required
 	Server string `json:"server" protobuf:"bytes,1,name=server"`
 
-	// Path is the exported NFS share from the server.
+	// Share is the path of NFS share from the server.
 	// For each InstancePersistentVolume,
 	// a corresponding subpath will be created in the NFS share.
 	//
@@ -65,12 +65,31 @@ type NFSInstancePersistentVolumeSource struct {
 	// +default="/"
 	// +k8s:validation:pattern="^(/[^/]+)+$"
 	// +k8s:validation:maxLength=1024
-	Path string `json:"path,omitempty" protobuf:"bytes,2,opt,name=path"`
+	Share string `json:"path,omitempty" protobuf:"bytes,2,opt,name=path"`
+
+	// SubDirectory is the subdirectory in the NFS share for each InstancePersistentVolume.
+	// If it is blank, the subdirectory will be the same as the volume ID of the InstancePersistentVolume.
+	//
+	// It supports a specific string or the following template variables:
+	// - `${pvc.metadata.name}`: the name the corresponding PersistentVolumeClaim.
+	// - `${pvc.metadata.namespace}`: the namespace of the corresponding PersistentVolumeClaim.
+	// - `${pv.metadata.name}`: the name of the corresponding Kubernetes PersistentVolume.
+	//
+	// For example, specify `${pvc.metadata.namespace}/${pvc.metadata.name}` to create a subdirectory
+	// with the namespaced name of the corresponding PersistentVolumeClaim in the NFS share
+	// for each InstancePersistentVolume.
+	//
+	// Immutable after creation.
+	SubDirectory string `json:"subDirectory,omitempty" protobuf:"bytes,3,opt,name=subDirectory"`
+
+	// MountPermissions is the mounted directory permissions.
+	// If it is non-zero, perform a chmod with the specified permissions after mounted.
+	MountPermissions string `json:"mountPermissions,omitempty" protobuf:"bytes,4,opt,name=mountPermissions"`
 
 	// MountOptions is the mount options for the NFS share.
 	//
 	// +default=["hard","nfsvers=4.1","rsize=1048576","wsize=1048576","noatime","nodiratime"]
-	MountOptions []string `json:"mountOptions,omitempty" protobuf:"bytes,3,opt,name=mountOptions"`
+	MountOptions []string `json:"mountOptions,omitempty" protobuf:"bytes,5,opt,name=mountOptions"`
 }
 
 // S3InstancePersistentVolumeSource defines the source of S3.

api/worker/v1/generated.proto

@@ -2,6 +2,7 @@ API rule violation: list_type_missing,gpustack.ai/gpustack/api/worker/v1,Instanc
 API rule violation: list_type_missing,gpustack.ai/gpustack/api/worker/v1,NFSInstancePersistentVolumeSource,MountOptions
 API rule violation: list_type_missing,gpustack.ai/gpustack/api/worker/v1,S3InstancePersistentVolumeSource,MountOptions
 API rule violation: list_type_missing,gpustack.ai/gpustack/api/worker/v1alpha1,Accelerator,PhysicalIndexes
+API rule violation: names_match,gpustack.ai/gpustack/api/worker/v1,NFSInstancePersistentVolumeSource,Share
 API rule violation: names_match,gpustack.ai/gpustack/api/worker/v1alpha1,AcceleratorFeatures,RoCE
 API rule violation: names_match,gpustack.ai/gpustack/api/worker/v1alpha1,DeviceTopology,PciBusID
 API rule violation: names_match,gpustack.ai/gpustack/api/worker/v1alpha1,DeviceTopology,PciRootID

api/worker/v1/instance_persistent_volume_type.go

@@ -339,6 +339,12 @@ RUN skopeo copy docker://registry.k8s.io/kueue/kueue:v0.17.2 oci-archive:${GPUST
 ADD https://github.com/kubernetes-sigs/node-feature-discovery/releases/download/v0.18.3/node-feature-discovery-chart-0.18.3.tgz "${GPUSTACK_CHARTS_DIR}/node-feature-discovery-0.18.3.tgz"
 RUN skopeo copy docker://registry.k8s.io/nfd/node-feature-discovery:v0.18.3 oci-archive:${GPUSTACK_IMAGES_DIR}/node-feature-discovery-v0.18.3.tar
 
+## CSI Driver NFS
+ADD https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/refs/heads/master/charts/v4.13.2/csi-driver-nfs-4.13.2.tgz "${GPUSTACK_CHARTS_DIR}/csi-driver-nfs-4.13.2.tgz"
+
+## CSI Driver S3
+ADD https://yandex-cloud.github.io/k8s-csi-s3/charts/csi-s3-0.43.7.tgz "${GPUSTACK_CHARTS_DIR}/csi-driver-s3-0.43.7.tgz"
+
 # Prepare
 
 ## Build Context

api/worker/zz_generated.openapi.go

@@ -15,7 +15,6 @@ import (
 	klog "k8s.io/klog/v2"
 	"sigs.k8s.io/yaml"
 
-	"gpustack.ai/gpustack/pkg/system"
 	"gpustack.ai/gpustack/pkg/utils/bytex"
 	"gpustack.ai/gpustack/pkg/utils/osx"
 )
@@ -35,15 +34,18 @@ type (
 		DownloadURL string
 		// Values is the values to be passed to the chart.
 		Values ChartValues
-		// DisableCRDValidation disables the validation of CRDs during installation.
-		DisabledInstallCRDs bool
-		// DisableInstallIfApiServiceReady is the APIService name,
+		// SkippedCRDsInstallation defines whether to skip the installation of CRDs of this chart.
+		//
+		// Sometimes, the cluster has already installed the CRDs of the same API,
+		// this function is a chance to disable the installation of CRDs on this fresh installation.
+		SkippedCRDsInstallation bool
+		// SkippedInstallationIfApiServiceReady is the APIService name,
 		// if specified, the installation will be skipped if an APIService with this name already exists in the cluster.
 		//
 		// Sometimes, the cluster has already installed a same chart but not the same release,
 		// this function is a chance to check whether to continue installation on this fresh installation,
 		// or just skip.
-		DisableInstallIfApiServiceReady string
+		SkippedInstallationIfApiServiceReady string
 	}
 
 	ChartValues interface {
@@ -69,19 +71,21 @@ func (ch Chart) Validate() error {
 // Load loads the chart from local path or remote URL.
 func (ch Chart) Load(_ context.Context, cfg *helmaction.Configuration) (*helmchart.Chart, error) {
 	f := ch.Path
-	if f != "" && !osx.Exists(f) {
+	if f != "" && osx.IsEmptyFile(f) {
 		f = ""
 	}
 
 	if f == "" {
-		f = filepath.Join(system.SubConfDir("charts/"+ch.Version), ch.Name)
-		if osx.IsEmptyDir(f) {
+		if ch.DownloadURL == "" {
+			return nil, fmt.Errorf("chart path %s is not existed and download URL is not provided", ch.Path)
+		}
+		_, fn := filepath.Split(ch.DownloadURL)
+		f = filepath.Join(filepath.Dir(ch.Path), fn)
+		if osx.IsEmptyFile(f) {
 			p := helmaction.NewPullWithOpts(helmaction.WithConfig(cfg))
 			p.Settings = cli.New()
 			p.Version = ch.Version
-			p.Untar = true
-			p.UntarDir = filepath.Dir(f)
-
+			p.DestDir = filepath.Dir(ch.Path)
 			pr, err := p.Run(ch.DownloadURL)
 			if err != nil {
 				return nil, fmt.Errorf("pull chart from %s: %s: %w", ch.DownloadURL, pr, err)

api/worker/zz_generated.openapi.violation_exceptions

@@ -198,7 +198,7 @@ func (c *Client) InstallWith(
 		n := _NextStepInstall
 		if r != nil {
 			n = next(r)
-		} else if isApiServiceReady(ctx, c, chart.DisableInstallIfApiServiceReady) {
+		} else if isApiServiceReady(ctx, c, chart.SkippedInstallationIfApiServiceReady) {
 			return nil, nil
 		}
 
@@ -255,7 +255,7 @@ func (c *Client) InstallWith(
 			i.ReleaseName = chart.Release
 			i.Namespace = namespace
 			i.Atomic = true
-			i.IncludeCRDs = !chart.DisabledInstallCRDs
+			i.IncludeCRDs = !chart.SkippedCRDsInstallation
 			ch, err := chart.Load(ctx, config)
 			if err != nil {
 				return nil, fmt.Errorf("helm install: load chart: %w", err)