sdk

package module

Go to main page

Versions in this module

v0

v0.3.2

Apr 22, 2026

v0.3.1

Apr 21, 2026

v0.3.0

Sep 30, 2025

Changes in this version

type Client

+ func (c *Client) StageLogPersister() (StageLogPersister, error)

v0.2.0

Sep 18, 2025

Changes in this version

type GetPlanPreviewRequest

+ ApplicationName string

+ PipedID string

+ RunningDeploymentSource DeploymentSource[ApplicationConfigSpec]

v0.1.0

Aug 29, 2025

Changes in this version

+ const MetadataKeyStageApprovedUsers

+ const MetadataKeyStageDisplay

+ type ApplicationConfig struct

+ Spec *Spec

+ func LoadApplicationConfigForTest[Spec any](t *testing.T, filename string, pluginName string) *ApplicationConfig[Spec]

+ func (c *ApplicationConfig[Spec]) HasStage(name string) bool

+ func (c *ApplicationConfig[Spec]) UnmarshalJSON(data []byte) error

+ func (c *ApplicationConfig[Spec]) Validate() error

+ type ApplicationHealthStatus int

+ const ApplicationHealthStateHealthy

+ const ApplicationHealthStateOther

+ const ApplicationHealthStateUnknown

+ type ApplicationLiveState struct

+ Resources []ResourceState

+ type ApplicationSyncState struct

+ Reason string

+ ShortReason string

+ Status ApplicationSyncStatus

+ type ApplicationSyncStatus int

+ const ApplicationSyncStateInvalidConfig

+ const ApplicationSyncStateOutOfSync

+ const ApplicationSyncStateSynced

+ const ApplicationSyncStateUnknown

+ type ArtifactVersion struct

+ Name string

+ URL string

+ Version string

+ type BuildPipelineSyncStagesInput struct

+ Client *Client

+ Logger *zap.Logger

+ Request BuildPipelineSyncStagesRequest

+ type BuildPipelineSyncStagesRequest struct

+ Rollback bool

+ Stages []StageConfig

+ type BuildPipelineSyncStagesResponse struct

+ Stages []PipelineStage

+ type BuildQuickSyncStagesInput struct

+ Client *Client

+ Logger *zap.Logger

+ Request BuildQuickSyncStagesRequest

+ type BuildQuickSyncStagesRequest struct

+ Rollback bool

+ type BuildQuickSyncStagesResponse struct

+ Stages []QuickSyncStage

+ type Client struct

+ func NewClient(base *pluginServiceClient, pluginName, applicationID, stageID string, ...) *Client

+ func (c *Client) GetApplicationSharedObject(ctx context.Context, key string) (obj []byte, found bool, err error)

+ func (c *Client) GetDeploymentPluginMetadata(ctx context.Context, key string) (string, bool, error)

+ func (c *Client) GetDeploymentSharedMetadata(ctx context.Context, key string) (string, bool, error)

+ func (c *Client) GetStageMetadata(ctx context.Context, key string) (string, bool, error)

+ func (c *Client) LogPersister() StageLogPersister

+ func (c *Client) PutApplicationSharedObject(ctx context.Context, key string, object []byte) error

+ func (c *Client) PutDeploymentPluginMetadata(ctx context.Context, key, value string) error

+ func (c *Client) PutDeploymentPluginMetadataMulti(ctx context.Context, metadata map[string]string) error

+ func (c *Client) PutStageMetadata(ctx context.Context, key, value string) error

+ func (c *Client) PutStageMetadataMulti(ctx context.Context, metadata map[string]string) error

+ func (c *Client) ToolRegistry() *toolregistry.ToolRegistry

+ func (c Client) ListStageCommands(ctx context.Context, commandTypes ...CommandType) iter.Seq2[*StageCommand, error]

+ type CommandType int32

+ const CommandTypeApproveStage

+ const CommandTypeSkipStage

+ type ConfigNone = *struct

+ type DeployTarget struct

+ Config Config

+ Labels map[string]string

+ Name string

+ type DeployTargetsNone = []*DeployTarget[struct{}]

+ type Deployment struct

+ ApplicationID string

+ ApplicationName string

+ CreatedAt int64

+ ID string

+ Labels map[string]string

+ PipedID string

+ ProjectID string

+ RepositoryURL string

+ Summary string

+ TriggeredBy string

+ type DeploymentPlugin interface

+ BuildQuickSyncStages func(context.Context, *Config, *BuildQuickSyncStagesInput) (*BuildQuickSyncStagesResponse, error)

+ DetermineStrategy func(context.Context, *Config, *DetermineStrategyInput[ApplicationConfigSpec]) (*DetermineStrategyResponse, error)

+ DetermineVersions func(context.Context, *Config, *DetermineVersionsInput[ApplicationConfigSpec]) (*DetermineVersionsResponse, error)

+ type DeploymentPluginServiceServer struct

+ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) BuildPipelineSyncStages(ctx context.Context, request *deployment.BuildPipelineSyncStagesRequest) (*deployment.BuildPipelineSyncStagesResponse, error)

+ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) BuildQuickSyncStages(ctx context.Context, request *deployment.BuildQuickSyncStagesRequest) (*deployment.BuildQuickSyncStagesResponse, error)

+ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) DetermineStrategy(ctx context.Context, request *deployment.DetermineStrategyRequest) (*deployment.DetermineStrategyResponse, error)

+ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) DetermineVersions(ctx context.Context, request *deployment.DetermineVersionsRequest) (*deployment.DetermineVersionsResponse, error)

+ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) ExecuteStage(ctx context.Context, request *deployment.ExecuteStageRequest) (response *deployment.ExecuteStageResponse, _ error)

+ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) FetchDefinedStages(context.Context, *deployment.FetchDefinedStagesRequest) (*deployment.FetchDefinedStagesResponse, error)

+ func (s *DeploymentPluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) Register(server *grpc.Server)

+ type DeploymentSource struct

+ ApplicationConfig *ApplicationConfig[Spec]

+ ApplicationConfigFilename string

+ ApplicationDirectory string

+ CommitHash string

+ SharedConfigDirectory string

+ func (d *DeploymentSource[Spec]) AppConfig() (*ApplicationConfig[Spec], error)

+ type DetermineStrategyInput struct

+ Client *Client

+ Logger *zap.Logger

+ Request DetermineStrategyRequest[ApplicationConfigSpec]

+ type DetermineStrategyRequest struct

+ Deployment Deployment

+ RunningDeploymentSource DeploymentSource[ApplicationConfigSpec]

+ TargetDeploymentSource DeploymentSource[ApplicationConfigSpec]

+ type DetermineStrategyResponse struct

+ Strategy SyncStrategy

+ Summary string

+ type DetermineVersionsInput struct

+ Client *Client

+ Logger *zap.Logger

+ Request DetermineVersionsRequest[ApplicationConfigSpec]

+ type DetermineVersionsRequest struct

+ Deployment Deployment

+ DeploymentSource DeploymentSource[ApplicationConfigSpec]

+ type DetermineVersionsResponse struct

+ Versions []ArtifactVersion

+ type ExecuteStageInput struct

+ Client *Client

+ Logger *zap.Logger

+ Request ExecuteStageRequest[ApplicationConfigSpec]

+ type ExecuteStageRequest struct

+ Deployment Deployment

+ RunningDeploymentSource DeploymentSource[ApplicationConfigSpec]

+ StageConfig []byte

+ StageIndex int

+ StageName string

+ TargetDeploymentSource DeploymentSource[ApplicationConfigSpec]

+ type ExecuteStageResponse struct

+ Status StageStatus

+ type GetLivestateInput struct

+ Client *Client

+ Logger *zap.Logger

+ Request GetLivestateRequest[ApplicationConfigSpec]

+ type GetLivestateRequest struct

+ ApplicationID string

+ ApplicationName string

+ DeploymentSource DeploymentSource[ApplicationConfigSpec]

+ PipedID string

+ type GetLivestateResponse struct

+ LiveState ApplicationLiveState

+ SyncState ApplicationSyncState

+ type GetPlanPreviewInput struct

+ Client *Client

+ Logger *zap.Logger

+ Request GetPlanPreviewRequest[ApplicationConfigSpec]

+ type GetPlanPreviewRequest struct

+ ApplicationID string

+ DeployTargets []string

+ TargetDeploymentSource DeploymentSource[ApplicationConfigSpec]

+ type GetPlanPreviewResponse struct

+ Results []PlanPreviewResult

+ type InitializeInput struct

+ Client *Client

+ Config *Config

+ DeployTargets map[string]*DeployTarget[DeployTargetConfig]

+ Logger *zap.Logger

+ type Initializer interface

+ Initialize func(context.Context, *InitializeInput[Config, DeployTargetConfig]) error

+ type LivestatePlugin interface

+ GetLivestate func(context.Context, *Config, []*DeployTarget[DeployTargetConfig], ...) (*GetLivestateResponse, error)

+ type LivestatePluginServer struct

+ func (s *LivestatePluginServer[Config, DeployTargetConfig, ApplicationConfigSpec]) GetLivestate(ctx context.Context, request *livestate.GetLivestateRequest) (*livestate.GetLivestateResponse, error)

+ func (s *LivestatePluginServer[Config, DeployTargetConfig, ApplicationConfigSpec]) Register(server *grpc.Server)

+ type ManualOperation int

+ const ManualOperationApprove

+ const ManualOperationNone

+ const ManualOperationSkip

+ type PipelineStage struct

+ AuthorizedOperators []string

+ AvailableOperation ManualOperation

+ Index int

+ Metadata map[string]string

+ Name string

+ Rollback bool

+ type PlanPreviewPlugin interface

+ GetPlanPreview func(context.Context, *Config, []*DeployTarget[DeployTargetConfig], ...) (*GetPlanPreviewResponse, error)

+ type PlanPreviewPluginServer struct

+ func (s *PlanPreviewPluginServer[Config, DeployTargetConfig, ApplicationConfigSpec]) GetPlanPreview(ctx context.Context, request *planpreview.GetPlanPreviewRequest) (*planpreview.GetPlanPreviewResponse, error)

+ func (s *PlanPreviewPluginServer[Config, DeployTargetConfig, ApplicationConfigSpec]) Register(server *grpc.Server)

+ type PlanPreviewResult struct

+ DeployTarget string

+ Details []byte

+ DiffLanguage string

+ NoChange bool

+ Summary string

+ type Plugin struct

+ func NewPlugin[Config, DeployTargetConfig, ApplicationConfigSpec any](version string, ...) (*Plugin[Config, DeployTargetConfig, ApplicationConfigSpec], error)

+ func (p *Plugin[Config, DeployTargetConfig, ApplicationConfigSpec]) Run() error

+ type PluginOption func(*Plugin[Config, DeployTargetConfig, ApplicationConfigSpec])

+ func WithDeploymentPlugin[Config, DeployTargetConfig, ApplicationConfigSpec any](...) PluginOption[Config, DeployTargetConfig, ApplicationConfigSpec]

+ func WithInitializer[ApplicationConfigSpec, Config, DeployTargetConfig any](initializer Initializer[Config, DeployTargetConfig]) PluginOption[Config, DeployTargetConfig, ApplicationConfigSpec]

+ func WithLivestatePlugin[Config, DeployTargetConfig, ApplicationConfigSpec any](...) PluginOption[Config, DeployTargetConfig, ApplicationConfigSpec]

+ func WithPlanPreviewPlugin[Config, DeployTargetConfig, ApplicationConfigSpec any](...) PluginOption[Config, DeployTargetConfig, ApplicationConfigSpec]

+ func WithStagePlugin[Config, DeployTargetConfig, ApplicationConfigSpec any](stagePlugin StagePlugin[Config, DeployTargetConfig, ApplicationConfigSpec]) PluginOption[Config, DeployTargetConfig, ApplicationConfigSpec]

+ type QuickSyncStage struct

+ AvailableOperation ManualOperation

+ Description string

+ Metadata map[string]string

+ Name string

+ Rollback bool

+ type ResourceHealthStatus int

+ const ResourceHealthStateHealthy

+ const ResourceHealthStateUnhealthy

+ const ResourceHealthStateUnknown

+ type ResourceState struct

+ CreatedAt time.Time

+ DeployTarget string

+ HealthDescription string

+ HealthStatus ResourceHealthStatus

+ ID string

+ Name string

+ ParentIDs []string

+ ResourceMetadata map[string]string

+ ResourceType string

+ type StageCommand struct

+ Commander string

+ Type CommandType

+ type StageConfig struct

+ Config []byte

+ Index int

+ Name string

+ type StageLogPersister interface

+ Error func(log string)

+ Errorf func(format string, a ...interface{})

+ Info func(log string)

+ Infof func(format string, a ...interface{})

+ Success func(log string)

+ Successf func(format string, a ...interface{})

+ Write func(log []byte) (int, error)

+ type StagePlugin interface

+ BuildPipelineSyncStages func(context.Context, *Config, *BuildPipelineSyncStagesInput) (*BuildPipelineSyncStagesResponse, error)

+ ExecuteStage func(context.Context, *Config, []*DeployTarget[DeployTargetConfig], ...) (*ExecuteStageResponse, error)

+ FetchDefinedStages func() []string

+ type StagePluginServiceServer struct

+ func (s *StagePluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) BuildPipelineSyncStages(ctx context.Context, request *deployment.BuildPipelineSyncStagesRequest) (*deployment.BuildPipelineSyncStagesResponse, error)

+ func (s *StagePluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) BuildQuickSyncStages(context.Context, *deployment.BuildQuickSyncStagesRequest) (*deployment.BuildQuickSyncStagesResponse, error)

+ func (s *StagePluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) DetermineStrategy(context.Context, *deployment.DetermineStrategyRequest) (*deployment.DetermineStrategyResponse, error)

+ func (s *StagePluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) DetermineVersions(context.Context, *deployment.DetermineVersionsRequest) (*deployment.DetermineVersionsResponse, error)

+ func (s *StagePluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) ExecuteStage(ctx context.Context, request *deployment.ExecuteStageRequest) (response *deployment.ExecuteStageResponse, _ error)

+ func (s *StagePluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) FetchDefinedStages(context.Context, *deployment.FetchDefinedStagesRequest) (*deployment.FetchDefinedStagesResponse, error)

+ func (s *StagePluginServiceServer[Config, DeployTargetConfig, ApplicationConfigSpec]) Register(server *grpc.Server)

+ type StageStatus int

+ const StageStatusExited

+ const StageStatusFailure

+ const StageStatusSkipped

+ const StageStatusSuccess

+ func (o StageStatus) String() string

+ type SyncStrategy int

+ const SyncStrategyPipelineSync

+ const SyncStrategyQuickSync

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL