pmemcsidriver

Documentation

Index

• Variables
• func GetCSIDriver(cfg Config) (*csiDriver, error)
• func Main() int
• func NewIdentityServer(name, version string) *identityServer
• func NewNodeControllerServer(ctx context.Context, nodeID string, dm pmdmanager.PmemDeviceManager, ...) *nodeControllerServer
• func NewNodeServer(cs *nodeControllerServer, mountDirectory string) *nodeServer
• type Config
• type DefaultControllerServer
  • func NewDefaultControllerServer(caps []csi.ControllerServiceCapability_RPC_Type) *DefaultControllerServer
  • func (cs *DefaultControllerServer) ControllerGetCapabilities(ctx context.Context, req *csi.ControllerGetCapabilitiesRequest) (*csi.ControllerGetCapabilitiesResponse, error)
  • func (cs *DefaultControllerServer) ControllerPublishVolume(ctx context.Context, req *csi.ControllerPublishVolumeRequest) (*csi.ControllerPublishVolumeResponse, error)
  • func (cs *DefaultControllerServer) ControllerUnpublishVolume(ctx context.Context, req *csi.ControllerUnpublishVolumeRequest) (*csi.ControllerUnpublishVolumeResponse, error)
  • func (cs *DefaultControllerServer) CreateSnapshot(ctx context.Context, req *csi.CreateSnapshotRequest) (*csi.CreateSnapshotResponse, error)
  • func (cs *DefaultControllerServer) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest) (*csi.CreateVolumeResponse, error)
  • func (cs *DefaultControllerServer) DeleteSnapshot(ctx context.Context, req *csi.DeleteSnapshotRequest) (*csi.DeleteSnapshotResponse, error)
  • func (cs *DefaultControllerServer) DeleteVolume(ctx context.Context, req *csi.DeleteVolumeRequest) (*csi.DeleteVolumeResponse, error)
  • func (cs *DefaultControllerServer) GetCapacity(ctx context.Context, req *csi.GetCapacityRequest) (*csi.GetCapacityResponse, error)
  • func (cs *DefaultControllerServer) ListSnapshots(ctx context.Context, req *csi.ListSnapshotsRequest) (*csi.ListSnapshotsResponse, error)
  • func (cs *DefaultControllerServer) ListVolumes(ctx context.Context, req *csi.ListVolumesRequest) (*csi.ListVolumesResponse, error)
  • func (cs *DefaultControllerServer) ValidateControllerServiceRequest(c csi.ControllerServiceCapability_RPC_Type) error
• type DriverMode
  • func (mode *DriverMode) Set(value string) error
  • func (mode *DriverMode) String() string

Variables

var (
	//PmemDriverTopologyKey key to use for topology constraint
	DriverTopologyKey = ""
)

Functions

func GetCSIDriver

func GetCSIDriver(cfg Config) (*csiDriver, error)

func Main

func Main() int

func NewIdentityServer

func NewIdentityServer(name, version string) *identityServer

func NewNodeControllerServer

func NewNodeControllerServer(ctx context.Context, nodeID string, dm pmdmanager.PmemDeviceManager, sm pmemstate.StateManager) *nodeControllerServer

func NewNodeServer

func NewNodeServer(cs *nodeControllerServer, mountDirectory string) *nodeServer

Types

type Config

type Config struct {
	//DriverName name of the csi driver
	DriverName string
	//NodeID node id on which this csi driver is running
	NodeID string
	//Endpoint exported csi driver endpoint
	Endpoint string
	//Mode mode fo the driver
	Mode DriverMode
	//DeviceManager device manager to use
	DeviceManager api.DeviceMode
	//Directory where to persist the node driver state
	StateBasePath string
	//Version driver release version
	Version string
	// PmemPercentage percentage of space to be used by the driver in each PMEM region
	PmemPercentage uint

	// KubeAPIQPS is the average rate of requests to the Kubernetes API server,
	// enforced locally in client-go.
	KubeAPIQPS float64

	// KubeAPIQPS is the number of requests that a client is
	// allowed to send above the average rate of request.
	KubeAPIBurst int
	// contains filtered or unexported fields
}

Config type for driver configuration

type DefaultControllerServer

type DefaultControllerServer struct {
	// contains filtered or unexported fields
}

func NewDefaultControllerServer

func NewDefaultControllerServer(caps []csi.ControllerServiceCapability_RPC_Type) *DefaultControllerServer

func (*DefaultControllerServer) ControllerGetCapabilities

func (cs *DefaultControllerServer) ControllerGetCapabilities(ctx context.Context, req *csi.ControllerGetCapabilitiesRequest) (*csi.ControllerGetCapabilitiesResponse, error)

ControllerGetCapabilities implements the default GRPC callout. Default supports all capabilities

func (*DefaultControllerServer) ControllerPublishVolume

func (cs *DefaultControllerServer) ControllerPublishVolume(ctx context.Context, req *csi.ControllerPublishVolumeRequest) (*csi.ControllerPublishVolumeResponse, error)

func (*DefaultControllerServer) ControllerUnpublishVolume

func (cs *DefaultControllerServer) ControllerUnpublishVolume(ctx context.Context, req *csi.ControllerUnpublishVolumeRequest) (*csi.ControllerUnpublishVolumeResponse, error)

func (*DefaultControllerServer) CreateSnapshot

func (cs *DefaultControllerServer) CreateSnapshot(ctx context.Context, req *csi.CreateSnapshotRequest) (*csi.CreateSnapshotResponse, error)

func (*DefaultControllerServer) CreateVolume

func (cs *DefaultControllerServer) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest) (*csi.CreateVolumeResponse, error)

func (*DefaultControllerServer) DeleteSnapshot

func (cs *DefaultControllerServer) DeleteSnapshot(ctx context.Context, req *csi.DeleteSnapshotRequest) (*csi.DeleteSnapshotResponse, error)

func (*DefaultControllerServer) DeleteVolume

func (cs *DefaultControllerServer) DeleteVolume(ctx context.Context, req *csi.DeleteVolumeRequest) (*csi.DeleteVolumeResponse, error)

func (*DefaultControllerServer) GetCapacity

func (cs *DefaultControllerServer) GetCapacity(ctx context.Context, req *csi.GetCapacityRequest) (*csi.GetCapacityResponse, error)

func (*DefaultControllerServer) ListSnapshots

func (cs *DefaultControllerServer) ListSnapshots(ctx context.Context, req *csi.ListSnapshotsRequest) (*csi.ListSnapshotsResponse, error)

func (*DefaultControllerServer) ListVolumes

func (cs *DefaultControllerServer) ListVolumes(ctx context.Context, req *csi.ListVolumesRequest) (*csi.ListVolumesResponse, error)

func (*DefaultControllerServer) ValidateControllerServiceRequest

func (cs *DefaultControllerServer) ValidateControllerServiceRequest(c csi.ControllerServiceCapability_RPC_Type) error

type DriverMode

type DriverMode string

const (
	// Node driver with support for provisioning.
	Node DriverMode = "node"
	// The controller with the rescheduler. For historic reasons this is called "webhooks".
	Controller DriverMode = "webhooks"
	// Convert each raw namespace into fsdax.
	ForceConvertRawNamespaces = "force-convert-raw-namespaces"
)

The mode strings are part of the metrics API (-> csi_controller, csi_node as subsystem), do not change them!

func (*DriverMode) Set

func (mode *DriverMode) Set(value string) error

func (*DriverMode) String

func (mode *DriverMode) String() string