run

Documentation

Overview

Package run executes approved imperative UWS runbooks without treating their outputs as desired-state resources.

This package is experimental in Ramen v0.1 and is adjacent to Ramen's native desired-state lifecycle.

Index

• Constants
• type ExecutedTarget
• type Options
• type Result
  • func Execute(ctx context.Context, opts Options) (*Result, error)
• type Summary

Constants

const Version = "ramen.run.v1"

Types

type ExecutedTarget

type ExecutedTarget struct {
	Target string          `json:"target"`
	Action string          `json:"action"`
	Result executor.Result `json:"result,omitempty"`
	Error  string          `json:"error,omitempty"`
}

type Options

type Options struct {
	DocumentPath   string
	StatePath      string
	Workspace      string
	Targets        []string
	PolicyFiles    []string
	Check          bool
	AutoApprove    bool
	ApprovalDigest string
	OutDir         string
	Executor       executor.Executor
}

type Result

type Result struct {
	Version        string            `json:"version"`
	DocumentPath   string            `json:"document_path"`
	DocumentDigest string            `json:"document_digest"`
	StatePath      string            `json:"state_path,omitempty"`
	Workspace      string            `json:"workspace,omitempty"`
	RunID          int64             `json:"run_id,omitempty"`
	Check          bool              `json:"check"`
	ApprovalDigest string            `json:"approval_digest"`
	Governance     governance.Result `json:"governance,omitempty"`
	Summary        Summary           `json:"summary"`
	Executed       []ExecutedTarget  `json:"executed,omitempty"`
	Errors         []string          `json:"errors,omitempty"`
}

func Execute

func Execute(ctx context.Context, opts Options) (*Result, error)

type Summary

type Summary struct {
	Targets  int `json:"targets"`
	Executed int `json:"executed"`
	Skipped  int `json:"skipped"`
	Failed   int `json:"failed"`
}