Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

framework

package

Go to main page

Versions in this module

v1

v1.0.0

May 20, 2019

Changes in this version

+ func Handshake() plugin.HandshakeConfig

+ func ValidatePluginName(name string, existingNames []string) error

+ type BackupItemActionGRPCClient struct

+ func (c *BackupItemActionGRPCClient) AppliesTo() (velero.ResourceSelector, error)

+ func (c *BackupItemActionGRPCClient) Execute(item runtime.Unstructured, backup *api.Backup) (runtime.Unstructured, []velero.ResourceIdentifier, error)

+ type BackupItemActionGRPCServer struct

+ func (s *BackupItemActionGRPCServer) AppliesTo(ctx context.Context, req *proto.BackupItemActionAppliesToRequest) (response *proto.BackupItemActionAppliesToResponse, err error)

+ func (s *BackupItemActionGRPCServer) Execute(ctx context.Context, req *proto.ExecuteRequest) (response *proto.ExecuteResponse, err error)

+ type BackupItemActionPlugin struct

+ func NewBackupItemActionPlugin(options ...PluginOption) *BackupItemActionPlugin

+ func (p *BackupItemActionPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, clientConn *grpc.ClientConn) (interface{}, error)

+ func (p *BackupItemActionPlugin) GRPCServer(_ *plugin.GRPCBroker, server *grpc.Server) error

+ type ClientDispenser interface

+ ClientFor func(name string) interface{}

+ type CloseFunc func() error

+ type HandlerInitializer func(logger logrus.FieldLogger) (interface{}, error)

+ type Interface interface

+ type ObjectStoreGRPCClient struct

+ func (c *ObjectStoreGRPCClient) CreateSignedURL(bucket, key string, ttl time.Duration) (string, error)

+ func (c *ObjectStoreGRPCClient) DeleteObject(bucket, key string) error

+ func (c *ObjectStoreGRPCClient) GetObject(bucket, key string) (io.ReadCloser, error)

+ func (c *ObjectStoreGRPCClient) Init(config map[string]string) error

+ func (c *ObjectStoreGRPCClient) ListCommonPrefixes(bucket, prefix, delimiter string) ([]string, error)

+ func (c *ObjectStoreGRPCClient) ListObjects(bucket, prefix string) ([]string, error)

+ func (c *ObjectStoreGRPCClient) ObjectExists(bucket, key string) (bool, error)

+ func (c *ObjectStoreGRPCClient) PutObject(bucket, key string, body io.Reader) error

+ type ObjectStoreGRPCServer struct

+ func (s *ObjectStoreGRPCServer) CreateSignedURL(ctx context.Context, req *proto.CreateSignedURLRequest) (response *proto.CreateSignedURLResponse, err error)

+ func (s *ObjectStoreGRPCServer) DeleteObject(ctx context.Context, req *proto.DeleteObjectRequest) (response *proto.Empty, err error)

+ func (s *ObjectStoreGRPCServer) GetObject(req *proto.GetObjectRequest, stream proto.ObjectStore_GetObjectServer) (err error)

+ func (s *ObjectStoreGRPCServer) Init(ctx context.Context, req *proto.ObjectStoreInitRequest) (response *proto.Empty, err error)

+ func (s *ObjectStoreGRPCServer) ListCommonPrefixes(ctx context.Context, req *proto.ListCommonPrefixesRequest) (response *proto.ListCommonPrefixesResponse, err error)

+ func (s *ObjectStoreGRPCServer) ListObjects(ctx context.Context, req *proto.ListObjectsRequest) (response *proto.ListObjectsResponse, err error)

+ func (s *ObjectStoreGRPCServer) ObjectExists(ctx context.Context, req *proto.ObjectExistsRequest) (response *proto.ObjectExistsResponse, err error)

+ func (s *ObjectStoreGRPCServer) PutObject(stream proto.ObjectStore_PutObjectServer) (err error)

+ type ObjectStorePlugin struct

+ func NewObjectStorePlugin(options ...PluginOption) *ObjectStorePlugin

+ func (p *ObjectStorePlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, clientConn *grpc.ClientConn) (interface{}, error)

+ func (p *ObjectStorePlugin) GRPCServer(_ *plugin.GRPCBroker, server *grpc.Server) error

+ type PluginIdentifier struct

+ Command string

+ Kind PluginKind

+ Name string

+ type PluginKind string

+ const PluginKindBackupItemAction

+ const PluginKindObjectStore

+ const PluginKindPluginLister

+ const PluginKindRestoreItemAction

+ const PluginKindVolumeSnapshotter

+ func (k PluginKind) String() string

+ type PluginLister interface

+ ListPlugins func() ([]PluginIdentifier, error)

+ func NewPluginLister(plugins ...PluginIdentifier) PluginLister

+ type PluginListerGRPCClient struct

+ func (c *PluginListerGRPCClient) ListPlugins() ([]PluginIdentifier, error)

+ type PluginListerGRPCServer struct

+ func (s *PluginListerGRPCServer) ListPlugins(ctx context.Context, req *proto.Empty) (*proto.ListPluginsResponse, error)

+ type PluginListerPlugin struct

+ func NewPluginListerPlugin(impl PluginLister) *PluginListerPlugin

+ func (p *PluginListerPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, clientConn *grpc.ClientConn) (interface{}, error)

+ func (p *PluginListerPlugin) GRPCServer(_ *plugin.GRPCBroker, server *grpc.Server) error

+ type PluginOption func(base *pluginBase)

+ func ClientLogger(logger logrus.FieldLogger) PluginOption

+ type ReceiveFunc func() ([]byte, error)

+ type RestoreItemActionGRPCClient struct

+ func (c *RestoreItemActionGRPCClient) AppliesTo() (velero.ResourceSelector, error)

+ func (c *RestoreItemActionGRPCClient) Execute(input *velero.RestoreItemActionExecuteInput) (*velero.RestoreItemActionExecuteOutput, error)

+ type RestoreItemActionGRPCServer struct

+ func (s *RestoreItemActionGRPCServer) AppliesTo(ctx context.Context, req *proto.RestoreItemActionAppliesToRequest) (response *proto.RestoreItemActionAppliesToResponse, err error)

+ func (s *RestoreItemActionGRPCServer) Execute(ctx context.Context, req *proto.RestoreItemActionExecuteRequest) (response *proto.RestoreItemActionExecuteResponse, err error)

+ type RestoreItemActionPlugin struct

+ func NewRestoreItemActionPlugin(options ...PluginOption) *RestoreItemActionPlugin

+ func (p *RestoreItemActionPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, clientConn *grpc.ClientConn) (interface{}, error)

+ func (p *RestoreItemActionPlugin) GRPCServer(_ *plugin.GRPCBroker, server *grpc.Server) error

+ type Server interface

+ BindFlags func(flags *pflag.FlagSet) Server

+ RegisterBackupItemAction func(pluginName string, initializer HandlerInitializer) Server

+ RegisterBackupItemActions func(map[string]HandlerInitializer) Server

+ RegisterObjectStore func(pluginName string, initializer HandlerInitializer) Server

+ RegisterObjectStores func(map[string]HandlerInitializer) Server

+ RegisterRestoreItemAction func(pluginName string, initializer HandlerInitializer) Server

+ RegisterRestoreItemActions func(map[string]HandlerInitializer) Server

+ RegisterVolumeSnapshotter func(pluginName string, initializer HandlerInitializer) Server

+ RegisterVolumeSnapshotters func(map[string]HandlerInitializer) Server

+ Serve func()

+ func NewServer() Server

+ type StreamReadCloser struct

+ func (s *StreamReadCloser) Close() error

+ func (s *StreamReadCloser) Read(p []byte) (n int, err error)

+ type VolumeSnapshotterGRPCClient struct

+ func (c *VolumeSnapshotterGRPCClient) CreateSnapshot(volumeID, volumeAZ string, tags map[string]string) (string, error)

+ func (c *VolumeSnapshotterGRPCClient) CreateVolumeFromSnapshot(snapshotID, volumeType, volumeAZ string, iops *int64) (string, error)

+ func (c *VolumeSnapshotterGRPCClient) DeleteSnapshot(snapshotID string) error

+ func (c *VolumeSnapshotterGRPCClient) GetVolumeID(pv runtime.Unstructured) (string, error)

+ func (c *VolumeSnapshotterGRPCClient) GetVolumeInfo(volumeID, volumeAZ string) (string, *int64, error)

+ func (c *VolumeSnapshotterGRPCClient) Init(config map[string]string) error

+ func (c *VolumeSnapshotterGRPCClient) SetVolumeID(pv runtime.Unstructured, volumeID string) (runtime.Unstructured, error)

+ type VolumeSnapshotterGRPCServer struct

+ func (s *VolumeSnapshotterGRPCServer) CreateSnapshot(ctx context.Context, req *proto.CreateSnapshotRequest) (response *proto.CreateSnapshotResponse, err error)

+ func (s *VolumeSnapshotterGRPCServer) CreateVolumeFromSnapshot(ctx context.Context, req *proto.CreateVolumeRequest) (response *proto.CreateVolumeResponse, err error)

+ func (s *VolumeSnapshotterGRPCServer) DeleteSnapshot(ctx context.Context, req *proto.DeleteSnapshotRequest) (response *proto.Empty, err error)

+ func (s *VolumeSnapshotterGRPCServer) GetVolumeID(ctx context.Context, req *proto.GetVolumeIDRequest) (response *proto.GetVolumeIDResponse, err error)

+ func (s *VolumeSnapshotterGRPCServer) GetVolumeInfo(ctx context.Context, req *proto.GetVolumeInfoRequest) (response *proto.GetVolumeInfoResponse, err error)

+ func (s *VolumeSnapshotterGRPCServer) Init(ctx context.Context, req *proto.VolumeSnapshotterInitRequest) (response *proto.Empty, err error)

+ func (s *VolumeSnapshotterGRPCServer) SetVolumeID(ctx context.Context, req *proto.SetVolumeIDRequest) (response *proto.SetVolumeIDResponse, err error)

+ type VolumeSnapshotterPlugin struct

+ func NewVolumeSnapshotterPlugin(options ...PluginOption) *VolumeSnapshotterPlugin

+ func (p *VolumeSnapshotterPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, clientConn *grpc.ClientConn) (interface{}, error)

+ func (p *VolumeSnapshotterPlugin) GRPCServer(_ *plugin.GRPCBroker, server *grpc.Server) error

v1.0.0-rc.1

May 10, 2019

v1.0.0-beta.1

May 3, 2019

v1.0.0-alpha.2

Apr 25, 2019

v1.0.0-alpha.1

Apr 15, 2019