rclone

package
v0.4.11 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 18, 2026 License: Apache-2.0 Imports: 33 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// DefaultDriverName is the default name of the driver
	DefaultDriverName = "rclone.csi.veloxpack.io"
)

Variables

This section is empty.

Functions

func GetVersionString 

func GetVersionString(driverName string) string

GetVersionString returns a formatted version string

func GetVersionYAML 

func GetVersionYAML(driverName string) (string, error)

GetVersionYAML returns the version information of the driver in YAML format

func InitRcloneLogging 

func InitRcloneLogging()

InitRcloneLogging sets up rclone to log through klog This should be called during driver initialization before any rclone operations

func NewControllerServiceCapability 

func NewControllerServiceCapability(c csi.ControllerServiceCapability_RPC_Type) *csi.ControllerServiceCapability

NewControllerServiceCapability creates a new controller service capability

func NewFakeMounter 

func NewFakeMounter() (*mount.SafeFormatAndMount, error)

func NewNodeServiceCapability 

func NewNodeServiceCapability(c csi.NodeServiceCapability_RPC_Type) *csi.NodeServiceCapability

NewNodeServiceCapability creates a new node service capability

func ParseEndpoint 

func ParseEndpoint(ep string) (string, string, error)

ParseEndpoint parses the CSI endpoint

Types

type ControllerServer 

type ControllerServer struct {
	Driver *Driver
	csi.UnimplementedControllerServer
}

ControllerServer implements the CSI Controller service

func NewControllerServer 

func NewControllerServer(d *Driver) *ControllerServer

NewControllerServer creates a new ControllerServer

func (*ControllerServer) ControllerExpandVolume 

func (cs *ControllerServer) ControllerExpandVolume(_ context.Context, _ *csi.ControllerExpandVolumeRequest) (*csi.ControllerExpandVolumeResponse, error)

ControllerExpandVolume is not implemented

func (*ControllerServer) ControllerGetCapabilities 

func (cs *ControllerServer) ControllerGetCapabilities(_ context.Context, _ *csi.ControllerGetCapabilitiesRequest) (*csi.ControllerGetCapabilitiesResponse, error)

ControllerGetCapabilities returns the capabilities of the controller

func (*ControllerServer) ControllerGetVolume 

func (cs *ControllerServer) ControllerGetVolume(_ context.Context, _ *csi.ControllerGetVolumeRequest) (*csi.ControllerGetVolumeResponse, error)

ControllerGetVolume is not implemented

func (*ControllerServer) ControllerModifyVolume 

func (cs *ControllerServer) ControllerModifyVolume(_ context.Context, _ *csi.ControllerModifyVolumeRequest) (*csi.ControllerModifyVolumeResponse, error)

ControllerModifyVolume is not implemented

func (*ControllerServer) ControllerPublishVolume 

func (cs *ControllerServer) ControllerPublishVolume(_ context.Context, _ *csi.ControllerPublishVolumeRequest) (*csi.ControllerPublishVolumeResponse, error)

ControllerPublishVolume is not implemented

func (*ControllerServer) ControllerUnpublishVolume 

func (cs *ControllerServer) ControllerUnpublishVolume(_ context.Context, _ *csi.ControllerUnpublishVolumeRequest) (*csi.ControllerUnpublishVolumeResponse, error)

ControllerUnpublishVolume is not implemented

func (*ControllerServer) CreateVolume 

func (cs *ControllerServer) CreateVolume(_ context.Context, req *csi.CreateVolumeRequest) (*csi.CreateVolumeResponse, error)

CreateVolume validates volume parameters

func (*ControllerServer) DeleteVolume 

func (cs *ControllerServer) DeleteVolume(_ context.Context, req *csi.DeleteVolumeRequest) (*csi.DeleteVolumeResponse, error)

DeleteVolume is a no-op for rclone (no cleanup needed)

func (*ControllerServer) GetCapacity 

func (cs *ControllerServer) GetCapacity(_ context.Context, _ *csi.GetCapacityRequest) (*csi.GetCapacityResponse, error)

GetCapacity is not implemented

func (*ControllerServer) ListVolumes 

func (cs *ControllerServer) ListVolumes(_ context.Context, _ *csi.ListVolumesRequest) (*csi.ListVolumesResponse, error)

ListVolumes is not implemented

func (*ControllerServer) ValidateVolumeCapabilities 

func (cs *ControllerServer) ValidateVolumeCapabilities(_ context.Context, req *csi.ValidateVolumeCapabilitiesRequest) (*csi.ValidateVolumeCapabilitiesResponse, error)

ValidateVolumeCapabilities validates volume capabilities

type Driver 

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

Driver is the main driver structure

func NewDriver 

func NewDriver(options *DriverOptions) *Driver

NewDriver creates a new driver instance

func (*Driver) AddControllerServiceCapabilities 

func (d *Driver) AddControllerServiceCapabilities(cl []csi.ControllerServiceCapability_RPC_Type)

AddControllerServiceCapabilities adds controller service capabilities

func (*Driver) AddNodeServiceCapabilities 

func (d *Driver) AddNodeServiceCapabilities(nl []csi.NodeServiceCapability_RPC_Type)

AddNodeServiceCapabilities adds node service capabilities

func (*Driver) Run 

func (d *Driver) Run(testMode bool)

Run starts the CSI driver

type DriverOptions 

type DriverOptions struct {
	NodeID     string
	DriverName string
	Endpoint   string
}

DriverOptions defines driver parameters specified in driver deployment

type IdentityServer 

type IdentityServer struct {
	Driver *Driver
	csi.UnimplementedIdentityServer
}

IdentityServer implements the CSI Identity service

func NewDefaultIdentityServer 

func NewDefaultIdentityServer(d *Driver) *IdentityServer

NewDefaultIdentityServer creates a new default IdentityServer

func (*IdentityServer) GetPluginCapabilities 

func (ids *IdentityServer) GetPluginCapabilities(_ context.Context, _ *csi.GetPluginCapabilitiesRequest) (*csi.GetPluginCapabilitiesResponse, error)

GetPluginCapabilities returns the capabilities of the plugin

func (*IdentityServer) GetPluginInfo 

func (ids *IdentityServer) GetPluginInfo(_ context.Context, _ *csi.GetPluginInfoRequest) (*csi.GetPluginInfoResponse, error)

GetPluginInfo returns plugin information including driver name and version

func (*IdentityServer) Probe 

func (ids *IdentityServer) Probe(_ context.Context, _ *csi.ProbeRequest) (*csi.ProbeResponse, error)

Probe checks whether the plugin is running or not

type NodeServer 

type NodeServer struct {
	Driver *Driver

	csi.UnimplementedNodeServer
	// contains filtered or unexported fields
}

NodeServer implements the CSI Node service

func NewNodeServer 

func NewNodeServer(d *Driver, mounter mount.Interface) *NodeServer

NewNodeServer creates a new node server

func (*NodeServer) NodeExpandVolume 

func (ns *NodeServer) NodeExpandVolume(_ context.Context, _ *csi.NodeExpandVolumeRequest) (*csi.NodeExpandVolumeResponse, error)

NodeExpandVolume is not implemented

func (*NodeServer) NodeGetCapabilities 

func (ns *NodeServer) NodeGetCapabilities(_ context.Context, _ *csi.NodeGetCapabilitiesRequest) (*csi.NodeGetCapabilitiesResponse, error)

NodeGetCapabilities returns the capabilities of the node

func (*NodeServer) NodeGetInfo 

func (ns *NodeServer) NodeGetInfo(_ context.Context, _ *csi.NodeGetInfoRequest) (*csi.NodeGetInfoResponse, error)

NodeGetInfo returns info about the node

func (*NodeServer) NodeGetVolumeStats 

func (ns *NodeServer) NodeGetVolumeStats(ctx context.Context, req *csi.NodeGetVolumeStatsRequest) (*csi.NodeGetVolumeStatsResponse, error)

NodeGetVolumeStats returns volume stats and health condition

func (*NodeServer) NodePublishVolume 

func (ns *NodeServer) NodePublishVolume(ctx context.Context, req *csi.NodePublishVolumeRequest) (*csi.NodePublishVolumeResponse, error)

NodePublishVolume mounts the rclone volume using direct rclone library integration

func (*NodeServer) NodeStageVolume 

func (ns *NodeServer) NodeStageVolume(_ context.Context, _ *csi.NodeStageVolumeRequest) (*csi.NodeStageVolumeResponse, error)

NodeStageVolume is not implemented (rclone doesn't require staging)

func (*NodeServer) NodeUnpublishVolume 

func (ns *NodeServer) NodeUnpublishVolume(_ context.Context, req *csi.NodeUnpublishVolumeRequest) (*csi.NodeUnpublishVolumeResponse, error)

NodeUnpublishVolume unmounts the rclone volume using direct stats access

func (*NodeServer) NodeUnstageVolume 

func (ns *NodeServer) NodeUnstageVolume(_ context.Context, _ *csi.NodeUnstageVolumeRequest) (*csi.NodeUnstageVolumeResponse, error)

NodeUnstageVolume is not implemented (rclone doesn't require staging)

type NonBlockingGRPCServer 

type NonBlockingGRPCServer interface {
	// Start services at the endpoint
	Start(endpoint string, ids csi.IdentityServer, cs csi.ControllerServer, ns csi.NodeServer, testMode bool)
	// Wait for the service to stop
	Wait()
	// Stop the service gracefully
	Stop()
	// ForceStop stops the service forcefully
	ForceStop()
}

NonBlockingGRPCServer defines Non blocking GRPC server interfaces

func NewNonBlockingGRPCServer 

func NewNonBlockingGRPCServer() NonBlockingGRPCServer

NewNonBlockingGRPCServer creates a new NonBlockingGRPCServer

type VersionInfo 

type VersionInfo struct {
	DriverName    string `json:"Driver Name"`
	DriverVersion string `json:"Driver Version"`
	RcloneVersion string `json:"Rclone Version"`
	GitCommit     string `json:"Git Commit"`
	BuildDate     string `json:"Build Date"`
	GoVersion     string `json:"Go Version"`
	Compiler      string `json:"Compiler"`
	Platform      string `json:"Platform"`
}

VersionInfo holds the version information of the driver

func GetVersion 

func GetVersion(driverName string) VersionInfo

GetVersion returns the version information of the driver

type VolumeLocks 

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

VolumeLocks manages locks for volume operations

func NewVolumeLocks 

func NewVolumeLocks() *VolumeLocks

NewVolumeLocks creates a new VolumeLocks instance

func (*VolumeLocks) Release 

func (vl *VolumeLocks) Release(volumeID string)

Release releases the lock for the given volumeID

func (*VolumeLocks) TryAcquire 

func (vl *VolumeLocks) TryAcquire(volumeID string) bool

TryAcquire attempts to acquire a lock for the given volumeID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.