/* 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 nfs import ( "fmt" "os" "strconv" "strings" "time" "github.com/container-storage-interface/spec/lib/go/csi" "golang.org/x/net/context" "google.golang.org/grpc/codes" "google.golang.org/grpc/status" "k8s.io/klog/v2" "k8s.io/kubernetes/pkg/volume" mount "k8s.io/mount-utils" ) // NodeServer driver type NodeServer struct { Driver *Driver mounter mount.Interface } // NodePublishVolume mount the volume func (ns *NodeServer) NodePublishVolume(_ context.Context, req *csi.NodePublishVolumeRequest) (*csi.NodePublishVolumeResponse, error) { volCap := req.GetVolumeCapability() if volCap == nil { return nil, status.Error(codes.InvalidArgument, "Volume capability missing in request") } volumeID := req.GetVolumeId() if len(volumeID) == 0 { return nil, status.Error(codes.InvalidArgument, "Volume ID missing in request") } targetPath := req.GetTargetPath() if len(targetPath) == 0 { return nil, status.Error(codes.InvalidArgument, "Target path not provided") } mountOptions := volCap.GetMount().GetMountFlags() if req.GetReadonly() { mountOptions = append(mountOptions, "ro") } var server, baseDir, subDir string subDirReplaceMap := map[string]string{} mountPermissions := ns.Driver.mountPermissions for k, v := range req.GetVolumeContext() { switch strings.ToLower(k) { case paramServer: server = v case paramShare: baseDir = v case paramSubDir: subDir = v case pvcNamespaceKey: subDirReplaceMap[pvcNamespaceMetadata] = v case pvcNameKey: subDirReplaceMap[pvcNameMetadata] = v case pvNameKey: subDirReplaceMap[pvNameMetadata] = v case mountOptionsField: if v != "" { mountOptions = append(mountOptions, v) } case mountPermissionsField: if v != "" { var err error if mountPermissions, err = strconv.ParseUint(v, 8, 32); err != nil { return nil, status.Errorf(codes.InvalidArgument, fmt.Sprintf("invalid mountPermissions %s", v)) } } } } if server == "" { return nil, status.Error(codes.InvalidArgument, fmt.Sprintf("%v is a required parameter", paramServer)) } if baseDir == "" { return nil, status.Error(codes.InvalidArgument, fmt.Sprintf("%v is a required parameter", paramShare)) } server = getServerFromSource(server) source := fmt.Sprintf("%s:%s", server, baseDir) if subDir != "" { // replace pv/pvc name namespace metadata in subDir subDir = replaceWithMap(subDir, subDirReplaceMap) source = strings.TrimRight(source, "/") source = fmt.Sprintf("%s/%s", source, subDir) } notMnt, err := ns.mounter.IsLikelyNotMountPoint(targetPath) if err != nil { if os.IsNotExist(err) { if err := os.MkdirAll(targetPath, os.FileMode(mountPermissions)); err != nil { return nil, status.Error(codes.Internal, err.Error()) } notMnt = true } else { return nil, status.Error(codes.Internal, err.Error()) } } if !notMnt { return &csi.NodePublishVolumeResponse{}, nil } klog.V(2).Infof("NodePublishVolume: volumeID(%v) source(%s) targetPath(%s) mountflags(%v)", volumeID, source, targetPath, mountOptions) err = ns.mounter.Mount(source, targetPath, "nfs", mountOptions) if err != nil { if os.IsPermission(err) { return nil, status.Error(codes.PermissionDenied, err.Error()) } if strings.Contains(err.Error(), "invalid argument") { return nil, status.Error(codes.InvalidArgument, err.Error()) } return nil, status.Error(codes.Internal, err.Error()) } if mountPermissions > 0 { if err := chmodIfPermissionMismatch(targetPath, os.FileMode(mountPermissions)); err != nil { return nil, status.Error(codes.Internal, err.Error()) } } else { klog.V(2).Infof("skip chmod on targetPath(%s) since mountPermissions is set as 0", targetPath) } klog.V(2).Infof("volume(%s) mount %s on %s succeeded", volumeID, source, targetPath) return &csi.NodePublishVolumeResponse{}, nil } // NodeUnpublishVolume unmount the volume func (ns *NodeServer) NodeUnpublishVolume(_ context.Context, req *csi.NodeUnpublishVolumeRequest) (*csi.NodeUnpublishVolumeResponse, error) { volumeID := req.GetVolumeId() if len(volumeID) == 0 { return nil, status.Error(codes.InvalidArgument, "Volume ID missing in request") } targetPath := req.GetTargetPath() if len(targetPath) == 0 { return nil, status.Error(codes.InvalidArgument, "Target path missing in request") } klog.V(2).Infof("NodeUnpublishVolume: unmounting volume %s on %s", volumeID, targetPath) var err error extensiveMountPointCheck := true forceUnmounter, ok := ns.mounter.(mount.MounterForceUnmounter) if ok { klog.V(2).Infof("force unmount %s on %s", volumeID, targetPath) err = mount.CleanupMountWithForce(targetPath, forceUnmounter, extensiveMountPointCheck, 30*time.Second) } else { err = mount.CleanupMountPoint(targetPath, ns.mounter, extensiveMountPointCheck) } if err != nil { return nil, status.Errorf(codes.Internal, "failed to unmount target %q: %v", targetPath, err) } klog.V(2).Infof("NodeUnpublishVolume: unmount volume %s on %s successfully", volumeID, targetPath) return &csi.NodeUnpublishVolumeResponse{}, nil } // NodeGetInfo return info of the node on which this plugin is running func (ns *NodeServer) NodeGetInfo(_ context.Context, _ *csi.NodeGetInfoRequest) (*csi.NodeGetInfoResponse, error) { return &csi.NodeGetInfoResponse{ NodeId: ns.Driver.nodeID, }, nil } // NodeGetCapabilities return the capabilities of the Node plugin func (ns *NodeServer) NodeGetCapabilities(_ context.Context, _ *csi.NodeGetCapabilitiesRequest) (*csi.NodeGetCapabilitiesResponse, error) { return &csi.NodeGetCapabilitiesResponse{ Capabilities: ns.Driver.nscap, }, nil } // NodeGetVolumeStats get volume stats func (ns *NodeServer) NodeGetVolumeStats(_ context.Context, req *csi.NodeGetVolumeStatsRequest) (*csi.NodeGetVolumeStatsResponse, error) { if len(req.VolumeId) == 0 { return nil, status.Error(codes.InvalidArgument, "NodeGetVolumeStats volume ID was empty") } if len(req.VolumePath) == 0 { return nil, status.Error(codes.InvalidArgument, "NodeGetVolumeStats volume path was empty") } if _, err := os.Lstat(req.VolumePath); err != nil { if os.IsNotExist(err) { return nil, status.Errorf(codes.NotFound, "path %s does not exist", req.VolumePath) } return nil, status.Errorf(codes.Internal, "failed to stat file %s: %v", req.VolumePath, err) } volumeMetrics, err := volume.NewMetricsStatFS(req.VolumePath).GetMetrics() if err != nil { return nil, status.Errorf(codes.Internal, "failed to get metrics: %v", err) } available, ok := volumeMetrics.Available.AsInt64() if !ok { return nil, status.Errorf(codes.Internal, "failed to transform volume available size(%v)", volumeMetrics.Available) } capacity, ok := volumeMetrics.Capacity.AsInt64() if !ok { return nil, status.Errorf(codes.Internal, "failed to transform volume capacity size(%v)", volumeMetrics.Capacity) } used, ok := volumeMetrics.Used.AsInt64() if !ok { return nil, status.Errorf(codes.Internal, "failed to transform volume used size(%v)", volumeMetrics.Used) } inodesFree, ok := volumeMetrics.InodesFree.AsInt64() if !ok { return nil, status.Errorf(codes.Internal, "failed to transform disk inodes free(%v)", volumeMetrics.InodesFree) } inodes, ok := volumeMetrics.Inodes.AsInt64() if !ok { return nil, status.Errorf(codes.Internal, "failed to transform disk inodes(%v)", volumeMetrics.Inodes) } inodesUsed, ok := volumeMetrics.InodesUsed.AsInt64() if !ok { return nil, status.Errorf(codes.Internal, "failed to transform disk inodes used(%v)", volumeMetrics.InodesUsed) } return &csi.NodeGetVolumeStatsResponse{ Usage: []*csi.VolumeUsage{ { Unit: csi.VolumeUsage_BYTES, Available: available, Total: capacity, Used: used, }, { Unit: csi.VolumeUsage_INODES, Available: inodesFree, Total: inodes, Used: inodesUsed, }, }, }, nil } // NodeUnstageVolume unstage volume func (ns *NodeServer) NodeUnstageVolume(_ context.Context, _ *csi.NodeUnstageVolumeRequest) (*csi.NodeUnstageVolumeResponse, error) { return nil, status.Error(codes.Unimplemented, "") } // NodeStageVolume stage volume func (ns *NodeServer) NodeStageVolume(_ context.Context, _ *csi.NodeStageVolumeRequest) (*csi.NodeStageVolumeResponse, error) { return nil, status.Error(codes.Unimplemented, "") } // NodeExpandVolume node expand volume func (ns *NodeServer) NodeExpandVolume(_ context.Context, _ *csi.NodeExpandVolumeRequest) (*csi.NodeExpandVolumeResponse, error) { return nil, status.Error(codes.Unimplemented, "") } func makeDir(pathname string) error { err := os.MkdirAll(pathname, os.FileMode(0755)) if err != nil { if !os.IsExist(err) { return err } } return nil }