backport of commit 120c3ca (#20423)

Co-authored-by: Juana De La Cuesta <[email protected]>

.changelog/19839.txt

@@ -0,0 +1,3 @@
+```release-note:improvement
+client/volumes: Add a mount volume level option for selinux tags on volumes
+```

api/tasks.go

@@ -426,15 +426,21 @@ type VolumeMount struct {
 	Destination     *string `hcl:"destination,optional"`
 	ReadOnly        *bool   `mapstructure:"read_only" hcl:"read_only,optional"`
 	PropagationMode *string `mapstructure:"propagation_mode" hcl:"propagation_mode,optional"`
+	SELinuxLabel    *string `mapstructure:"selinux_label" hcl:"selinux_label,optional"`
 }
 
 func (vm *VolumeMount) Canonicalize() {
 	if vm.PropagationMode == nil {
 		vm.PropagationMode = pointerOf(VolumeMountPropagationPrivate)
 	}
+
 	if vm.ReadOnly == nil {
 		vm.ReadOnly = pointerOf(false)
 	}
+
+	if vm.SELinuxLabel == nil {
+		vm.SELinuxLabel = pointerOf("")
+	}
 }
 
 // TaskGroup is the unit of scheduling.

client/allocrunner/taskrunner/volume_hook.go

@@ -95,6 +95,7 @@ func (h *volumeHook) hostVolumeMountConfigurations(taskMounts []*structs.VolumeM
 			TaskPath:        m.Destination,
 			Readonly:        hostVolume.ReadOnly || req.ReadOnly || m.ReadOnly,
 			PropagationMode: m.PropagationMode,
+			SELinuxLabel:    m.SELinuxLabel,
 		}
 		mounts = append(mounts, mcfg)
 	}
@@ -188,6 +189,7 @@ func (h *volumeHook) prepareCSIVolumes(req *interfaces.TaskPrestartRequest, volu
 				TaskPath:        m.Destination,
 				Readonly:        request.ReadOnly || m.ReadOnly,
 				PropagationMode: m.PropagationMode,
+				SELinuxLabel:    m.SELinuxLabel,
 			}
 			mounts = append(mounts, mcfg)
 		}

command/agent/job_endpoint.go

@@ -1314,6 +1314,7 @@ func ApiTaskToStructsTask(job *structs.Job, group *structs.TaskGroup,
 						Destination:     *mount.Destination,
 						ReadOnly:        *mount.ReadOnly,
 						PropagationMode: *mount.PropagationMode,
+						SELinuxLabel:    *mount.SELinuxLabel,
 					})
 			}
 		}

nomad/structs/structs.go

@@ -7937,15 +7937,12 @@ func (t *Task) Validate(jobType string, tg *TaskGroup) error {
 
 	// Validation for volumes
 	for idx, vm := range t.VolumeMounts {
-		if !MountPropagationModeIsValid(vm.PropagationMode) {
-			mErr.Errors = append(mErr.Errors, fmt.Errorf("Volume Mount (%d) has an invalid propagation mode: \"%s\"", idx, vm.PropagationMode))
+		if _, ok := tg.Volumes[vm.Volume]; !ok {
+			mErr.Errors = append(mErr.Errors, fmt.Errorf("Volume Mount (%d) references undefined volume %s", idx, vm.Volume))
 		}
 
-		// Validate the task does not reference undefined volume mounts
-		if vm.Volume == "" {
-			mErr.Errors = append(mErr.Errors, fmt.Errorf("Volume Mount (%d) references an empty volume", idx))
-		} else if _, ok := tg.Volumes[vm.Volume]; !ok {
-			mErr.Errors = append(mErr.Errors, fmt.Errorf("Volume Mount (%d) references undefined volume %s", idx, vm.Volume))
+		if err := vm.Validate(); err != nil {
+			mErr.Errors = append(mErr.Errors, fmt.Errorf("Volume Mount (%d) is invalid: \"%w\"", idx, err))
 		}
 	}
 

nomad/structs/structs_test.go

@@ -1625,7 +1625,7 @@ func TestTaskGroup_Validate(t *testing.T) {
 				},
 			},
 			expErr: []string{
-				`Volume Mount (0) references an empty volume`,
+				`Volume Mount (0) references undefined volume`,
 				`Volume Mount (0) references undefined volume foob`,
 			},
 			jobType: JobTypeService,
@@ -2043,6 +2043,24 @@ func TestTask_Validate(t *testing.T) {
 		t.Fatalf("err: %s", err)
 	}
 
+	tg.Volumes = map[string]*VolumeRequest{
+		"foo": {
+			Name: "foo",
+		},
+	}
+
+	task.VolumeMounts = []*VolumeMount{
+		{
+			Volume: "blah",
+		},
+	}
+
+	err = task.Validate(JobTypeBatch, tg)
+	requireErrors(t, err,
+		"Volume Mount (0) references undefined volume blah",
+	)
+	task.VolumeMounts = nil
+
 	task.Constraints = append(task.Constraints,
 		&Constraint{
 			Operand: ConstraintDistinctHosts,

nomad/structs/volume_test.go

@@ -4,6 +4,7 @@
 package structs
 
 import (
+	"errors"
 	"testing"
 
 	"github.com/hashicorp/nomad/ci"
@@ -168,3 +169,63 @@ func TestVolumeMount_Equal(t *testing.T) {
 		Apply: func(vm *VolumeMount) { vm.PropagationMode = "mode2" },
 	}})
 }
+
+func TestVolumeMount_Validate(t *testing.T) {
+	ci.Parallel(t)
+
+	testCases := []struct {
+		name        string
+		expectedErr error
+		volMount    *VolumeMount
+	}{
+		{
+			name: "valid volume mount",
+			volMount: &VolumeMount{
+				Volume: "vol",
+			},
+			expectedErr: nil,
+		},
+		{
+			name: "empty volume reference",
+			volMount: &VolumeMount{
+				Volume: "",
+			},
+			expectedErr: errVolMountEmptyVol,
+		},
+		{
+			name: "invalid propagation mode",
+			volMount: &VolumeMount{
+				Volume:          "vol",
+				PropagationMode: "very invalid propagation mode",
+			},
+			expectedErr: errVolMountInvalidPropagationMode,
+		},
+		{
+			name: "invalid selinux label",
+			volMount: &VolumeMount{
+				Volume:          "vol",
+				PropagationMode: VolumeMountPropagationPrivate,
+				SELinuxLabel:    "very invalid selinux label",
+			},
+			expectedErr: errVolMountInvalidSELinuxLabel,
+		},
+		{
+			name: "full valid volume mont",
+			volMount: &VolumeMount{
+				Volume:          "vol",
+				PropagationMode: VolumeMountPropagationPrivate,
+				SELinuxLabel:    SELinuxPrivateVolume,
+			},
+			expectedErr: nil,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			err := tc.volMount.Validate()
+			if !errors.Is(err, tc.expectedErr) {
+				t.Fatalf("expected error %v, got %v", tc.expectedErr, err)
+			}
+		})
+	}
+}

nomad/structs/volumes.go

@@ -11,22 +11,20 @@ import (
 
 const (
 	VolumeTypeHost = "host"
-)
 
-const (
 	VolumeMountPropagationPrivate       = "private"
 	VolumeMountPropagationHostToTask    = "host-to-task"
 	VolumeMountPropagationBidirectional = "bidirectional"
+
+	SELinuxSharedVolume  = "z"
+	SELinuxPrivateVolume = "Z"
 )
 
-func MountPropagationModeIsValid(propagationMode string) bool {
-	switch propagationMode {
-	case "", VolumeMountPropagationPrivate, VolumeMountPropagationHostToTask, VolumeMountPropagationBidirectional:
-		return true
-	default:
-		return false
-	}
-}
+var (
+	errVolMountInvalidPropagationMode = fmt.Errorf("volume mount has an invalid propagation mode")
+	errVolMountInvalidSELinuxLabel    = fmt.Errorf("volume mount has an invalid SELinux label")
+	errVolMountEmptyVol               = fmt.Errorf("volume mount references an empty volume")
+)
 
 // ClientHostVolumeConfig is used to configure access to host paths on a Nomad Client
 type ClientHostVolumeConfig struct {
@@ -250,6 +248,7 @@ type VolumeMount struct {
 	Destination     string
 	ReadOnly        bool
 	PropagationMode string
+	SELinuxLabel    string
 }
 
 func (v *VolumeMount) Equal(o *VolumeMount) bool {
@@ -265,7 +264,10 @@ func (v *VolumeMount) Equal(o *VolumeMount) bool {
 		return false
 	case v.PropagationMode != o.PropagationMode:
 		return false
+	case v.SELinuxLabel != o.SELinuxLabel:
+		return false
 	}
+
 	return true
 }
 
@@ -279,6 +281,43 @@ func (v *VolumeMount) Copy() *VolumeMount {
 	return nv
 }
 
+func (v *VolumeMount) Validate() error {
+	var mErr *multierror.Error
+
+	// Validate the task does not reference undefined volume mounts
+	if v.Volume == "" {
+		mErr = multierror.Append(mErr, errVolMountEmptyVol)
+	}
+
+	if !v.MountPropagationModeIsValid() {
+		mErr = multierror.Append(mErr, fmt.Errorf("%w: %q", errVolMountInvalidPropagationMode, v.PropagationMode))
+	}
+
+	if !v.SELinuxLabelIsValid() {
+		mErr = multierror.Append(mErr, fmt.Errorf("%w: \"%s\"", errVolMountInvalidSELinuxLabel, v.SELinuxLabel))
+	}
+
+	return mErr.ErrorOrNil()
+}
+
+func (v *VolumeMount) MountPropagationModeIsValid() bool {
+	switch v.PropagationMode {
+	case "", VolumeMountPropagationPrivate, VolumeMountPropagationHostToTask, VolumeMountPropagationBidirectional:
+		return true
+	default:
+		return false
+	}
+}
+
+func (v *VolumeMount) SELinuxLabelIsValid() bool {
+	switch v.SELinuxLabel {
+	case "", SELinuxSharedVolume, SELinuxPrivateVolume:
+		return true
+	default:
+		return false
+	}
+}
+
 func CopySliceVolumeMount(s []*VolumeMount) []*VolumeMount {
 	l := len(s)
 	if l == 0 {

plugins/drivers/driver.go

@@ -444,13 +444,15 @@ type MountConfig struct {
 	HostPath        string
 	Readonly        bool
 	PropagationMode string
+	SELinuxLabel    string
 }
 
 func (m *MountConfig) IsEqual(o *MountConfig) bool {
 	return m.TaskPath == o.TaskPath &&
 		m.HostPath == o.HostPath &&
 		m.Readonly == o.Readonly &&
-		m.PropagationMode == o.PropagationMode
+		m.PropagationMode == o.PropagationMode &&
+		m.SELinuxLabel == o.SELinuxLabel
 }
 
 func (m *MountConfig) Copy() *MountConfig {