run

Nov 22, 2024

Changes in this version

type Options

+ Authorizer *authz.Authorizer

Oct 30, 2024

Changes in this version

+ type MetricsCollector struct

+ Service *Service

+ func (mc *MetricsCollector) Start(ctx context.Context) error

Oct 22, 2024

Changes in this version

+ const TimeoutLockID

type Reporter

+ Cache map[string]vcs.Status

+ type Timeout struct

+ ApplyingTimeout time.Duration

+ OverrideCheckInterval time.Duration

+ PlanningTimeout time.Duration

+ Runs timeoutRunClient

+ func (e *Timeout) Start(ctx context.Context) error

Dec 11, 2023

Changes in this version

+ var ErrRunCancelNotAllowed = errors.New("run was not planning or applying; cancel not allowed")

+ var ErrRunDiscardNotAllowed = errors.New("run was not paused for confirmation or priority; discard not allowed")

+ var ErrRunForceCancelNotAllowed = errors.New(...)

type Client

+ func (c *Client) Get(ctx context.Context, runID string) (*Run, error)

type Options

+ ConfigVersionService *configversion.Service

+ OrganizationService *organization.Service

+ ReleasesService *releases.Service

+ TokensService *tokens.Service

+ VCSProviderService *vcsprovider.Service

+ WorkspaceService *workspace.Service

type Reporter

+ Configs reporterConfigClient

+ Runs reporterRunClient

+ VCS reporterVCSClient

+ Workspaces reporterWorkspaceClient

type Service

+ func (a Service) CanAccess(ctx context.Context, action rbac.Action, runID string) (internal.Subject, error)

+ func (f Service) NewRun(ctx context.Context, workspaceID string, opts CreateOptions) (*Run, error)

+ func (s *Service) AddHandlers(r *mux.Router)

+ func (s *Service) Create(ctx context.Context, workspaceID string, opts CreateOptions) (*Run, error)

+ func (s *Service) Discard(ctx context.Context, runID string) error

+ func (s *Service) ForceCancel(ctx context.Context, runID string) error

+ func (s *Service) Get(ctx context.Context, runID string) (*Run, error)

+ func (s *Service) GetLockFile(ctx context.Context, runID string) ([]byte, error)

+ func (s *Service) List(ctx context.Context, opts ListOptions) (*resource.Page[*Run], error)

+ func (s *Service) UploadLockFile(ctx context.Context, runID string, file []byte) error

Dec 5, 2023

Changes in this version

type ReporterOptions

+ Service Service

type Run

+ AgentPoolID *string

+ CancelSignaledAt *time.Time

+ func (r *Run) ForceCancelable() bool

+ func (r *Run) InProgress() bool

type Service

+ AfterCancelRun func(hook func(context.Context, *Run) error)

+ AfterEnqueueApply func(hook func(context.Context, *Run) error)

+ AfterEnqueuePlan func(hook func(context.Context, *Run) error)

+ AfterForceCancelRun func(hook func(context.Context, *Run) error)

+ WatchRuns func(context.Context) (<-chan pubsub.Event[*Run], func())

Oct 29, 2023

Changes in this version

+ var ActiveRun = []Status

+ var IncompleteRun = append(ActiveRun, RunPending)

+ type PeriodReport struct

+ Periods []StatusPeriod

+ TotalTime time.Duration

+ func (r PeriodReport) Percentage(i int) float64

type Phase

+ func (p *Phase) Done() bool

+ func (p *Phase) ElapsedTime(now time.Time) time.Duration

+ func (p *Phase) HasStarted() bool

+ func (p *Phase) StartedAt() time.Time

+ func (p *Phase) String() string

type Run

+ func (r *Run) ElapsedTime(now time.Time) time.Duration

+ func (r *Run) HasStarted() bool

+ func (r *Run) PeriodReport(now time.Time) (report PeriodReport)

+ func (r *Run) StartedAt() time.Time

+ func (r *Run) String() string

+ type Status string

+ const RunApplied

+ const RunApplyQueued

+ const RunApplying

+ const RunCanceled

+ const RunConfirmed

+ const RunCostEstimated

+ const RunDiscarded

+ const RunErrored

+ const RunForceCanceled

+ const RunPending

+ const RunPlanQueued

+ const RunPlanned

+ const RunPlannedAndFinished

+ const RunPlanning

+ func (r Status) String() string

+ type StatusPeriod struct

+ Period time.Duration

+ Status Status

Oct 20, 2023

Changes in this version

type Options

+ VCSEventSubscriber vcs.Subscriber

Sep 2, 2023

Changes in this version

+ func NewCommand(httpClient *http.Client) *cobra.Command

+ type CLI struct

Aug 13, 2023

Changes in this version

+ type CreateOptions struct

+ AllowEmptyApply *bool

+ AutoApply *bool

+ ConfigurationVersionID *string

+ IsDestroy *bool

+ Message *string

+ PlanOnly *bool

+ Refresh *bool

+ RefreshOnly *bool

+ ReplaceAddrs []string

+ Source Source

+ TargetAddrs []string

+ TerraformVersion *string

+ Variables []Variable

+ type List struct

+ Items []*Run

+ type ListOptions struct

+ CommitSHA *string

+ Organization *string

+ PlanOnly *bool

+ Sources []Source

+ Statuses []internal.RunStatus

+ VCSUsername *string

+ WorkspaceID *string

+ WorkspaceName *string

+ type OrganizationService organization.Service

type Run

+ AllowEmptyApply bool

+ CostEstimationEnabled bool

+ Source Source

+ TerraformVersion string

+ Variables []Variable

+ func (r *Run) IsAPISource() bool

+ func (r *Run) IsCLISource() bool

+ func (r *Run) IsGithubSource() bool

+ func (r *Run) IsGitlabSource() bool

+ func (r *Run) IsUISource() bool

+ type Source string

+ const SourceAPI

+ const SourceGithub

+ const SourceGitlab

+ const SourceTerraform

+ const SourceUI

+ type StatusTimestamp struct

+ Status internal.RunStatus

+ Timestamp time.Time

+ type Variable struct

+ Key string

+ Value string

Aug 2, 2023

Changes in this version

type Run

+ CreatedBy *string

+ IngressAttributes *configversion.IngressAttributes

Jul 8, 2023

Changes in this version

+ func CompilePlanReports(planJSON []byte) (resources Report, outputs Report, err error)

type Phase

+ OutputReport *Report

+ ResourceReport *Report

type PlanFile

+ OutputChanges map[string]Change

+ func (pf *PlanFile) Summarize() (resource, output Report)

+ type Report struct

+ Additions int

+ Changes int

+ Destructions int

+ func (r Report) HasChanges() bool

+ func (r Report) String() string

Jun 25, 2023

Changes in this version

+ const DestroyAllOperation

+ const PlanAndApplyOperation

+ const PlanFormatBinary

+ const PlanFormatJSON

+ const PlanOnlyOperation

+ const PullVCSMagicString

+ const ReporterLockID

+ var ErrInvalidRunStateTransition = errors.New("invalid run state transition")

+ var ErrPhaseAlreadyStarted = errors.New("phase already started")

+ func NewService(opts Options) *service

+ type Change struct

+ Actions []ChangeAction

+ type ChangeAction string

+ const CreateAction

+ const DeleteAction

+ const UpdateAction

+ type Client struct

+ func (c *Client) FinishPhase(ctx context.Context, id string, phase internal.PhaseType, ...) (*Run, error)

+ func (c *Client) GetLockFile(ctx context.Context, runID string) ([]byte, error)

+ func (c *Client) GetPlanFile(ctx context.Context, runID string, format PlanFormat) ([]byte, error)

+ func (c *Client) GetRun(ctx context.Context, runID string) (*Run, error)

+ func (c *Client) ListRuns(ctx context.Context, opts RunListOptions) (*RunList, error)

+ func (c *Client) StartPhase(ctx context.Context, id string, phase internal.PhaseType, ...) (*Run, error)

+ func (c *Client) UploadLockFile(ctx context.Context, runID string, lockfile []byte) error

+ func (c *Client) UploadPlanFile(ctx context.Context, runID string, plan []byte, format PlanFormat) error

+ func (c *Client) Watch(ctx context.Context, opts WatchOptions) (<-chan pubsub.Event, error)

+ type ConfigurationVersionService configversion.Service

+ type Operation string

+ type Options struct

+ WorkspaceAuthorizer internal.Authorizer

+ type Phase struct

+ RunID string

+ Status PhaseStatus

+ StatusTimestamps []PhaseStatusTimestamp

+ func NewPhase(runID string, t internal.PhaseType) Phase

+ func (p *Phase) HasChanges() bool

+ func (p *Phase) StatusTimestamp(status PhaseStatus) (time.Time, error)

+ func (p *Phase) UpdateStatus(status PhaseStatus)

+ type PhaseFinishOptions struct

+ Errored bool

+ Type string

+ type PhaseStartOptions struct

+ AgentID string

+ Type string

+ type PhaseStatus string

+ const PhaseCanceled

+ const PhaseErrored

+ const PhaseFinished

+ const PhasePending

+ const PhaseQueued

+ const PhaseRunning

+ const PhaseUnreachable

+ func (s PhaseStatus) String() string

+ type PhaseStatusTimestamp struct

+ Status PhaseStatus

+ Timestamp time.Time

+ type PlanFile struct

+ ResourceChanges []ResourceChange

+ func (pf *PlanFile) Changes() (tally ResourceReport)

+ type PlanFileOptions struct

+ Format PlanFormat

+ type PlanFormat string

+ type Reporter struct

+ func (r *Reporter) Start(ctx context.Context) error

+ type ReporterOptions struct

+ ConfigurationVersionService configversion.Service

+ VCSProviderService VCSProviderService

+ WorkspaceService workspace.Service

+ type ResourceChange struct

+ Change Change

+ type ResourceReport struct

+ Additions int

+ Changes int

+ Destructions int

+ func CompilePlanReport(planJSON []byte) (ResourceReport, error)

+ func ParseApplyOutput(output string) (ResourceReport, error)

+ func (r ResourceReport) HasChanges() bool

+ func (r ResourceReport) String() string

+ type Run struct

+ Apply Phase

+ AutoApply bool

+ Commit *string

+ ConfigurationVersionID string

+ CreatedAt time.Time

+ ExecutionMode workspace.ExecutionMode

+ ForceCancelAvailableAt *time.Time

+ ID string

+ IsDestroy bool

+ Latest bool

+ Message string

+ Organization string

+ Plan Phase

+ PlanOnly bool

+ PositionInQueue int

+ Refresh bool

+ RefreshOnly bool

+ ReplaceAddrs []string

+ Status internal.RunStatus

+ StatusTimestamps []RunStatusTimestamp

+ TargetAddrs []string

+ WorkspaceID string

+ func UnmarshalJSONAPI(b []byte) (*Run, error)

+ func (*Run) CanAccessSite(action rbac.Action) bool

+ func (r *Run) CanAccessOrganization(action rbac.Action, name string) bool

+ func (r *Run) CanAccessWorkspace(action rbac.Action, policy *internal.WorkspacePolicy) bool

+ func (r *Run) Cancel() (enqueue bool, err error)

+ func (r *Run) Cancelable() bool

+ func (r *Run) Confirmable() bool

+ func (r *Run) Discard() error

+ func (r *Run) Discardable() bool

+ func (r *Run) Done() bool

+ func (r *Run) EnqueueApply() error

+ func (r *Run) EnqueuePlan() error

+ func (r *Run) Finish(phase internal.PhaseType, opts PhaseFinishOptions) error

+ func (r *Run) ForceCancel() error

+ func (r *Run) HasApply() bool

+ func (r *Run) HasChanges() bool

+ func (r *Run) Phase() internal.PhaseType

+ func (r *Run) Queued() bool

+ func (r *Run) Start(phase internal.PhaseType) error

+ func (r *Run) StatusTimestamp(status internal.RunStatus) (time.Time, error)

+ type RunCreateOptions struct

+ AutoApply *bool

+ ConfigurationVersionID *string

+ IsDestroy *bool

+ Message *string

+ PlanOnly *bool

+ Refresh *bool

+ RefreshOnly *bool

+ ReplaceAddrs []string

+ TargetAddrs []string

+ type RunList struct

+ Items []*Run

+ type RunListOptions struct

+ Include *string

+ Organization *string

+ PlanOnly *bool

+ Statuses []internal.RunStatus

+ WorkspaceID *string

+ WorkspaceName *string

+ type RunService = Service

+ type RunStatusTimestamp struct

+ Status internal.RunStatus

+ Timestamp time.Time

+ type Service interface

+ Apply func(ctx context.Context, runID string) error

+ Cancel func(ctx context.Context, runID string) (*Run, error)

+ CreateRun func(ctx context.Context, workspaceID string, opts RunCreateOptions) (*Run, error)

+ Delete func(ctx context.Context, runID string) error

+ DiscardRun func(ctx context.Context, runID string) error

+ EnqueuePlan func(ctx context.Context, runID string) (*Run, error)

+ FinishPhase func(ctx context.Context, runID string, phase internal.PhaseType, ...) (*Run, error)

+ ForceCancelRun func(ctx context.Context, runID string) error

+ GetPlanFile func(ctx context.Context, runID string, format PlanFormat) ([]byte, error)

+ GetRun func(ctx context.Context, id string) (*Run, error)

+ ListRuns func(ctx context.Context, opts RunListOptions) (*RunList, error)

+ RetryRun func(ctx context.Context, id string) (*Run, error)

+ StartPhase func(ctx context.Context, runID string, phase internal.PhaseType, ...) (*Run, error)

+ UploadPlanFile func(ctx context.Context, runID string, plan []byte, format PlanFormat) error

+ Watch func(ctx context.Context, opts WatchOptions) (<-chan pubsub.Event, error)

+ type Spawner struct

+ func (s *Spawner) Start(ctx context.Context) error

+ type VCSProviderService vcsprovider.Service

+ type WatchOptions struct

+ Organization *string

+ WorkspaceID *string

+ type WorkspaceService workspace.Service