package structs import ( "fmt" multierror "github.com/hashicorp/go-multierror" ) const ( VolumeTypeHost = "host" ) const ( VolumeMountPropagationPrivate = "private" VolumeMountPropagationHostToTask = "host-to-task" VolumeMountPropagationBidirectional = "bidirectional" ) func MountPropagationModeIsValid(propagationMode string) bool { switch propagationMode { case "", VolumeMountPropagationPrivate, VolumeMountPropagationHostToTask, VolumeMountPropagationBidirectional: return true default: return false } } // ClientHostVolumeConfig is used to configure access to host paths on a Nomad Client type ClientHostVolumeConfig struct { Name string `hcl:",key"` Path string `hcl:"path"` ReadOnly bool `hcl:"read_only"` } func (p *ClientHostVolumeConfig) Copy() *ClientHostVolumeConfig { if p == nil { return nil } c := new(ClientHostVolumeConfig) *c = *p return c } func CopyMapStringClientHostVolumeConfig(m map[string]*ClientHostVolumeConfig) map[string]*ClientHostVolumeConfig { if m == nil { return nil } nm := make(map[string]*ClientHostVolumeConfig, len(m)) for k, v := range m { nm[k] = v.Copy() } return nm } func CopySliceClientHostVolumeConfig(s []*ClientHostVolumeConfig) []*ClientHostVolumeConfig { l := len(s) if l == 0 { return nil } ns := make([]*ClientHostVolumeConfig, l) for idx, cfg := range s { ns[idx] = cfg.Copy() } return ns } func HostVolumeSliceMerge(a, b []*ClientHostVolumeConfig) []*ClientHostVolumeConfig { n := make([]*ClientHostVolumeConfig, len(a)) seenKeys := make(map[string]int, len(a)) for i, config := range a { n[i] = config.Copy() seenKeys[config.Name] = i } for _, config := range b { if fIndex, ok := seenKeys[config.Name]; ok { n[fIndex] = config.Copy() continue } n = append(n, config.Copy()) } return n } // VolumeRequest is a representation of a storage volume that a TaskGroup wishes to use. type VolumeRequest struct { Name string Type string Source string ReadOnly bool AccessMode CSIVolumeAccessMode AttachmentMode CSIVolumeAttachmentMode MountOptions *CSIMountOptions PerAlloc bool } func (v *VolumeRequest) Validate(taskGroupCount, canaries int) error { if !(v.Type == VolumeTypeHost || v.Type == VolumeTypeCSI) { return fmt.Errorf("volume has unrecognized type %s", v.Type) } var mErr multierror.Error addErr := func(msg string, args ...interface{}) { mErr.Errors = append(mErr.Errors, fmt.Errorf(msg, args...)) } if v.Source == "" { addErr("volume has an empty source") } switch v.Type { case VolumeTypeHost: if v.AttachmentMode != CSIVolumeAttachmentModeUnknown { addErr("host volumes cannot have an attachment mode") } if v.AccessMode != CSIVolumeAccessModeUnknown { addErr("host volumes cannot have an access mode") } if v.MountOptions != nil { addErr("host volumes cannot have mount options") } if v.PerAlloc { addErr("host volumes do not support per_alloc") } case VolumeTypeCSI: switch v.AttachmentMode { case CSIVolumeAttachmentModeUnknown: addErr("CSI volumes must have an attachment mode") case CSIVolumeAttachmentModeBlockDevice: if v.MountOptions != nil { addErr("block devices cannot have mount options") } } switch v.AccessMode { case CSIVolumeAccessModeUnknown: addErr("CSI volumes must have an access mode") case CSIVolumeAccessModeSingleNodeReader: if !v.ReadOnly { addErr("%s volumes must be read-only", v.AccessMode) } if taskGroupCount > 1 && !v.PerAlloc { addErr("volume with %s access mode allows only one reader", v.AccessMode) } case CSIVolumeAccessModeSingleNodeWriter: // note: we allow read-only mount of this volume, but only one if taskGroupCount > 1 && !v.PerAlloc { addErr("volume with %s access mode allows only one reader or writer", v.AccessMode) } case CSIVolumeAccessModeMultiNodeReader: if !v.ReadOnly { addErr("%s volumes must be read-only", v.AccessMode) } case CSIVolumeAccessModeMultiNodeSingleWriter: if !v.ReadOnly && taskGroupCount > 1 && !v.PerAlloc { addErr("volume with %s access mode allows only one writer", v.AccessMode) } case CSIVolumeAccessModeMultiNodeMultiWriter: // note: we intentionally allow read-only mount of this mode } if v.PerAlloc && canaries > 0 { addErr("volume cannot be per_alloc when canaries are in use") } } return mErr.ErrorOrNil() } func (v *VolumeRequest) Copy() *VolumeRequest { if v == nil { return nil } nv := new(VolumeRequest) *nv = *v if v.MountOptions != nil { nv.MountOptions = v.MountOptions.Copy() } return nv } func CopyMapVolumeRequest(s map[string]*VolumeRequest) map[string]*VolumeRequest { if s == nil { return nil } l := len(s) c := make(map[string]*VolumeRequest, l) for k, v := range s { c[k] = v.Copy() } return c } // VolumeMount represents the relationship between a destination path in a task // and the task group volume that should be mounted there. type VolumeMount struct { Volume string Destination string ReadOnly bool PropagationMode string } func (v *VolumeMount) Copy() *VolumeMount { if v == nil { return nil } nv := new(VolumeMount) *nv = *v return nv } func CopySliceVolumeMount(s []*VolumeMount) []*VolumeMount { l := len(s) if l == 0 { return nil } c := make([]*VolumeMount, l) for i, v := range s { c[i] = v.Copy() } return c }