provision

Documentation

Index

• Constants
• func StatusDone(stage, message string) *provisionpb.Status
• func StatusError(stage, message string, err error) *provisionpb.Status
• func StatusOk(stage, message string) *provisionpb.Status
• type GRPCServer
  • func (s *GRPCServer) Deploy(req *provisionpb.DeployRequest, ...) error
  • func (s *GRPCServer) TearDown(req *provisionpb.TearDownRequest, ...) error
  • func (s *GRPCServer) Validate(ctx context.Context, req *provisionpb.ValidateRequest) (*provisionpb.ValidateResponse, error)
• type Provision
• type ProvisionPlugin
  • func (pp *ProvisionPlugin) GRPCClient(ctx context.Context, broker *go_plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (pp *ProvisionPlugin) GRPCServer(broker *go_plugin.GRPCBroker, s *grpc.Server) error
• type ProvisionPluginClientGRPC
  • func (c *ProvisionPluginClientGRPC) Deploy(ctx context.Context, source datasource.DataSource, kubeCfgFile string) (<-chan *provisionpb.Status, error)
  • func (c *ProvisionPluginClientGRPC) TearDown(ctx context.Context, source datasource.DataSource, kubeCfgFile string) (<-chan *provisionpb.Status, error)
  • func (c *ProvisionPluginClientGRPC) Validate(ctx context.Context) error
• type StatusBuilder
  • func NewStatusBuilder(trustZone, cluster string) *StatusBuilder
  • func (sb *StatusBuilder) Done(stage, message string) *provisionpb.Status
  • func (sb *StatusBuilder) Error(stage, message string, err error) *provisionpb.Status
  • func (sb *StatusBuilder) Ok(stage, message string) *provisionpb.Status

Constants

const ProvisionPluginName = "provision"

ProvisionPluginName is the name that should be used in the plugin map.

Functions

func StatusDone

func StatusDone(stage, message string) *provisionpb.Status

StatusOk returns a Status message with Done set to true and no Error.

func StatusError

func StatusError(stage, message string, err error) *provisionpb.Status

StatusOk returns a Status message with Done set to true and an Error.

func StatusOk

func StatusOk(stage, message string) *provisionpb.Status

StatusOk returns a Status message with Done set to false and no Error.

Types

type GRPCServer

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

GRPCServer implements provisionpb.ProvisionPluginServiceServer, translating gRPC calls to impl, the Provision implementation.

func (*GRPCServer) Deploy

func (s *GRPCServer) Deploy(req *provisionpb.DeployRequest, stream grpc.ServerStreamingServer[provisionpb.DeployResponse]) error

func (*GRPCServer) TearDown

func (s *GRPCServer) TearDown(req *provisionpb.TearDownRequest, stream grpc.ServerStreamingServer[provisionpb.TearDownResponse]) error

func (*GRPCServer) Validate

func (s *GRPCServer) Validate(ctx context.Context, req *provisionpb.ValidateRequest) (*provisionpb.ValidateResponse, error)

type Provision

type Provision interface {
	validator.Validator

	// Deploy deploys the workload identity configuration to the clusters in the system.
	// The method is asynchronous, returning a channel over which Status messages are sent
	// describing the various stages of deployment and their outcomes.
	Deploy(ctx context.Context, ds datasource.DataSource, kubeCfgFile string) (<-chan *provisionpb.Status, error)

	// TearDown tears down the workload identity configuration from the clusters in the system.
	// The method is asynchronous, returning a channel over which Status messages are sent
	// describing the various stages of tear down and their outcomes.
	TearDown(ctx context.Context, ds datasource.DataSource, kubeCfgFile string) (<-chan *provisionpb.Status, error)
}

Provision is the interface that provision plugins have to implement.

type ProvisionPlugin

type ProvisionPlugin struct {
	go_plugin.Plugin
	Impl Provision
}

ProvisionPlugin implements the plugin.Plugin interface to provide the GRPC server or client back to the plugin machinery. The server side should provide the Impl field with a concrete implementation of the ProvisionPlugin interface.

func (*ProvisionPlugin) GRPCClient

func (pp *ProvisionPlugin) GRPCClient(ctx context.Context, broker *go_plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (*ProvisionPlugin) GRPCServer

func (pp *ProvisionPlugin) GRPCServer(broker *go_plugin.GRPCBroker, s *grpc.Server) error

type ProvisionPluginClientGRPC

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

ProvisionPluginClientGRPC is used by clients (main application) to translate the Provision interface of plugins to GRPC calls.

func (*ProvisionPluginClientGRPC) Deploy

func (c *ProvisionPluginClientGRPC) Deploy(ctx context.Context, source datasource.DataSource, kubeCfgFile string) (<-chan *provisionpb.Status, error)

func (*ProvisionPluginClientGRPC) TearDown

func (c *ProvisionPluginClientGRPC) TearDown(ctx context.Context, source datasource.DataSource, kubeCfgFile string) (<-chan *provisionpb.Status, error)

func (*ProvisionPluginClientGRPC) Validate

func (c *ProvisionPluginClientGRPC) Validate(ctx context.Context) error

type StatusBuilder

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

StatusBuilder makes it easier to construct Status messages with context about the trust zone and cluster.

func NewStatusBuilder

func NewStatusBuilder(trustZone, cluster string) *StatusBuilder

func (*StatusBuilder) Done

func (sb *StatusBuilder) Done(stage, message string) *provisionpb.Status

Done returns a Status message with Done set to true and no Error

func (*StatusBuilder) Error

func (sb *StatusBuilder) Error(stage, message string, err error) *provisionpb.Status

Error returns a Status message with Done set to true and an Error

func (*StatusBuilder) Ok

func (sb *StatusBuilder) Ok(stage, message string) *provisionpb.Status

Ok returns a Status message with Done set to false and no Error