ceph-csi/internal/csi-common/driver.go

118 lines
3.1 KiB
Go
Raw Normal View History

2018-01-09 18:57:14 +00:00
/*
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 csicommon
import (
2018-03-06 22:33:18 +00:00
"fmt"
2018-11-26 18:23:56 +00:00
"github.com/container-storage-interface/spec/lib/go/csi"
2018-01-09 18:57:14 +00:00
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"k8s.io/klog/v2"
"github.com/ceph/ceph-csi/internal/util"
2018-01-09 18:57:14 +00:00
)
// CSIDriver stores driver information.
2018-01-09 18:57:14 +00:00
type CSIDriver struct {
name string
nodeID string
2018-03-06 22:33:18 +00:00
version string
// topology constraints that this nodeserver will advertise
topology map[string]string
capabilities []*csi.ControllerServiceCapability
vc []*csi.VolumeCapability_AccessMode
2018-01-09 18:57:14 +00:00
}
// NewCSIDriver Creates a NewCSIDriver object. Assumes vendor
// version is equal to driver version & does not support optional
// driver plugin info manifest field. Refer to CSI spec for more details.
func NewCSIDriver(name, v, nodeID string) *CSIDriver {
2018-01-09 18:57:14 +00:00
if name == "" {
klog.Errorf("Driver name missing")
2018-01-09 18:57:14 +00:00
return nil
}
if nodeID == "" {
klog.Errorf("NodeID missing")
2018-01-09 18:57:14 +00:00
return nil
}
2018-03-06 22:33:18 +00:00
// TODO version format and validation
if v == "" {
klog.Errorf("Version argument missing")
2018-01-09 18:57:14 +00:00
return nil
}
driver := CSIDriver{
name: name,
version: v,
nodeID: nodeID,
}
return &driver
}
// ValidateControllerServiceRequest validates the controller
// plugin capabilities.
2018-03-06 22:33:18 +00:00
func (d *CSIDriver) ValidateControllerServiceRequest(c csi.ControllerServiceCapability_RPC_Type) error {
2018-01-09 18:57:14 +00:00
if c == csi.ControllerServiceCapability_RPC_UNKNOWN {
return nil
}
for _, capability := range d.capabilities {
if c == capability.GetRpc().GetType() {
2018-01-09 18:57:14 +00:00
return nil
}
}
return status.Error(codes.InvalidArgument, fmt.Sprintf("%s", c)) //nolint
2018-01-09 18:57:14 +00:00
}
// AddControllerServiceCapabilities stores the controller capabilities
// in driver object.
2018-01-09 18:57:14 +00:00
func (d *CSIDriver) AddControllerServiceCapabilities(cl []csi.ControllerServiceCapability_RPC_Type) {
csc := make([]*csi.ControllerServiceCapability, 0, len(cl))
2018-01-09 18:57:14 +00:00
for _, c := range cl {
util.DefaultLog("Enabling controller service capability: %v", c.String())
2018-01-09 18:57:14 +00:00
csc = append(csc, NewControllerServiceCapability(c))
}
d.capabilities = csc
2018-01-09 18:57:14 +00:00
}
// AddVolumeCapabilityAccessModes stores volume access modes.
func (d *CSIDriver) AddVolumeCapabilityAccessModes(
vc []csi.VolumeCapability_AccessMode_Mode) []*csi.VolumeCapability_AccessMode {
vca := make([]*csi.VolumeCapability_AccessMode, 0, len(vc))
2018-01-09 18:57:14 +00:00
for _, c := range vc {
util.DefaultLog("Enabling volume access mode: %v", c.String())
2018-01-09 18:57:14 +00:00
vca = append(vca, NewVolumeCapabilityAccessMode(c))
}
d.vc = vca
2018-01-09 18:57:14 +00:00
return vca
}
// GetVolumeCapabilityAccessModes returns access modes.
2018-01-09 18:57:14 +00:00
func (d *CSIDriver) GetVolumeCapabilityAccessModes() []*csi.VolumeCapability_AccessMode {
return d.vc
}