plugin

Documentation

Overview

Package plugin provides a step provider that executes container-based Arcaflow plugins using deployers.

Index

• func New(logger log.Logger, deployerRegistry registry.Registry, ...) (step.Provider, error)
• type Crashed
• type DeployFailed
• type StageID

Functions

func New

func New(logger log.Logger, deployerRegistry registry.Registry, localDeployerConfigs map[string]any) (step.Provider, error)

New creates a new plugin provider. deployerRegistry The registry that contains all possible deployers. localDeployerConfig The section of the workflow config that pertains to all of the

deployers. Most importantly it specifies which deployer is used for this
deployment with the 'type' key.
For more info, see `config/schema.go`

Types

type Crashed

type Crashed struct {
	Output string `json:"output"`
}

Crashed describes the error that happened when a plugin crashed.

type DeployFailed

type DeployFailed struct {
	Error string `json:"error"`
}

DeployFailed describes the error that happened during deployment.

type StageID

type StageID string

StageID is the constant that holds valid plugin stage IDs.

const (
	// StageIDDeploy is the stage when the plugin container gets deployd.
	StageIDDeploy StageID = "deploy"
	// StageIDDeployFailed is the stage after a plugin container deployment failed.
	StageIDDeployFailed StageID = "deploy_failed"
	// StageIDRunning is a stage that indicates that a plugin is now working.
	StageIDRunning StageID = "running"
	// StageIDEnabling is a stage that indicates that the plugin is waiting to be enabled.
	// This is required to be separate to ensure that it exits immediately if disabled.
	StageIDEnabling StageID = "enabling"
	// StageIDDisabled is a stage that indicates that the plugin's step was disabled.
	StageIDDisabled StageID = "disabled"
	// StageIDCancelled is a stage that indicates that the plugin's step was cancelled.
	StageIDCancelled StageID = "cancelled"
	// StageIDOutput is a stage that indicates that the plugin has completed working successfully.
	StageIDOutput StageID = "outputs"
	// StageIDCrashed is a stage that indicates that the plugin has quit unexpectedly.
	StageIDCrashed StageID = "crashed"
	// StageIDClosed is a stage that indicates that the plugin has exited due to workflow
	// termination or step cancellation.
	StageIDClosed StageID = "closed"
	// StageIDStarting is a stage that indicates that the plugin execution has begun.
	StageIDStarting StageID = "starting"
)