pluginstore

Documentation

Overview

Package pluginstore is an internal Porter package that implements the plugins.SecretsPlugin interface.

Index

• func NewSecretsPluginConfig() pluggable.PluginTypeConfig
• type GClient
  • func NewClient(client proto.SecretsProtocolClient) *GClient
  • func (m *GClient) Create(ctx context.Context, keyName string, keyValue string, value string) error
  • func (m *GClient) Resolve(ctx context.Context, keyName string, keyValue string) (string, error)
• type GServer
  • func NewServer(c *portercontext.Context, impl plugins.SecretsProtocol) *GServer
  • func (m *GServer) Create(ctx context.Context, request *proto.CreateRequest) (*proto.CreateResponse, error)
  • func (m *GServer) Resolve(ctx context.Context, request *proto.ResolveRequest) (*proto.ResolveResponse, error)
• type Plugin
  • func NewPlugin(c *portercontext.Context, impl plugins.SecretsProtocol) Plugin
  • func (p Plugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, conn *grpc.ClientConn) (interface{}, error)
  • func (p Plugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
• type Store
  • func NewStore(c *config.Config) *Store
  • func (s *Store) Close() error
  • func (s *Store) Connect(ctx context.Context) error
  • func (s *Store) Create(ctx context.Context, keyName string, keyValue string, value string) error
  • func (s *Store) Resolve(ctx context.Context, keyName string, keyValue string) (string, error)

Functions

func NewSecretsPluginConfig

func NewSecretsPluginConfig() pluggable.PluginTypeConfig

NewSecretsPluginConfig for secret sources.

Types

type GClient

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

GClient is a gRPC implementation of the storage client.

func NewClient

func NewClient(client proto.SecretsProtocolClient) *GClient

func (*GClient) Create

func (m *GClient) Create(ctx context.Context, keyName string, keyValue string, value string) error

func (*GClient) Resolve

func (m *GClient) Resolve(ctx context.Context, keyName string, keyValue string) (string, error)

type GServer

type GServer struct {
	proto.UnsafeSecretsProtocolServer
	// contains filtered or unexported fields
}

GServer is a gRPC wrapper around a SecretsProtocol plugin

func NewServer

func NewServer(c *portercontext.Context, impl plugins.SecretsProtocol) *GServer

func (*GServer) Create

func (m *GServer) Create(ctx context.Context, request *proto.CreateRequest) (*proto.CreateResponse, error)

func (*GServer) Resolve

func (m *GServer) Resolve(ctx context.Context, request *proto.ResolveRequest) (*proto.ResolveResponse, error)

type Plugin

type Plugin struct {
	plugin.Plugin
	// contains filtered or unexported fields
}

Plugin is the shared implementation of a storage plugin wrapper.

func NewPlugin

func NewPlugin(c *portercontext.Context, impl plugins.SecretsProtocol) Plugin

NewPlugin creates an instance of a storage plugin.

func (Plugin) GRPCClient

func (p Plugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, conn *grpc.ClientConn) (interface{}, error)

func (Plugin) GRPCServer

func (p Plugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

type Store

type Store struct {
	*config.Config
	// contains filtered or unexported fields
}

Store is a plugin-backed source of secrets. It resolves the appropriate plugin based on Porter's config and implements the plugins.SecretsProtocol interface using the backing plugin.

Connects just-in-time, but you must call Close to release resources.

func NewStore

func NewStore(c *config.Config) *Store

func (*Store) Close

func (s *Store) Close() error

func (*Store) Connect

func (s *Store) Connect(ctx context.Context) error

Connect initializes the plugin for use. The plugin itself is responsible for ensuring it was called. Close is called automatically when the plugin is used by Porter.

func (*Store) Create

func (s *Store) Create(ctx context.Context, keyName string, keyValue string, value string) error

func (*Store) Resolve

func (s *Store) Resolve(ctx context.Context, keyName string, keyValue string) (string, error)