Documentation
¶
Index ¶
- func NewIdentityService(name string, version string, ready func() (bool, error)) csi.IdentityServer
- func NewNodeService(name string, nodeId string) csi.NodeServer
- type GrpcServer
- type GrpcServerConfig
- type IdentityService
- func (s IdentityService) GetPluginCapabilities(ctx context.Context, req *csi.GetPluginCapabilitiesRequest) (*csi.GetPluginCapabilitiesResponse, error)
- func (s IdentityService) GetPluginInfo(ctx context.Context, req *csi.GetPluginInfoRequest) (*csi.GetPluginInfoResponse, error)
- func (s IdentityService) Probe(ctx context.Context, req *csi.ProbeRequest) (*csi.ProbeResponse, error)
- type NodeService
- func (n *NodeService) NodeGetCapabilities(ctx context.Context, req *csi.NodeGetCapabilitiesRequest) (*csi.NodeGetCapabilitiesResponse, error)
- func (n *NodeService) NodeGetInfo(ctx context.Context, req *csi.NodeGetInfoRequest) (*csi.NodeGetInfoResponse, error)
- func (n *NodeService) NodePublishVolume(ctx context.Context, req *csi.NodePublishVolumeRequest) (*csi.NodePublishVolumeResponse, error)
- func (n *NodeService) NodeUnpublishVolume(ctx context.Context, req *csi.NodeUnpublishVolumeRequest) (*csi.NodeUnpublishVolumeResponse, error)
- type StatusService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewIdentityService ¶
NewIdentityService returns a new IdentityService.
ready is a function to check the plugin status. It should return non-nil error if the plugin is not healthy. If the plugin is not yet ready, it should return (false, nil). Otherwise, return (true, nil).
func NewNodeService ¶
func NewNodeService(name string, nodeId string) csi.NodeServer
Types ¶
type GrpcServer ¶
type GrpcServer interface {
// start the service
Start()
// Graceful shutdown
Stop()
// Forced shutdown
ForceStop()
}
func NewGrpcServer ¶
func NewGrpcServer(config GrpcServerConfig) GrpcServer
type GrpcServerConfig ¶
type GrpcServerConfig struct {
Endpoint string
IdServer csi.IdentityServer
NodeServer csi.NodeServer
}
type IdentityService ¶
type IdentityService struct {
csi.UnimplementedIdentityServer
// contains filtered or unexported fields
}
IdentityService handles requests from the container orchestrator to determine readiness, capabilities, and identify the driver
func (IdentityService) GetPluginCapabilities ¶
func (s IdentityService) GetPluginCapabilities(ctx context.Context, req *csi.GetPluginCapabilitiesRequest) (*csi.GetPluginCapabilitiesResponse, error)
func (IdentityService) GetPluginInfo ¶
func (s IdentityService) GetPluginInfo(ctx context.Context, req *csi.GetPluginInfoRequest) (*csi.GetPluginInfoResponse, error)
func (IdentityService) Probe ¶
func (s IdentityService) Probe(ctx context.Context, req *csi.ProbeRequest) (*csi.ProbeResponse, error)
type NodeService ¶
type NodeService struct {
csi.UnimplementedNodeServer
// contains filtered or unexported fields
}
func (*NodeService) NodeGetCapabilities ¶
func (n *NodeService) NodeGetCapabilities(ctx context.Context, req *csi.NodeGetCapabilitiesRequest) (*csi.NodeGetCapabilitiesResponse, error)
func (*NodeService) NodeGetInfo ¶
func (n *NodeService) NodeGetInfo(ctx context.Context, req *csi.NodeGetInfoRequest) (*csi.NodeGetInfoResponse, error)
func (*NodeService) NodePublishVolume ¶
func (n *NodeService) NodePublishVolume(ctx context.Context, req *csi.NodePublishVolumeRequest) (*csi.NodePublishVolumeResponse, error)
func (*NodeService) NodeUnpublishVolume ¶
func (n *NodeService) NodeUnpublishVolume(ctx context.Context, req *csi.NodeUnpublishVolumeRequest) (*csi.NodeUnpublishVolumeResponse, error)
type StatusService ¶
type StatusService struct {
}
func NewStatusService ¶
func NewStatusService() StatusService
func (StatusService) Ready ¶
func (s StatusService) Ready() (bool, error)
Ready will check and validate that the driver is ready
if the driver is not ready an error will be reported explaining the cause of unready
Source Files
Click to show internal directories.
Click to hide internal directories.