csi: add mount_options to volumes and volume requests (#7398)

Add mount_options to both the volume definition on registration and to the volume block in the group where the volume is requested. If both are specified, the options provided in the request replace the options defined in the volume. They get passed to the NodePublishVolume, which causes the node plugin to actually mount the volume on the host.

Individual tasks just mount bind into the host mounted volume (unchanged behavior). An operator can mount the same volume with different options by specifying it twice in the group context.

closes #7007

* nomad/structs/volumes: add MountOptions to volume request

* jobspec/test-fixtures/basic.hcl: add mount_options to volume block

* jobspec/parse_test: add expected MountOptions

* api/tasks: add mount_options

* jobspec/parse_group: use hcl decode not mapstructure, mount_options

* client/allocrunner/csi_hook: pass MountOptions through

client/allocrunner/csi_hook: add a VolumeMountOptions

client/allocrunner/csi_hook: drop Options

client/allocrunner/csi_hook: use the structs options

* client/pluginmanager/csimanager/interface: UsageOptions.MountOptions

* client/pluginmanager/csimanager/volume: pass MountOptions in capabilities

* plugins/csi/plugin: remove todo 7007 comment

* nomad/structs/csi: MountOptions

* api/csi: add options to the api for parsing, match structs

* plugins/csi/plugin: move VolumeMountOptions to structs

* api/csi: use specific type for mount_options

* client/allocrunner/csi_hook: merge MountOptions here

* rename CSIOptions to CSIMountOptions

* client/allocrunner/csi_hook

* client/pluginmanager/csimanager/volume

* nomad/structs/csi

* plugins/csi/fake/client: add PrevVolumeCapability

* plugins/csi/plugin

* client/pluginmanager/csimanager/volume_test: remove debugging

* client/pluginmanager/csimanager/volume: fix odd merging logic

* api: rename CSIOptions -> CSIMountOptions

* nomad/csi_endpoint: remove a 7007 comment

* command/alloc_status: show mount options in the volume list

* nomad/structs/csi: include MountOptions in the volume stub

* api/csi: add MountOptions to stub

* command/volume_status_csi: clean up csiVolMountOption, add it

* command/alloc_status: csiVolMountOption lives in volume_csi_status

* command/node_status: display mount flags

* nomad/structs/volumes: npe

* plugins/csi/plugin: npe in ToCSIRepresentation

* jobspec/parse_test: expand volume parse test cases

* command/agent/job_endpoint: ApiTgToStructsTG needs MountOptions

* command/volume_status_csi: copy paste error

* jobspec/test-fixtures/basic: hclfmt

* command/volume_status_csi: clean up csiVolMountOption

plugins/csi/fake/client.go

@@ -67,6 +67,7 @@ type Client struct {
 	NextNodeUnstageVolumeErr   error
 	NodeUnstageVolumeCallCount int64
 
+	PrevVolumeCapability       *csi.VolumeCapability
 	NextNodePublishVolumeErr   error
 	NodePublishVolumeCallCount int64
 
@@ -217,6 +218,7 @@ func (c *Client) NodePublishVolume(ctx context.Context, req *csi.NodePublishVolu
 	c.Mu.Lock()
 	defer c.Mu.Unlock()
 
+	c.PrevVolumeCapability = req.VolumeCapability
 	c.NodePublishVolumeCallCount++
 
 	return c.NextNodePublishVolumeErr

plugins/csi/plugin.go

@@ -357,42 +357,13 @@ func (v VolumeAccessType) String() string {
 	}
 }
 
-// VolumeMountOptions contain optional additional configuration that can be used
-// when specifying that a Volume should be used with VolumeAccessTypeMount.
-type VolumeMountOptions struct {
-	// FSType is an optional field that allows an operator to specify the type
-	// of the filesystem.
-	FSType string
-
-	// MountFlags contains additional options that may be used when mounting the
-	// volume by the plugin. This may contain sensitive data and should not be
-	// leaked.
-	MountFlags []string
-}
-
-// VolumeMountOptions implements the Stringer and GoStringer interfaces to prevent
-// accidental leakage of sensitive mount flags via logs.
-var _ fmt.Stringer = &VolumeMountOptions{}
-var _ fmt.GoStringer = &VolumeMountOptions{}
-
-func (v *VolumeMountOptions) String() string {
-	mountFlagsString := "nil"
-	if len(v.MountFlags) != 0 {
-		mountFlagsString = "[REDACTED]"
-	}
-
-	return fmt.Sprintf("csi.VolumeMountOptions(FSType: %s, MountFlags: %s)", v.FSType, mountFlagsString)
-}
-
-func (v *VolumeMountOptions) GoString() string {
-	return v.String()
-}
-
 // VolumeCapability describes the overall usage requirements for a given CSI Volume
 type VolumeCapability struct {
-	AccessType         VolumeAccessType
-	AccessMode         VolumeAccessMode
-	VolumeMountOptions *VolumeMountOptions
+	AccessType VolumeAccessType
+	AccessMode VolumeAccessMode
+
+	// Indicate that the volume will be accessed via the filesystem API.
+	MountVolume *structs.CSIMountOptions
 }
 
 func VolumeCapabilityFromStructs(sAccessType structs.CSIVolumeAttachmentMode, sAccessMode structs.CSIVolumeAccessMode) (*VolumeCapability, error) {
@@ -431,11 +402,8 @@ func VolumeCapabilityFromStructs(sAccessType structs.CSIVolumeAttachmentMode, sA
 	}
 
 	return &VolumeCapability{
-		AccessType:         accessType,
-		AccessMode:         accessMode,
-		VolumeMountOptions: &VolumeMountOptions{
-			// GH-7007: Currently we have no way to provide these
-		},
+		AccessType: accessType,
+		AccessMode: accessMode,
 	}, nil
 }
 
@@ -451,12 +419,12 @@ func (c *VolumeCapability) ToCSIRepresentation() *csipbv1.VolumeCapability {
 	}
 
 	if c.AccessType == VolumeAccessTypeMount {
-		vc.AccessType = &csipbv1.VolumeCapability_Mount{
-			Mount: &csipbv1.VolumeCapability_MountVolume{
-				FsType:     c.VolumeMountOptions.FSType,
-				MountFlags: c.VolumeMountOptions.MountFlags,
-			},
+		opts := &csipbv1.VolumeCapability_MountVolume{}
+		if c.MountVolume != nil {
+			opts.FsType = c.MountVolume.FSType
+			opts.MountFlags = c.MountVolume.MountFlags
 		}
+		vc.AccessType = &csipbv1.VolumeCapability_Mount{Mount: opts}
 	} else {
 		vc.AccessType = &csipbv1.VolumeCapability_Block{Block: &csipbv1.VolumeCapability_BlockVolume{}}
 	}