client

Documentation

Index

• Constants
• func ValidateHandshake(h *plugin_go.Handshake) error
• type Client
  • func NewClient(log logger.Logger, name, env string, cmd *exec.Cmd, hostAddr string, ...) (*Client, error)
  • func (c *Client) AcquireLocks(ctx context.Context, props map[string]interface{}, lockNames []string, ...) (map[string]string, error)
  • func (c *Client) Apply(ctx context.Context, state *statefile.StateData, apps []*apiv1.AppPlan, ...) (*apiv1.ApplyDoneResponse, error)
  • func (c *Client) ApplyDNS(ctx context.Context, state *statefile.StateData, records []*apiv1.DNSRecord, ...) (*apiv1.ApplyDNSDoneResponse, error)
  • func (c *Client) ApplyMonitoring(ctx context.Context, state *statefile.StateData, ...) (*apiv1.ApplyMonitoringDoneResponse, error)
  • func (c *Client) Command(ctx context.Context, req *apiv1.CommandRequest) error
  • func (c *Client) DeleteSecret(ctx context.Context, key, typ string, props map[string]interface{}) (deleted bool, err error)
  • func (c *Client) DeleteSecrets(ctx context.Context, typ string, props map[string]interface{}) error
  • func (c *Client) DeployHook(ctx context.Context, stage apiv1.DeployHookRequest_Stage, ...) (*apiv1.DeployHookResponse, error)
  • func (c *Client) GetSecret(ctx context.Context, key, typ string, props map[string]interface{}) (val string, ok bool, err error)
  • func (c *Client) GetSecrets(ctx context.Context, typ string, props map[string]interface{}) (map[string]string, error)
  • func (c *Client) GetState(ctx context.Context, typ string, props map[string]interface{}, lock bool, ...) (ret *apiv1.GetStateResponse_State, err error)
  • func (c *Client) Init(ctx context.Context) error
  • func (c *Client) Logs(ctx context.Context, req *apiv1.LogsRequest, ...) error
  • func (c *Client) Plan(ctx context.Context, state *statefile.StateData, apps []*apiv1.AppPlan, ...) (*apiv1.PlanResponse, error)
  • func (c *Client) PlanDNS(ctx context.Context, state *statefile.StateData, records []*apiv1.DNSRecord, ...) (*apiv1.PlanDNSResponse, error)
  • func (c *Client) PlanMonitoring(ctx context.Context, state *statefile.StateData, ...) (*apiv1.PlanMonitoringResponse, error)
  • func (c *Client) ProjectInit(ctx context.Context, name string, deployPlugins, runPlugins []string, ...) (*apiv1.ProjectInitResponse, error)
  • func (c *Client) ReleaseLocks(ctx context.Context, props map[string]interface{}, locks map[string]string) error
  • func (c *Client) ReleaseStateLock(ctx context.Context, typ string, props map[string]interface{}, lockinfo string) error
  • func (c *Client) ReplaceSecrets(ctx context.Context, values map[string]string, typ string, ...) error
  • func (c *Client) Run(ctx context.Context, req *apiv1.RunRequest, ...) (*apiv1.RunStartResponse, error)
  • func (c *Client) SaveState(ctx context.Context, state *statefile.StateData, typ string, ...) (*apiv1.SaveStateResponse, error)
  • func (c *Client) SetSecret(ctx context.Context, key, value, typ string, props map[string]interface{}) (changed bool, err error)
  • func (c *Client) Start(ctx context.Context) error
  • func (c *Client) Stop() error
• type PluginError
  • func (e *PluginError) Error() string
  • func (e *PluginError) Unwrap() error
• type YAMLContext

Constants

const (
	DefaultTimeout = 60 * time.Second
)

Functions

func ValidateHandshake

func ValidateHandshake(h *plugin_go.Handshake) error

Types

type Client

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

func NewClient

func NewClient(log logger.Logger, name, env string, cmd *exec.Cmd, hostAddr string, props map[string]interface{}, yamlContext YAMLContext) (*Client, error)

func (*Client) AcquireLocks

func (c *Client) AcquireLocks(ctx context.Context, props map[string]interface{}, lockNames []string, lockWait time.Duration, yamlContext *YAMLContext) (map[string]string, error)

func (*Client) Apply

func (c *Client) Apply(ctx context.Context, state *statefile.StateData, apps []*apiv1.AppPlan, deps []*apiv1.DependencyPlan, priority int, args map[string]interface{}, destroy bool, callback func(*apiv1.ApplyAction)) (*apiv1.ApplyDoneResponse, error)

func (*Client) ApplyDNS

func (c *Client) ApplyDNS(ctx context.Context, state *statefile.StateData, records []*apiv1.DNSRecord, args map[string]interface{}, destroy bool, callback func(*apiv1.ApplyAction)) (*apiv1.ApplyDNSDoneResponse, error)

func (*Client) ApplyMonitoring

func (c *Client) ApplyMonitoring(ctx context.Context, state *statefile.StateData, monitoring *apiv1.MonitoringData, args map[string]interface{}, destroy bool, callback func(*apiv1.ApplyAction)) (*apiv1.ApplyMonitoringDoneResponse, error)

func (*Client) Command

func (c *Client) Command(ctx context.Context, req *apiv1.CommandRequest) error

func (*Client) DeleteSecret

func (c *Client) DeleteSecret(ctx context.Context, key, typ string, props map[string]interface{}) (deleted bool, err error)

func (*Client) DeleteSecrets

func (c *Client) DeleteSecrets(ctx context.Context, typ string, props map[string]interface{}) error

func (*Client) DeployHook

func (c *Client) DeployHook(ctx context.Context, stage apiv1.DeployHookRequest_Stage, state *statefile.StateData, apps []*apiv1.AppPlan, deps []*apiv1.DependencyPlan, args map[string]interface{}, verify, destroy bool) (*apiv1.DeployHookResponse, error)

func (*Client) GetSecret

func (c *Client) GetSecret(ctx context.Context, key, typ string, props map[string]interface{}) (val string, ok bool, err error)

func (*Client) GetSecrets

func (c *Client) GetSecrets(ctx context.Context, typ string, props map[string]interface{}) (map[string]string, error)

func (*Client) GetState

func (c *Client) GetState(ctx context.Context, typ string, props map[string]interface{}, lock bool, lockWait time.Duration, skipCreate bool, yamlContext *YAMLContext) (ret *apiv1.GetStateResponse_State, err error)

func (*Client) Init

func (c *Client) Init(ctx context.Context) error

func (*Client) Logs

func (c *Client) Logs(ctx context.Context, req *apiv1.LogsRequest, callback func(*apiv1.LogsResponse)) error

func (*Client) Plan

func (c *Client) Plan(ctx context.Context, state *statefile.StateData, apps []*apiv1.AppPlan, deps []*apiv1.DependencyPlan, priority int, args map[string]interface{}, verify, destroy bool) (*apiv1.PlanResponse, error)

func (*Client) PlanDNS

func (c *Client) PlanDNS(ctx context.Context, state *statefile.StateData, records []*apiv1.DNSRecord, args map[string]interface{}, verify, destroy bool) (*apiv1.PlanDNSResponse, error)

func (*Client) PlanMonitoring

func (c *Client) PlanMonitoring(ctx context.Context, state *statefile.StateData, monitoring *apiv1.MonitoringData, args map[string]interface{}, verify, destroy bool) (*apiv1.PlanMonitoringResponse, error)

func (*Client) ProjectInit

func (c *Client) ProjectInit(ctx context.Context, name string, deployPlugins, runPlugins []string, dnsPlugin string, args map[string]interface{}) (*apiv1.ProjectInitResponse, error)

func (*Client) ReleaseLocks

func (c *Client) ReleaseLocks(ctx context.Context, props map[string]interface{}, locks map[string]string) error

func (*Client) ReleaseStateLock

func (c *Client) ReleaseStateLock(ctx context.Context, typ string, props map[string]interface{}, lockinfo string) error

func (*Client) ReplaceSecrets

func (c *Client) ReplaceSecrets(ctx context.Context, values map[string]string, typ string, props map[string]interface{}) error

func (*Client) Run

func (c *Client) Run(ctx context.Context, req *apiv1.RunRequest,
	outCh chan<- *apiv1.RunOutputResponse, errCh chan<- error) (*apiv1.RunStartResponse, error)

func (*Client) SaveState

func (c *Client) SaveState(ctx context.Context, state *statefile.StateData, typ string, props map[string]interface{}) (*apiv1.SaveStateResponse, error)

func (*Client) SetSecret

func (c *Client) SetSecret(ctx context.Context, key, value, typ string, props map[string]interface{}) (changed bool, err error)

func (*Client) Start

func (c *Client) Start(ctx context.Context) error

func (*Client) Stop

func (c *Client) Stop() error

type PluginError

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

func (*PluginError) Error

func (e *PluginError) Error() string

func (*PluginError) Unwrap

func (e *PluginError) Unwrap() error

type YAMLContext

type YAMLContext struct {
	Prefix string
	Data   []byte
}