flexvolume

Documentation

Overview

Package flexvolume implements utility code for Kubernetes flexvolumes.

https://github.com/kubernetes/kubernetes/pull/13840 https://github.com/kubernetes/kubernetes/tree/master/examples/flexvolume

Package flexvolume is a generated protocol buffer package.

It is generated from these files:

pkg/flexvolume/flexvolume.proto

It has these top-level messages:

AttachRequest
DetachRequest
MountRequest
UnmountRequest

Package flexvolume is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• func BytesToJSONOptions(value []byte) (map[string]string, error)
• func JSONOptionsToBytes(jsonOptions map[string]string) ([]byte, error)
• func RegisterAPIHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client APIClient) error
• func RegisterAPIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterAPIServer(s *grpc.Server, srv APIServer)
• type APIClient
  • func NewAPIClient(cc *grpc.ClientConn) APIClient
  • func NewLocalAPIClient(apiServer APIServer) APIClient
• type APIServer
  • func NewAPIServer(client Client) APIServer
• type AttachRequest
  • func (*AttachRequest) Descriptor() ([]byte, []int)
  • func (m *AttachRequest) GetJsonOptions() map[string]string
  • func (*AttachRequest) ProtoMessage()
  • func (m *AttachRequest) Reset()
  • func (m *AttachRequest) String() string
• type Client
  • func NewClient(apiClient APIClient) Client
• type DetachRequest
  • func (*DetachRequest) Descriptor() ([]byte, []int)
  • func (m *DetachRequest) GetMountDevice() string
  • func (*DetachRequest) ProtoMessage()
  • func (m *DetachRequest) Reset()
  • func (m *DetachRequest) String() string
• type MountRequest
  • func (*MountRequest) Descriptor() ([]byte, []int)
  • func (m *MountRequest) GetJsonOptions() map[string]string
  • func (m *MountRequest) GetMountDevice() string
  • func (m *MountRequest) GetTargetMountDir() string
  • func (*MountRequest) ProtoMessage()
  • func (m *MountRequest) Reset()
  • func (m *MountRequest) String() string
• type UnmountRequest
  • func (*UnmountRequest) Descriptor() ([]byte, []int)
  • func (m *UnmountRequest) GetMountDir() string
  • func (*UnmountRequest) ProtoMessage()
  • func (m *UnmountRequest) Reset()
  • func (m *UnmountRequest) String() string

Functions

func BytesToJSONOptions

func BytesToJSONOptions(value []byte) (map[string]string, error)

BytesToJSONOptions converts a JSON string to a map of JSON options.

func JSONOptionsToBytes

func JSONOptionsToBytes(jsonOptions map[string]string) ([]byte, error)

JSONOptionsToBytes converts a map of JSON Options to a JSON string.

func RegisterAPIHandler

func RegisterAPIHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterAPIHandler registers the http handlers for service API to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterAPIHandlerClient

func RegisterAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client APIClient) error

RegisterAPIHandler registers the http handlers for service API to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "APIClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "APIClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "APIClient" to call the correct interceptors.

func RegisterAPIHandlerFromEndpoint

func RegisterAPIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterAPIHandlerFromEndpoint is same as RegisterAPIHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterAPIServer

func RegisterAPIServer(s *grpc.Server, srv APIServer)

Types

type APIClient

type APIClient interface {
	Init(ctx context.Context, in *google_protobuf1.Empty, opts ...grpc.CallOption) (*google_protobuf1.Empty, error)
	Attach(ctx context.Context, in *AttachRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error)
	Detach(ctx context.Context, in *DetachRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error)
	Mount(ctx context.Context, in *MountRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error)
	Unmount(ctx context.Context, in *UnmountRequest, opts ...grpc.CallOption) (*google_protobuf1.Empty, error)
}

func NewAPIClient

func NewAPIClient(cc *grpc.ClientConn) APIClient

func NewLocalAPIClient

func NewLocalAPIClient(apiServer APIServer) APIClient

NewLocalAPIClient returns a new APIClient for the given APIServer.

type APIServer

type APIServer interface {
	Init(context.Context, *google_protobuf1.Empty) (*google_protobuf1.Empty, error)
	Attach(context.Context, *AttachRequest) (*google_protobuf1.Empty, error)
	Detach(context.Context, *DetachRequest) (*google_protobuf1.Empty, error)
	Mount(context.Context, *MountRequest) (*google_protobuf1.Empty, error)
	Unmount(context.Context, *UnmountRequest) (*google_protobuf1.Empty, error)
}

func NewAPIServer

func NewAPIServer(client Client) APIServer

NewAPIServer returns a new APIServer for the given Client.

type AttachRequest

type AttachRequest struct {
	JsonOptions map[string]string `` /* 161-byte string literal not displayed */
}

func (*AttachRequest) Descriptor

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

func (*AttachRequest) GetJsonOptions

func (m *AttachRequest) GetJsonOptions() map[string]string

func (*AttachRequest) ProtoMessage

func (*AttachRequest) ProtoMessage()

func (*AttachRequest) Reset

func (m *AttachRequest) Reset()

func (*AttachRequest) String

func (m *AttachRequest) String() string

type Client

type Client interface {
	Init() error
	Attach(jsonOptions map[string]string) error
	Detach(mountDevice string, options map[string]string) error
	Mount(targetMountDir string, mountDevice string, jsonOptions map[string]string) error
	Unmount(mountDir string, options map[string]string) error
}

Client is the client for a flexvolume implementation.

It is both called from the wrapper cli tool, and implemented by a given implementation.

func NewClient

func NewClient(apiClient APIClient) Client

NewClient returns a new Client for the given APIClient.

type DetachRequest

type DetachRequest struct {
	MountDevice string `protobuf:"bytes,1,opt,name=mount_device,json=mountDevice" json:"mount_device,omitempty"`
}

func (*DetachRequest) Descriptor

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

func (*DetachRequest) GetMountDevice

func (m *DetachRequest) GetMountDevice() string

func (*DetachRequest) ProtoMessage

func (*DetachRequest) ProtoMessage()

func (*DetachRequest) Reset

func (m *DetachRequest) Reset()

func (*DetachRequest) String

func (m *DetachRequest) String() string

type MountRequest

type MountRequest struct {
	TargetMountDir string            `protobuf:"bytes,1,opt,name=target_mount_dir,json=targetMountDir" json:"target_mount_dir,omitempty"`
	MountDevice    string            `protobuf:"bytes,2,opt,name=mount_device,json=mountDevice" json:"mount_device,omitempty"`
	JsonOptions    map[string]string `` /* 161-byte string literal not displayed */
}

func (*MountRequest) Descriptor

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

func (*MountRequest) GetJsonOptions

func (m *MountRequest) GetJsonOptions() map[string]string

func (*MountRequest) GetMountDevice

func (m *MountRequest) GetMountDevice() string

func (*MountRequest) GetTargetMountDir

func (m *MountRequest) GetTargetMountDir() string

func (*MountRequest) ProtoMessage

func (*MountRequest) ProtoMessage()

func (*MountRequest) Reset

func (m *MountRequest) Reset()

func (*MountRequest) String

func (m *MountRequest) String() string

type UnmountRequest

type UnmountRequest struct {
	MountDir string `protobuf:"bytes,1,opt,name=mount_dir,json=mountDir" json:"mount_dir,omitempty"`
}

func (*UnmountRequest) Descriptor

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

func (*UnmountRequest) GetMountDir

func (m *UnmountRequest) GetMountDir() string

func (*UnmountRequest) ProtoMessage

func (*UnmountRequest) ProtoMessage()

func (*UnmountRequest) Reset

func (m *UnmountRequest) Reset()

func (*UnmountRequest) String

func (m *UnmountRequest) String() string