gocsi

package module

Go to main page

Versions in this module

v1

v1.13.0

Jan 9, 2025

v1.12.0

Oct 23, 2024

v1.11.0

Jul 10, 2024

v1.10.1

Apr 30, 2024

v1.10.0

Feb 22, 2024

v1.9.0

Nov 9, 2023

v1.8.0

Mar 3, 2023

v1.7.0

Mar 3, 2023

v1.6.0

May 31, 2022

v1.5.1

Feb 18, 2022

v1.5.0

Oct 14, 2021

v1.4.0

Sep 3, 2021

v1.3.1

Aug 31, 2021

v1.3.0

Jun 11, 2021

v1.2.3

Mar 12, 2021

Changes in this version

+ const EnvVarDisableFieldLen

+ const EnvVarLoggingDisableVolCtx

+ const EnvVarRequirePubContext

+ const EnvVarRequireVolContext

type StoragePlugin

+ RegisterAdditionalServers func(*grpc.Server)

v1.0.1

Mar 25, 2020

v1.0.0

Jan 30, 2019

Changes in this version

+ const EnvVarRequirePubVolContext

v0

v0.4.0

Mar 5, 2018

Changes in this version

+ const EnvVarCredsNodeStgVol

+ const EnvVarRequireStagingTargetPath

v0.3.3

Feb 19, 2018

v0.3.2

Feb 16, 2018

Changes in this version

+ const EnvVarMode

v0.3.1

Feb 13, 2018

v0.3.0

Feb 13, 2018

Changes in this version

+ const EnvVarCreds

+ const EnvVarCredsCreateVol

+ const EnvVarCredsCtrlrPubVol

+ const EnvVarCredsCtrlrUnpubVol

+ const EnvVarCredsDeleteVol

+ const EnvVarCredsNodePubVol

+ const EnvVarCredsNodeUnpubVol

+ const EnvVarCtrlSvcOnly

+ const EnvVarDebug

+ const EnvVarEndpoint

+ const EnvVarEndpointGroup

+ const EnvVarEndpointPerms

+ const EnvVarEndpointUser

+ const EnvVarLogLevel

+ const EnvVarNodeSvcOnly

+ const EnvVarPluginInfo

+ const EnvVarPrivateMountDir

+ const EnvVarRepLogging

+ const EnvVarReqIDInjection

+ const EnvVarReqLogging

+ const EnvVarRequireNodeID

+ const EnvVarRequirePubVolInfo

+ const EnvVarRequireVolAttribs

+ const EnvVarSerialVolAccess

+ const EnvVarSerialVolAccessEtcdAutoSyncInterval

+ const EnvVarSerialVolAccessEtcdDialKeepAliveTime

+ const EnvVarSerialVolAccessEtcdDialKeepAliveTimeout

+ const EnvVarSerialVolAccessEtcdDialTimeout

+ const EnvVarSerialVolAccessEtcdDomain

+ const EnvVarSerialVolAccessEtcdEndpoints

+ const EnvVarSerialVolAccessEtcdMaxCallRecvMsgSz

+ const EnvVarSerialVolAccessEtcdMaxCallSendMsgSz

+ const EnvVarSerialVolAccessEtcdPassword

+ const EnvVarSerialVolAccessEtcdRejectOldCluster

+ const EnvVarSerialVolAccessEtcdTLS

+ const EnvVarSerialVolAccessEtcdTLSInsecure

+ const EnvVarSerialVolAccessEtcdTTL

+ const EnvVarSerialVolAccessEtcdUsername

+ const EnvVarSerialVolAccessTimeout

+ const EnvVarSpecRepValidation

+ const EnvVarSpecReqValidation

+ const EnvVarSpecValidation

+ const EnvVarSupportedVersions

+ func Run(ctx context.Context, appName, appDescription, appUsage string, ...)

+ type StoragePlugin struct

+ BeforeServe func(context.Context, *StoragePlugin, net.Listener) error

+ Controller csi.ControllerServer

+ EnvVars []string

+ Identity csi.IdentityServer

+ Interceptors []grpc.UnaryServerInterceptor

+ Node csi.NodeServer

+ ServerOpts []grpc.ServerOption

+ func (sp *StoragePlugin) GracefulStop(ctx context.Context)

+ func (sp *StoragePlugin) Serve(ctx context.Context, lis net.Listener) error

+ func (sp *StoragePlugin) Stop(ctx context.Context)

+ type StoragePluginProvider interface

+ GracefulStop func(ctx context.Context)

+ Serve func(ctx context.Context, lis net.Listener) error

+ Stop func(ctx context.Context)

v0.2.4

Dec 4, 2017

Changes in this version

+ func ErrVolumeNotFound(id string) error

+ func ParseMapWS(line string) map[string]string

+ func ParseSlice(line string) []string

v0.2.3

Nov 27, 2017

Changes in this version

+ func WithEnviron(ctx context.Context, v []string) context.Context

v0.2.2

Nov 27, 2017

v0.2.1

Nov 27, 2017

v0.2.0

Nov 26, 2017

Changes in this version

+ const ControllerProbe

+ const NodeProbe

+ var ErrAccessModeRequired = status.Error(codes.InvalidArgument, "acess mode required")

+ var ErrAccessTypeRequired = status.Error(codes.InvalidArgument, "acess type required")

+ var ErrBlockTypeRequired = status.Error(codes.InvalidArgument, "block type required")

+ var ErrEmptyNodeID = status.Error(codes.Internal, "empty node ID")

+ var ErrEmptyPluginName = status.Error(codes.Internal, "empty plug-in name")

+ var ErrEmptySupportedVersions = status.Error(codes.Internal, "empty supported versions")

+ var ErrEmptyVendorVersion = status.Error(codes.Internal, "empty vendor version")

+ var ErrEmptyVolumeID = status.Error(codes.Internal, "empty volumeInfo.Id")

+ var ErrMountTypeRequired = status.Error(codes.InvalidArgument, "mount type required")

+ var ErrNodeIDRequired = status.Error(codes.InvalidArgument, "node ID required")

+ var ErrNonNilControllerCapabilities = status.Error(codes.Internal, "non-nil, empty controller capabilities")

+ var ErrNonNilEmptyAttribs = status.Error(codes.Internal, "non-nil, empty volumeInfo.Attributes")

+ var ErrNonNilEmptyPluginManifest = status.Error(codes.Internal, "non-nil, empty plug-in manifest")

+ var ErrNonNilNodeCapabilities = status.Error(codes.Internal, "non-nil, empty node capabilities")

+ var ErrOpPending = status.Error(codes.FailedPrecondition, "op pending")

+ var ErrPublishVolumeInfoRequired = status.Error(codes.InvalidArgument, "publish volume info required")

+ var ErrTargetPathRequired = status.Error(codes.InvalidArgument, "target path required")

+ var ErrUserCredentialsRequired = status.Error(codes.InvalidArgument, "user credentials required")

+ var ErrVolumeAttributesRequired = status.Error(codes.InvalidArgument, "volume attributes required")

+ var ErrVolumeCapabilitiesRequired = status.Error(codes.InvalidArgument, "volume capabilities required")

+ var ErrVolumeNameRequired = status.Error(codes.InvalidArgument, "volume name required")

+ func FprintfVersion(w io.Writer, v csi.Version) (int, error)

+ func IsSuccess(err error, successCodes ...codes.Code) error

+ func IsSuccessfulResponse(method string, err error) error

+ func LookupEnv(ctx context.Context, key string) (string, bool)

+ func NewClientLogger(opts ...LoggingOption) grpc.UnaryClientInterceptor

+ func NewClientRequestIDInjector() grpc.UnaryClientInterceptor

+ func NewClientSpecValidator(opts ...SpecValidatorOption) grpc.UnaryClientInterceptor

+ func NewServerLogger(opts ...LoggingOption) grpc.UnaryServerInterceptor

+ func NewServerRequestIDInjector() grpc.UnaryServerInterceptor

+ func NewServerSpecValidator(opts ...SpecValidatorOption) grpc.UnaryServerInterceptor

+ func PageVolumes(ctx context.Context, client csi.ControllerClient, req csi.ListVolumesRequest, ...) (<-chan csi.VolumeInfo, <-chan error)

+ func ParseMap(line string) map[string]string

+ func ParseVersions(s string) []csi.Version

+ func Setenv(ctx context.Context, key, val string) error

+ func WithLookupEnv(ctx context.Context, f lookupEnvFunc) context.Context

+ func WithSetenv(ctx context.Context, f setenvFunc) context.Context

type IdempotencyProvider

+ GetVolumeID func(ctx context.Context, name string) (string, error)

+ type IdempotentInterceptorOption func(*idempIntercOpts)

+ func WithIdempRequireVolumeExists() IdempotentInterceptorOption

+ func WithIdempTimeout(t time.Duration) IdempotentInterceptorOption

+ type LoggingOption func(*loggingOpts)

+ func WithRequestLogging(w io.Writer) LoggingOption

+ func WithResponseLogging(w io.Writer) LoggingOption

+ type PipeConn interface

+ DialGrpc func(raddr string, timeout time.Duration) (net.Conn, error)

+ DialHTTP func(ctx context.Context, network, addr string) (net.Conn, error)

+ func NewPipeConn(name string) PipeConn

+ type SpecValidatorOption func(*specValidatorOpts)

+ func WithRequiresControllerPublishVolumeCredentials() SpecValidatorOption

+ func WithRequiresControllerUnpublishVolumeCredentials() SpecValidatorOption

+ func WithRequiresCreateVolumeCredentials() SpecValidatorOption

+ func WithRequiresDeleteVolumeCredentials() SpecValidatorOption

+ func WithRequiresNodeID() SpecValidatorOption

+ func WithRequiresNodePublishVolumeCredentials() SpecValidatorOption

+ func WithRequiresNodeUnpublishVolumeCredentials() SpecValidatorOption

+ func WithRequiresPublishVolumeInfo() SpecValidatorOption

+ func WithRequiresVolumeAttributes() SpecValidatorOption

+ func WithSuccessCreateVolumeAlreadyExists() SpecValidatorOption

+ func WithSuccessDeleteVolumeNotFound() SpecValidatorOption

+ func WithSupportedVersions(versions ...csi.Version) SpecValidatorOption

v0.1.0

Sep 10, 2017

Changes in this version

+ const CSIEndpoint

+ const ErrorNoCode

+ const FMControllerGetCapabilities

+ const FMControllerPublishVolume

+ const FMControllerUnpublishVolume

+ const FMCreateVolume

+ const FMDeleteVolume

+ const FMGetCapacity

+ const FMGetNodeID

+ const FMGetPluginInfo

+ const FMGetSupportedVersions

+ const FMListVolumes

+ const FMNodeGetCapabilities

+ const FMNodePublishVolume

+ const FMNodeUnpublishVolume

+ const FMProbeNode

+ const FMValidateVolumeCapabilities

+ const Namespace

+ var ErrEmptyPublishVolumeInfo = errors.New("publishVolumeInfo is empty")

+ var ErrEmptyServices = errors.New("services list is empty")

+ var ErrInvalidProvider = errors.New("invalid service provider")

+ var ErrInvalidTargetPath = errors.New("invalid targetPath")

+ var ErrMissingCSIEndpoint = errors.New("missing CSI_ENDPOINT")

+ var ErrNilNodeID = errors.New("nodeID is nil")

+ var ErrNilPublishVolumeInfo = errors.New("publishVolumeInfo is nil")

+ var ErrNilResult = errors.New("result is nil")

+ var ErrNilSupportedVersions = errors.New("supportedVersions is nil")

+ var ErrNilVolumeID = errors.New("volumeInfo.Id is nil")

+ var ErrNilVolumeInfo = errors.New("volumeInfo is nil")

+ var ErrParseProtoAddrRequired = errors.New("non-empty network address is required")

+ var ErrVersionRequired = errors.New("version is required")

+ var ErrVolumeCapabilityRequired = errors.New("volumeCapability is required")

+ var ErrVolumeIDRequired = errors.New("volumeID is required")

+ var ErrVolumeInfoRequired = errors.New("volumeInfo is required")

+ func ChainUnaryClient(i ...grpc.UnaryClientInterceptor) grpc.UnaryClientInterceptor

+ func ChainUnaryServer(i ...grpc.UnaryServerInterceptor) grpc.UnaryServerInterceptor

+ func CheckResponseErrControllerGetCapabilities(ctx context.Context, method string, ...) error

+ func CheckResponseErrControllerPublishVolume(ctx context.Context, method string, ...) error

+ func CheckResponseErrControllerUnpublishVolume(ctx context.Context, method string, ...) error

+ func CheckResponseErrCreateVolume(ctx context.Context, method string, response *csi.CreateVolumeResponse) error

+ func CheckResponseErrDeleteVolume(ctx context.Context, method string, response *csi.DeleteVolumeResponse) error

+ func CheckResponseErrGetCapacity(ctx context.Context, method string, response *csi.GetCapacityResponse) error

+ func CheckResponseErrGetNodeID(ctx context.Context, method string, response *csi.GetNodeIDResponse) error

+ func CheckResponseErrGetPluginInfo(ctx context.Context, method string, response *csi.GetPluginInfoResponse) error

+ func CheckResponseErrGetSupportedVersions(ctx context.Context, method string, response *csi.GetSupportedVersionsResponse) error

+ func CheckResponseErrListVolumes(ctx context.Context, method string, response *csi.ListVolumesResponse) error

+ func CheckResponseErrNodeGetCapabilities(ctx context.Context, method string, response *csi.NodeGetCapabilitiesResponse) error

+ func CheckResponseErrNodePublishVolume(ctx context.Context, method string, response *csi.NodePublishVolumeResponse) error

+ func CheckResponseErrNodeUnpublishVolume(ctx context.Context, method string, response *csi.NodeUnpublishVolumeResponse) error

+ func CheckResponseErrProbeNode(ctx context.Context, method string, response *csi.ProbeNodeResponse) error

+ func CheckResponseErrValidateVolumeCapabilities(ctx context.Context, method string, ...) error

+ func ClientCheckReponseError(ctx context.Context, method string, req, rep interface{}, cc *grpc.ClientConn, ...) error

+ func ClientResponseValidator(ctx context.Context, method string, req, rep interface{}, cc *grpc.ClientConn, ...) error

+ func CompareVersions(a, b Version) int8

+ func ControllerGetCapabilities(ctx context.Context, c csi.ControllerClient, version *csi.Version, ...) (capabilties []*csi.ControllerServiceCapability, err error)

+ func ControllerPublishVolume(ctx context.Context, c csi.ControllerClient, version *csi.Version, ...) (*csi.PublishVolumeInfo, error)

+ func ControllerUnpublishVolume(ctx context.Context, c csi.ControllerClient, version *csi.Version, ...) error

+ func CreateVolume(ctx context.Context, c csi.ControllerClient, version *csi.Version, name string, ...) (volume *csi.VolumeInfo, err error)

+ func DeleteVolume(ctx context.Context, c csi.ControllerClient, version *csi.Version, ...) error

+ func ErrControllerGetCapabilities(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.ControllerGetCapabilitiesResponse

+ func ErrControllerPublishVolume(code csi.Error_ControllerPublishVolumeError_ControllerPublishVolumeErrorCode, ...) *csi.ControllerPublishVolumeResponse

+ func ErrControllerPublishVolumeGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.ControllerPublishVolumeResponse

+ func ErrControllerUnpublishVolume(...) *csi.ControllerUnpublishVolumeResponse

+ func ErrControllerUnpublishVolumeGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.ControllerUnpublishVolumeResponse

+ func ErrCreateVolume(code csi.Error_CreateVolumeError_CreateVolumeErrorCode, msg string) *csi.CreateVolumeResponse

+ func ErrCreateVolumeGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.CreateVolumeResponse

+ func ErrDeleteVolume(code csi.Error_DeleteVolumeError_DeleteVolumeErrorCode, msg string) *csi.DeleteVolumeResponse

+ func ErrDeleteVolumeGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.DeleteVolumeResponse

+ func ErrGetCapacity(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.GetCapacityResponse

+ func ErrGetNodeID(code csi.Error_GetNodeIDError_GetNodeIDErrorCode, msg string) *csi.GetNodeIDResponse

+ func ErrGetNodeIDGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.GetNodeIDResponse

+ func ErrGetPluginInfo(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.GetPluginInfoResponse

+ func ErrGetSupportedVersions(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.GetSupportedVersionsResponse

+ func ErrListVolumes(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.ListVolumesResponse

+ func ErrNodeGetCapabilities(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.NodeGetCapabilitiesResponse

+ func ErrNodePublishVolume(code csi.Error_NodePublishVolumeError_NodePublishVolumeErrorCode, msg string) *csi.NodePublishVolumeResponse

+ func ErrNodePublishVolumeGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.NodePublishVolumeResponse

+ func ErrNodeUnpublishVolume(code csi.Error_NodeUnpublishVolumeError_NodeUnpublishVolumeErrorCode, ...) *csi.NodeUnpublishVolumeResponse

+ func ErrNodeUnpublishVolumeGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.NodeUnpublishVolumeResponse

+ func ErrProbeNode(code csi.Error_ProbeNodeError_ProbeNodeErrorCode, msg string) *csi.ProbeNodeResponse

+ func ErrProbeNodeGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.ProbeNodeResponse

+ func ErrValidateVolumeCapabilities(...) *csi.ValidateVolumeCapabilitiesResponse

+ func ErrValidateVolumeCapabilitiesGeneral(code csi.Error_GeneralError_GeneralErrorCode, msg string) *csi.ValidateVolumeCapabilitiesResponse

+ func GetCSIEndpoint() (network, addr string, err error)

+ func GetCSIEndpointListener() (net.Listener, error)

+ func GetCapacity(ctx context.Context, c csi.ControllerClient, version *csi.Version, ...) (uint64, error)

+ func GetNodeID(ctx context.Context, c csi.NodeClient, version *csi.Version, ...) (*csi.NodeID, error)

+ func GetPluginInfo(ctx context.Context, c csi.IdentityClient, version *csi.Version, ...) (*csi.GetPluginInfoResponse_Result, error)

+ func GetRequestID(ctx context.Context) (uint64, bool)

+ func GetSupportedVersions(ctx context.Context, c csi.IdentityClient, callOpts ...grpc.CallOption) ([]*csi.Version, error)

+ func ListVolumes(ctx context.Context, c csi.ControllerClient, version *csi.Version, ...) (volumes []*csi.VolumeInfo, nextToken string, err error)

+ func NewBlockCapability(mode csi.VolumeCapability_AccessMode_Mode) *csi.VolumeCapability

+ func NewIdempotentInterceptor(p IdempotencyProvider, timeout time.Duration) grpc.UnaryServerInterceptor

+ func NewMountCapability(mode csi.VolumeCapability_AccessMode_Mode, fsType string, mountFlags []string) *csi.VolumeCapability

+ func NewServerRequestLogger(stdout, stderr io.Writer) grpc.UnaryServerInterceptor

+ func NewServerRequestVersionValidator(supported []*csi.Version) grpc.UnaryServerInterceptor

+ func NewServerResponseLogger(stdout, stderr io.Writer) grpc.UnaryServerInterceptor

+ func NodeGetCapabilities(ctx context.Context, c csi.NodeClient, version *csi.Version, ...) (capabilties []*csi.NodeServiceCapability, err error)

+ func NodePublishVolume(ctx context.Context, c csi.NodeClient, version *csi.Version, ...) error

+ func NodeUnpublishVolume(ctx context.Context, c csi.NodeClient, version *csi.Version, ...) error

+ func ParseProtoAddr(protoAddr string) (proto string, addr string, err error)

+ func ProbeNode(ctx context.Context, c csi.NodeClient, version *csi.Version, ...) error

+ func ServerRequestIDInjector(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (interface{}, error)

+ func ServerRequestValidator(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (interface{}, error)

+ func SprintfVersion(v Version) string

+ func ValidateVolumeCapabilities(ctx context.Context, c csi.ControllerClient, version *csi.Version, ...) (*csi.ValidateVolumeCapabilitiesResponse_Result, error)

+ type Error struct

+ Code int32

+ Description string

+ FullMethod string

+ InnerError error

+ func (e *Error) Error() string

+ func (e *Error) ErrorCode() int32

+ func (e *Error) ErrorDescription() string

+ func (e *Error) ErrorFullMethod() string

+ func (e *Error) ErrorMethod() string

+ func (e *Error) MarshalText() (text []byte, err error)

+ func (e *Error) String() string

+ type IdempotencyProvider interface

+ GetVolumeInfo func(ctx context.Context, name string) (*csi.VolumeInfo, error)

+ GetVolumeName func(ctx context.Context, id *csi.VolumeID) (string, error)

+ IsControllerPublished func(ctx context.Context, id *csi.VolumeID) (*csi.PublishVolumeInfo, error)

+ IsNodePublished func(ctx context.Context, id *csi.VolumeID, pubVolInfo *csi.PublishVolumeInfo, ...) (bool, error)

+ type MutexWithTryLock interface

+ Lock func()

+ TryLock func(timeout time.Duration) bool

+ Unlock func()

+ func NewMutexWithTryLock() MutexWithTryLock

+ type Version interface

+ GetMajor func() uint32

+ GetMinor func() uint32

+ GetPatch func() uint32

+ func ParseVersion(s string) (Version, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL