v1beta1

package
v1.1.3 Latest Latest
Warning

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

Go to latest
Published: Aug 23, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var PathContext_name = map[int32]string{
	0: "PLUGIN",
	1: "POD",
}
View Source
var PathContext_value = map[string]int32{
	"PLUGIN": 0,
	"POD":    1,
}

Functions

func RegisterFilesystemServer

func RegisterFilesystemServer(s *grpc.Server, srv FilesystemServer)

Types

type FilesystemClient

type FilesystemClient interface {
	// PathExists checks if the requested path exists in the host's filesystem
	PathExists(ctx context.Context, in *PathExistsRequest, opts ...grpc.CallOption) (*PathExistsResponse, error)
	// Mkdir creates a directory at the requested path in the host's filesystem
	Mkdir(ctx context.Context, in *MkdirRequest, opts ...grpc.CallOption) (*MkdirResponse, error)
	// Rmdir removes the directory at the requested path in the host's filesystem.
	// This may be used for unlinking a symlink created through LinkPath
	Rmdir(ctx context.Context, in *RmdirRequest, opts ...grpc.CallOption) (*RmdirResponse, error)
	// LinkPath creates a local directory symbolic link between a source path
	// and target path in the host's filesystem
	LinkPath(ctx context.Context, in *LinkPathRequest, opts ...grpc.CallOption) (*LinkPathResponse, error)
	//IsMountPoint checks if a given path is mount or not
	IsMountPoint(ctx context.Context, in *IsMountPointRequest, opts ...grpc.CallOption) (*IsMountPointResponse, error)
}

FilesystemClient is the client API for Filesystem service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewFilesystemClient

func NewFilesystemClient(cc *grpc.ClientConn) FilesystemClient

type FilesystemServer

type FilesystemServer interface {
	// PathExists checks if the requested path exists in the host's filesystem
	PathExists(context.Context, *PathExistsRequest) (*PathExistsResponse, error)
	// Mkdir creates a directory at the requested path in the host's filesystem
	Mkdir(context.Context, *MkdirRequest) (*MkdirResponse, error)
	// Rmdir removes the directory at the requested path in the host's filesystem.
	// This may be used for unlinking a symlink created through LinkPath
	Rmdir(context.Context, *RmdirRequest) (*RmdirResponse, error)
	// LinkPath creates a local directory symbolic link between a source path
	// and target path in the host's filesystem
	LinkPath(context.Context, *LinkPathRequest) (*LinkPathResponse, error)
	//IsMountPoint checks if a given path is mount or not
	IsMountPoint(context.Context, *IsMountPointRequest) (*IsMountPointResponse, error)
}

FilesystemServer is the server API for Filesystem service.

type IsMountPointRequest

type IsMountPointRequest struct {
	// The path whose existence we want to check in the host's filesystem
	Path                 string   `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*IsMountPointRequest) Descriptor

func (*IsMountPointRequest) Descriptor() ([]byte, []int)

func (*IsMountPointRequest) GetPath

func (m *IsMountPointRequest) GetPath() string

func (*IsMountPointRequest) ProtoMessage

func (*IsMountPointRequest) ProtoMessage()

func (*IsMountPointRequest) Reset

func (m *IsMountPointRequest) Reset()

func (*IsMountPointRequest) String

func (m *IsMountPointRequest) String() string

func (*IsMountPointRequest) XXX_DiscardUnknown

func (m *IsMountPointRequest) XXX_DiscardUnknown()

func (*IsMountPointRequest) XXX_Marshal

func (m *IsMountPointRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*IsMountPointRequest) XXX_Merge

func (m *IsMountPointRequest) XXX_Merge(src proto.Message)

func (*IsMountPointRequest) XXX_Size

func (m *IsMountPointRequest) XXX_Size() int

func (*IsMountPointRequest) XXX_Unmarshal

func (m *IsMountPointRequest) XXX_Unmarshal(b []byte) error

type IsMountPointResponse

type IsMountPointResponse struct {
	// Error message if any. Empty string indicates success
	Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// Indicates whether the path in PathExistsRequest exists in the host's filesystem
	IsMountPoint         bool     `protobuf:"varint,2,opt,name=is_mount_point,json=isMountPoint,proto3" json:"is_mount_point,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*IsMountPointResponse) Descriptor

func (*IsMountPointResponse) Descriptor() ([]byte, []int)

func (*IsMountPointResponse) GetError

func (m *IsMountPointResponse) GetError() string

func (*IsMountPointResponse) GetIsMountPoint

func (m *IsMountPointResponse) GetIsMountPoint() bool

func (*IsMountPointResponse) ProtoMessage

func (*IsMountPointResponse) ProtoMessage()

func (*IsMountPointResponse) Reset

func (m *IsMountPointResponse) Reset()

func (*IsMountPointResponse) String

func (m *IsMountPointResponse) String() string

func (*IsMountPointResponse) XXX_DiscardUnknown

func (m *IsMountPointResponse) XXX_DiscardUnknown()

func (*IsMountPointResponse) XXX_Marshal

func (m *IsMountPointResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*IsMountPointResponse) XXX_Merge

func (m *IsMountPointResponse) XXX_Merge(src proto.Message)

func (*IsMountPointResponse) XXX_Size

func (m *IsMountPointResponse) XXX_Size() int

func (*IsMountPointResponse) XXX_Unmarshal

func (m *IsMountPointResponse) XXX_Unmarshal(b []byte) error

type LinkPathRequest

type LinkPathRequest struct {
	// The path where the symlink is created in the host's filesystem.
	// All special characters allowed by Windows in path names will be allowed
	// except for restrictions noted below. For details, please check:
	// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
	//
	// Restrictions:
	// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
	// The path prefix needs needs to match the paths specified as
	// kubelet-csi-plugins-path parameter of csi-proxy.
	// UNC paths of the form "\\server\share\path\file" are not allowed.
	// All directory separators need to be backslash character: "\".
	// Characters: .. / : | ? * in the path are not allowed.
	// source_path cannot already exist in the host filesystem.
	// Maximum path length will be capped to 260 characters.
	SourcePath string `protobuf:"bytes,1,opt,name=source_path,json=sourcePath,proto3" json:"source_path,omitempty"`
	// Target path in the host's filesystem used for the symlink creation.
	// All special characters allowed by Windows in path names will be allowed
	// except for restrictions noted below. For details, please check:
	// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
	//
	// Restrictions:
	// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
	// The path prefix needs to match the paths specified as
	// kubelet-pod-path parameter of csi-proxy.
	// UNC paths of the form "\\server\share\path\file" are not allowed.
	// All directory separators need to be backslash character: "\".
	// Characters: .. / : | ? * in the path are not allowed.
	// target_path needs to exist as a directory in the host that is empty.
	// target_path cannot be a symbolic link.
	// Maximum path length will be capped to 260 characters.
	TargetPath           string   `protobuf:"bytes,2,opt,name=target_path,json=targetPath,proto3" json:"target_path,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*LinkPathRequest) Descriptor

func (*LinkPathRequest) Descriptor() ([]byte, []int)

func (*LinkPathRequest) GetSourcePath

func (m *LinkPathRequest) GetSourcePath() string

func (*LinkPathRequest) GetTargetPath

func (m *LinkPathRequest) GetTargetPath() string

func (*LinkPathRequest) ProtoMessage

func (*LinkPathRequest) ProtoMessage()

func (*LinkPathRequest) Reset

func (m *LinkPathRequest) Reset()

func (*LinkPathRequest) String

func (m *LinkPathRequest) String() string

func (*LinkPathRequest) XXX_DiscardUnknown

func (m *LinkPathRequest) XXX_DiscardUnknown()

func (*LinkPathRequest) XXX_Marshal

func (m *LinkPathRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LinkPathRequest) XXX_Merge

func (m *LinkPathRequest) XXX_Merge(src proto.Message)

func (*LinkPathRequest) XXX_Size

func (m *LinkPathRequest) XXX_Size() int

func (*LinkPathRequest) XXX_Unmarshal

func (m *LinkPathRequest) XXX_Unmarshal(b []byte) error

type LinkPathResponse

type LinkPathResponse struct {
	// Error message if any. Empty string indicates success
	Error                string   `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*LinkPathResponse) Descriptor

func (*LinkPathResponse) Descriptor() ([]byte, []int)

func (*LinkPathResponse) GetError

func (m *LinkPathResponse) GetError() string

func (*LinkPathResponse) ProtoMessage

func (*LinkPathResponse) ProtoMessage()

func (*LinkPathResponse) Reset

func (m *LinkPathResponse) Reset()

func (*LinkPathResponse) String

func (m *LinkPathResponse) String() string

func (*LinkPathResponse) XXX_DiscardUnknown

func (m *LinkPathResponse) XXX_DiscardUnknown()

func (*LinkPathResponse) XXX_Marshal

func (m *LinkPathResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*LinkPathResponse) XXX_Merge

func (m *LinkPathResponse) XXX_Merge(src proto.Message)

func (*LinkPathResponse) XXX_Size

func (m *LinkPathResponse) XXX_Size() int

func (*LinkPathResponse) XXX_Unmarshal

func (m *LinkPathResponse) XXX_Unmarshal(b []byte) error

type MkdirRequest

type MkdirRequest struct {
	// The path to create in the host's filesystem.
	// All special characters allowed by Windows in path names will be allowed
	// except for restrictions noted below. For details, please check:
	// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
	// Non-existent parent directories in the path will be automatically created.
	// Directories will be created with Read and Write privileges of the Windows
	// User account under which csi-proxy is started (typically LocalSystem).
	//
	// Restrictions:
	// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
	// Depending on the context parameter of this function, the path prefix needs
	// to match the paths specified either as kubelet-csi-plugins-path
	// or as kubelet-pod-path parameters of csi-proxy.
	// The path parameter cannot already exist in the host's filesystem.
	// UNC paths of the form "\\server\share\path\file" are not allowed.
	// All directory separators need to be backslash character: "\".
	// Characters: .. / : | ? * in the path are not allowed.
	// Maximum path length will be capped to 260 characters.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Context of the path parameter.
	// This is used to validate prefix for absolute paths passed
	Context              PathContext `protobuf:"varint,2,opt,name=context,proto3,enum=v1beta1.PathContext" json:"context,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*MkdirRequest) Descriptor

func (*MkdirRequest) Descriptor() ([]byte, []int)

func (*MkdirRequest) GetContext

func (m *MkdirRequest) GetContext() PathContext

func (*MkdirRequest) GetPath

func (m *MkdirRequest) GetPath() string

func (*MkdirRequest) ProtoMessage

func (*MkdirRequest) ProtoMessage()

func (*MkdirRequest) Reset

func (m *MkdirRequest) Reset()

func (*MkdirRequest) String

func (m *MkdirRequest) String() string

func (*MkdirRequest) XXX_DiscardUnknown

func (m *MkdirRequest) XXX_DiscardUnknown()

func (*MkdirRequest) XXX_Marshal

func (m *MkdirRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MkdirRequest) XXX_Merge

func (m *MkdirRequest) XXX_Merge(src proto.Message)

func (*MkdirRequest) XXX_Size

func (m *MkdirRequest) XXX_Size() int

func (*MkdirRequest) XXX_Unmarshal

func (m *MkdirRequest) XXX_Unmarshal(b []byte) error

type MkdirResponse

type MkdirResponse struct {
	// Error message if any. Empty string indicates success
	Error                string   `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*MkdirResponse) Descriptor

func (*MkdirResponse) Descriptor() ([]byte, []int)

func (*MkdirResponse) GetError

func (m *MkdirResponse) GetError() string

func (*MkdirResponse) ProtoMessage

func (*MkdirResponse) ProtoMessage()

func (*MkdirResponse) Reset

func (m *MkdirResponse) Reset()

func (*MkdirResponse) String

func (m *MkdirResponse) String() string

func (*MkdirResponse) XXX_DiscardUnknown

func (m *MkdirResponse) XXX_DiscardUnknown()

func (*MkdirResponse) XXX_Marshal

func (m *MkdirResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MkdirResponse) XXX_Merge

func (m *MkdirResponse) XXX_Merge(src proto.Message)

func (*MkdirResponse) XXX_Size

func (m *MkdirResponse) XXX_Size() int

func (*MkdirResponse) XXX_Unmarshal

func (m *MkdirResponse) XXX_Unmarshal(b []byte) error

type PathContext

type PathContext int32

Context of the paths used for path prefix validation

const (
	// Indicates the kubelet-csi-plugins-path parameter of csi-proxy be used as
	// the path context. This may be used while handling NodeStageVolume where
	// a volume may need to be mounted at a plugin-specific path like:
	// kubelet\plugins\kubernetes.io\csi\pv\<pv-name>\globalmount
	PathContext_PLUGIN PathContext = 0
	// Indicates the kubelet-pod-path parameter of csi-proxy be used as the path
	// context. This may be used while handling NodePublishVolume where a staged
	// volume may be need to be symlinked to a pod-specific path like:
	// kubelet\pods\<pod-uuid>\volumes\kubernetes.io~csi\<pvc-name>\mount
	PathContext_POD PathContext = 1
)

func (PathContext) EnumDescriptor

func (PathContext) EnumDescriptor() ([]byte, []int)

func (PathContext) String

func (x PathContext) String() string

type PathExistsRequest

type PathExistsRequest struct {
	// The path whose existence we want to check in the host's filesystem
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Context of the path parameter.
	// This is used to validate prefix for absolute paths passed
	Context              PathContext `protobuf:"varint,2,opt,name=context,proto3,enum=v1beta1.PathContext" json:"context,omitempty"`
	XXX_NoUnkeyedLiteral struct{}    `json:"-"`
	XXX_unrecognized     []byte      `json:"-"`
	XXX_sizecache        int32       `json:"-"`
}

func (*PathExistsRequest) Descriptor

func (*PathExistsRequest) Descriptor() ([]byte, []int)

func (*PathExistsRequest) GetContext

func (m *PathExistsRequest) GetContext() PathContext

func (*PathExistsRequest) GetPath

func (m *PathExistsRequest) GetPath() string

func (*PathExistsRequest) ProtoMessage

func (*PathExistsRequest) ProtoMessage()

func (*PathExistsRequest) Reset

func (m *PathExistsRequest) Reset()

func (*PathExistsRequest) String

func (m *PathExistsRequest) String() string

func (*PathExistsRequest) XXX_DiscardUnknown

func (m *PathExistsRequest) XXX_DiscardUnknown()

func (*PathExistsRequest) XXX_Marshal

func (m *PathExistsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PathExistsRequest) XXX_Merge

func (m *PathExistsRequest) XXX_Merge(src proto.Message)

func (*PathExistsRequest) XXX_Size

func (m *PathExistsRequest) XXX_Size() int

func (*PathExistsRequest) XXX_Unmarshal

func (m *PathExistsRequest) XXX_Unmarshal(b []byte) error

type PathExistsResponse

type PathExistsResponse struct {
	// Error message if any. Empty string indicates success
	Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// Indicates whether the path in PathExistsRequest exists in the host's filesystem
	Exists               bool     `protobuf:"varint,2,opt,name=exists,proto3" json:"exists,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*PathExistsResponse) Descriptor

func (*PathExistsResponse) Descriptor() ([]byte, []int)

func (*PathExistsResponse) GetError

func (m *PathExistsResponse) GetError() string

func (*PathExistsResponse) GetExists

func (m *PathExistsResponse) GetExists() bool

func (*PathExistsResponse) ProtoMessage

func (*PathExistsResponse) ProtoMessage()

func (*PathExistsResponse) Reset

func (m *PathExistsResponse) Reset()

func (*PathExistsResponse) String

func (m *PathExistsResponse) String() string

func (*PathExistsResponse) XXX_DiscardUnknown

func (m *PathExistsResponse) XXX_DiscardUnknown()

func (*PathExistsResponse) XXX_Marshal

func (m *PathExistsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PathExistsResponse) XXX_Merge

func (m *PathExistsResponse) XXX_Merge(src proto.Message)

func (*PathExistsResponse) XXX_Size

func (m *PathExistsResponse) XXX_Size() int

func (*PathExistsResponse) XXX_Unmarshal

func (m *PathExistsResponse) XXX_Unmarshal(b []byte) error

type RmdirRequest

type RmdirRequest struct {
	// The path to remove in the host's filesystem.
	// All special characters allowed by Windows in path names will be allowed
	// except for restrictions noted below. For details, please check:
	// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
	//
	// Restrictions:
	// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
	// Depending on the context parameter of this function, the path prefix needs
	// to match the paths specified either as kubelet-csi-plugins-path
	// or as kubelet-pod-path parameters of csi-proxy.
	// UNC paths of the form "\\server\share\path\file" are not allowed.
	// All directory separators need to be backslash character: "\".
	// Characters: .. / : | ? * in the path are not allowed.
	// Path cannot be a file of type symlink.
	// Maximum path length will be capped to 260 characters.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Context of the path parameter.
	// This is used to validate prefix for absolute paths passed
	Context PathContext `protobuf:"varint,2,opt,name=context,proto3,enum=v1beta1.PathContext" json:"context,omitempty"`
	// Force remove all contents under path (if any).
	Force                bool     `protobuf:"varint,3,opt,name=force,proto3" json:"force,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*RmdirRequest) Descriptor

func (*RmdirRequest) Descriptor() ([]byte, []int)

func (*RmdirRequest) GetContext

func (m *RmdirRequest) GetContext() PathContext

func (*RmdirRequest) GetForce

func (m *RmdirRequest) GetForce() bool

func (*RmdirRequest) GetPath

func (m *RmdirRequest) GetPath() string

func (*RmdirRequest) ProtoMessage

func (*RmdirRequest) ProtoMessage()

func (*RmdirRequest) Reset

func (m *RmdirRequest) Reset()

func (*RmdirRequest) String

func (m *RmdirRequest) String() string

func (*RmdirRequest) XXX_DiscardUnknown

func (m *RmdirRequest) XXX_DiscardUnknown()

func (*RmdirRequest) XXX_Marshal

func (m *RmdirRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RmdirRequest) XXX_Merge

func (m *RmdirRequest) XXX_Merge(src proto.Message)

func (*RmdirRequest) XXX_Size

func (m *RmdirRequest) XXX_Size() int

func (*RmdirRequest) XXX_Unmarshal

func (m *RmdirRequest) XXX_Unmarshal(b []byte) error

type RmdirResponse

type RmdirResponse struct {
	// Error message if any. Empty string indicates success
	Error                string   `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*RmdirResponse) Descriptor

func (*RmdirResponse) Descriptor() ([]byte, []int)

func (*RmdirResponse) GetError

func (m *RmdirResponse) GetError() string

func (*RmdirResponse) ProtoMessage

func (*RmdirResponse) ProtoMessage()

func (*RmdirResponse) Reset

func (m *RmdirResponse) Reset()

func (*RmdirResponse) String

func (m *RmdirResponse) String() string

func (*RmdirResponse) XXX_DiscardUnknown

func (m *RmdirResponse) XXX_DiscardUnknown()

func (*RmdirResponse) XXX_Marshal

func (m *RmdirResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RmdirResponse) XXX_Merge

func (m *RmdirResponse) XXX_Merge(src proto.Message)

func (*RmdirResponse) XXX_Size

func (m *RmdirResponse) XXX_Size() int

func (*RmdirResponse) XXX_Unmarshal

func (m *RmdirResponse) XXX_Unmarshal(b []byte) error

type UnimplementedFilesystemServer

type UnimplementedFilesystemServer struct {
}

UnimplementedFilesystemServer can be embedded to have forward compatible implementations.

func (*UnimplementedFilesystemServer) IsMountPoint

func (*UnimplementedFilesystemServer) LinkPath

func (*UnimplementedFilesystemServer) Mkdir

func (*UnimplementedFilesystemServer) PathExists

func (*UnimplementedFilesystemServer) Rmdir

Jump to

Keyboard shortcuts

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