/* Copyright 2017 The Kubernetes Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package csi import ( "context" "crypto/sha256" "errors" "fmt" "os" "path" "path/filepath" "strconv" "k8s.io/klog" api "k8s.io/api/core/v1" storage "k8s.io/api/storage/v1beta1" apierrs "k8s.io/apimachinery/pkg/api/errors" "k8s.io/apimachinery/pkg/types" utilfeature "k8s.io/apiserver/pkg/util/feature" "k8s.io/client-go/kubernetes" "k8s.io/kubernetes/pkg/features" "k8s.io/kubernetes/pkg/volume" utilstrings "k8s.io/utils/strings" ) //TODO (vladimirvivien) move this in a central loc later var ( volDataKey = struct { specVolID, volHandle, driverName, nodeName, attachmentID, volumeLifecycleMode string }{ "specVolID", "volumeHandle", "driverName", "nodeName", "attachmentID", "volumeLifecycleMode", } ) type csiMountMgr struct { csiClientGetter k8s kubernetes.Interface plugin *csiPlugin driverName csiDriverName volumeLifecycleMode storage.VolumeLifecycleMode volumeID string specVolumeID string readOnly bool spec *volume.Spec pod *api.Pod podUID types.UID options volume.VolumeOptions publishContext map[string]string kubeVolHost volume.KubeletVolumeHost volume.MetricsProvider } // volume.Volume methods var _ volume.Volume = &csiMountMgr{} func (c *csiMountMgr) GetPath() string { dir := filepath.Join(getTargetPath(c.podUID, c.specVolumeID, c.plugin.host), "/mount") klog.V(4).Info(log("mounter.GetPath generated [%s]", dir)) return dir } func getTargetPath(uid types.UID, specVolumeID string, host volume.VolumeHost) string { specVolID := utilstrings.EscapeQualifiedName(specVolumeID) return host.GetPodVolumeDir(uid, utilstrings.EscapeQualifiedName(CSIPluginName), specVolID) } // volume.Mounter methods var _ volume.Mounter = &csiMountMgr{} func (c *csiMountMgr) CanMount() error { return nil } func (c *csiMountMgr) SetUp(mounterArgs volume.MounterArgs) error { return c.SetUpAt(c.GetPath(), mounterArgs) } func (c *csiMountMgr) SetUpAt(dir string, mounterArgs volume.MounterArgs) error { klog.V(4).Infof(log("Mounter.SetUpAt(%s)", dir)) mounted, err := isDirMounted(c.plugin, dir) if err != nil { return errors.New(log("mounter.SetUpAt failed while checking mount status for dir [%s]: %v", dir, err)) } if mounted { klog.V(4).Info(log("mounter.SetUpAt skipping mount, dir already mounted [%s]", dir)) return nil } csi, err := c.csiClientGetter.Get() if err != nil { return errors.New(log("mounter.SetUpAt failed to get CSI client: %v", err)) } ctx, cancel := context.WithTimeout(context.Background(), csiTimeout) defer cancel() volSrc, pvSrc, err := getSourceFromSpec(c.spec) if err != nil { return errors.New(log("mounter.SetupAt failed to get CSI persistent source: %v", err)) } driverName := c.driverName volumeHandle := c.volumeID readOnly := c.readOnly accessMode := api.ReadWriteOnce var ( fsType string volAttribs map[string]string nodePublishSecrets map[string]string publishContext map[string]string mountOptions []string deviceMountPath string secretRef *api.SecretReference ) switch { case volSrc != nil: if !utilfeature.DefaultFeatureGate.Enabled(features.CSIInlineVolume) { return fmt.Errorf("CSIInlineVolume feature required") } if c.volumeLifecycleMode != storage.VolumeLifecycleEphemeral { return fmt.Errorf("unexpected volume mode: %s", c.volumeLifecycleMode) } if volSrc.FSType != nil { fsType = *volSrc.FSType } volAttribs = volSrc.VolumeAttributes if volSrc.NodePublishSecretRef != nil { secretName := volSrc.NodePublishSecretRef.Name ns := c.pod.Namespace secretRef = &api.SecretReference{Name: secretName, Namespace: ns} } case pvSrc != nil: if c.volumeLifecycleMode != storage.VolumeLifecyclePersistent { return fmt.Errorf("unexpected driver mode: %s", c.volumeLifecycleMode) } fsType = pvSrc.FSType volAttribs = pvSrc.VolumeAttributes if pvSrc.NodePublishSecretRef != nil { secretRef = pvSrc.NodePublishSecretRef } //TODO (vladimirvivien) implement better AccessModes mapping between k8s and CSI if c.spec.PersistentVolume.Spec.AccessModes != nil { accessMode = c.spec.PersistentVolume.Spec.AccessModes[0] } mountOptions = c.spec.PersistentVolume.Spec.MountOptions // Check for STAGE_UNSTAGE_VOLUME set and populate deviceMountPath if so stageUnstageSet, err := csi.NodeSupportsStageUnstage(ctx) if err != nil { return errors.New(log("mounter.SetUpAt failed to check for STAGE_UNSTAGE_VOLUME capability: %v", err)) } if stageUnstageSet { deviceMountPath, err = makeDeviceMountPath(c.plugin, c.spec) if err != nil { return errors.New(log("mounter.SetUpAt failed to make device mount path: %v", err)) } } // search for attachment by VolumeAttachment.Spec.Source.PersistentVolumeName if c.publishContext == nil { nodeName := string(c.plugin.host.GetNodeName()) c.publishContext, err = c.plugin.getPublishContext(c.k8s, volumeHandle, string(driverName), nodeName) if err != nil { return err } publishContext = c.publishContext } default: return fmt.Errorf("volume source not found in volume.Spec") } // create target_dir before call to NodePublish if err := os.MkdirAll(dir, 0750); err != nil { return errors.New(log("mounter.SetUpAt failed to create dir %#v: %v", dir, err)) } klog.V(4).Info(log("created target path successfully [%s]", dir)) nodePublishSecrets = map[string]string{} if secretRef != nil { nodePublishSecrets, err = getCredentialsFromSecret(c.k8s, secretRef) if err != nil { return fmt.Errorf("fetching NodePublishSecretRef %s/%s failed: %v", secretRef.Namespace, secretRef.Name, err) } } // Inject pod information into volume_attributes podAttrs, err := c.podAttributes() if err != nil { return errors.New(log("mounter.SetUpAt failed to assemble volume attributes: %v", err)) } if podAttrs != nil { if volAttribs == nil { volAttribs = podAttrs } else { for k, v := range podAttrs { volAttribs[k] = v } } } err = csi.NodePublishVolume( ctx, volumeHandle, readOnly, deviceMountPath, dir, accessMode, publishContext, volAttribs, nodePublishSecrets, fsType, mountOptions, ) if err != nil { if removeMountDirErr := removeMountDir(c.plugin, dir); removeMountDirErr != nil { klog.Error(log("mounter.SetupAt failed to remove mount dir after a NodePublish() error [%s]: %v", dir, removeMountDirErr)) } return errors.New(log("mounter.SetupAt failed: %v", err)) } // apply volume ownership // The following logic is derived from https://github.com/kubernetes/kubernetes/issues/66323 // if fstype is "", then skip fsgroup (could be indication of non-block filesystem) // if fstype is provided and pv.AccessMode == ReadWriteOnly, then apply fsgroup err = c.applyFSGroup(fsType, mounterArgs.FsGroup) if err != nil { // attempt to rollback mount. fsGrpErr := fmt.Errorf("applyFSGroup failed for vol %s: %v", c.volumeID, err) if unpubErr := csi.NodeUnpublishVolume(ctx, c.volumeID, dir); unpubErr != nil { klog.Error(log("NodeUnpublishVolume failed for [%s]: %v", c.volumeID, unpubErr)) return fsGrpErr } if unmountErr := removeMountDir(c.plugin, dir); unmountErr != nil { klog.Error(log("removeMountDir failed for [%s]: %v", dir, unmountErr)) return fsGrpErr } return fsGrpErr } klog.V(4).Infof(log("mounter.SetUp successfully requested NodePublish [%s]", dir)) return nil } func (c *csiMountMgr) podAttributes() (map[string]string, error) { if !utilfeature.DefaultFeatureGate.Enabled(features.CSIDriverRegistry) { return nil, nil } kletHost, ok := c.plugin.host.(volume.KubeletVolumeHost) if ok { kletHost.WaitForCacheSync() } if c.plugin.csiDriverLister == nil { return nil, fmt.Errorf("CSIDriverLister not found") } csiDriver, err := c.plugin.csiDriverLister.Get(string(c.driverName)) if err != nil { if apierrs.IsNotFound(err) { klog.V(4).Infof(log("CSIDriver %q not found, not adding pod information", c.driverName)) return nil, nil } return nil, err } // if PodInfoOnMount is not set or false we do not set pod attributes if csiDriver.Spec.PodInfoOnMount == nil || *csiDriver.Spec.PodInfoOnMount == false { klog.V(4).Infof(log("CSIDriver %q does not require pod information", c.driverName)) return nil, nil } attrs := map[string]string{ "csi.storage.k8s.io/pod.name": c.pod.Name, "csi.storage.k8s.io/pod.namespace": c.pod.Namespace, "csi.storage.k8s.io/pod.uid": string(c.pod.UID), "csi.storage.k8s.io/serviceAccount.name": c.pod.Spec.ServiceAccountName, } if utilfeature.DefaultFeatureGate.Enabled(features.CSIInlineVolume) { attrs["csi.storage.k8s.io/ephemeral"] = strconv.FormatBool(c.volumeLifecycleMode == storage.VolumeLifecycleEphemeral) } klog.V(4).Infof(log("CSIDriver %q requires pod information", c.driverName)) return attrs, nil } func (c *csiMountMgr) GetAttributes() volume.Attributes { path := c.GetPath() hu := c.kubeVolHost.GetHostUtil() supportSelinux, err := hu.GetSELinuxSupport(path) if err != nil { klog.V(2).Info(log("error checking for SELinux support: %s", err)) // Best guess supportSelinux = false } return volume.Attributes{ ReadOnly: c.readOnly, Managed: !c.readOnly, SupportsSELinux: supportSelinux, } } // volume.Unmounter methods var _ volume.Unmounter = &csiMountMgr{} func (c *csiMountMgr) TearDown() error { return c.TearDownAt(c.GetPath()) } func (c *csiMountMgr) TearDownAt(dir string) error { klog.V(4).Infof(log("Unmounter.TearDown(%s)", dir)) volID := c.volumeID csi, err := c.csiClientGetter.Get() if err != nil { return errors.New(log("mounter.SetUpAt failed to get CSI client: %v", err)) } ctx, cancel := context.WithTimeout(context.Background(), csiTimeout) defer cancel() if err := csi.NodeUnpublishVolume(ctx, volID, dir); err != nil { return errors.New(log("mounter.TearDownAt failed: %v", err)) } // clean mount point dir if err := removeMountDir(c.plugin, dir); err != nil { return errors.New(log("mounter.TearDownAt failed to clean mount dir [%s]: %v", dir, err)) } klog.V(4).Infof(log("mounter.TearDownAt successfully unmounted dir [%s]", dir)) return nil } // applyFSGroup applies the volume ownership it derives its logic // from https://github.com/kubernetes/kubernetes/issues/66323 // 1) if fstype is "", then skip fsgroup (could be indication of non-block filesystem) // 2) if fstype is provided and pv.AccessMode == ReadWriteOnly and !c.spec.ReadOnly then apply fsgroup func (c *csiMountMgr) applyFSGroup(fsType string, fsGroup *int64) error { if fsGroup != nil { if fsType == "" { klog.V(4).Info(log("mounter.SetupAt WARNING: skipping fsGroup, fsType not provided")) return nil } accessModes := c.spec.PersistentVolume.Spec.AccessModes if c.spec.PersistentVolume.Spec.AccessModes == nil { klog.V(4).Info(log("mounter.SetupAt WARNING: skipping fsGroup, access modes not provided")) return nil } if !hasReadWriteOnce(accessModes) { klog.V(4).Info(log("mounter.SetupAt WARNING: skipping fsGroup, only support ReadWriteOnce access mode")) return nil } if c.readOnly { klog.V(4).Info(log("mounter.SetupAt WARNING: skipping fsGroup, volume is readOnly")) return nil } err := volume.SetVolumeOwnership(c, fsGroup) if err != nil { return err } klog.V(4).Info(log("mounter.SetupAt fsGroup [%d] applied successfully to %s", *fsGroup, c.volumeID)) } return nil } // isDirMounted returns the !notMounted result from IsLikelyNotMountPoint check func isDirMounted(plug *csiPlugin, dir string) (bool, error) { mounter := plug.host.GetMounter(plug.GetPluginName()) notMnt, err := mounter.IsLikelyNotMountPoint(dir) if err != nil && !os.IsNotExist(err) { klog.Error(log("isDirMounted IsLikelyNotMountPoint test failed for dir [%v]", dir)) return false, err } return !notMnt, nil } // removeMountDir cleans the mount dir when dir is not mounted and removed the volume data file in dir func removeMountDir(plug *csiPlugin, mountPath string) error { klog.V(4).Info(log("removing mount path [%s]", mountPath)) mnt, err := isDirMounted(plug, mountPath) if err != nil { return err } if !mnt { klog.V(4).Info(log("dir not mounted, deleting it [%s]", mountPath)) if err := os.Remove(mountPath); err != nil && !os.IsNotExist(err) { return errors.New(log("failed to remove dir [%s]: %v", mountPath, err)) } // remove volume data file as well volPath := path.Dir(mountPath) dataFile := filepath.Join(volPath, volDataFileName) klog.V(4).Info(log("also deleting volume info data file [%s]", dataFile)) if err := os.Remove(dataFile); err != nil && !os.IsNotExist(err) { return errors.New(log("failed to delete volume data file [%s]: %v", dataFile, err)) } // remove volume path klog.V(4).Info(log("deleting volume path [%s]", volPath)) if err := os.Remove(volPath); err != nil && !os.IsNotExist(err) { return errors.New(log("failed to delete volume path [%s]: %v", volPath, err)) } } return nil } // makeVolumeHandle returns csi- func makeVolumeHandle(podUID, volSourceSpecName string) string { result := sha256.Sum256([]byte(fmt.Sprintf("%s%s", podUID, volSourceSpecName))) return fmt.Sprintf("csi-%x", result) }