app

Documentation

Index

• func CreateDeploy(nsConfig api.Config, stackId, appId, envId int64, version string) error
• type Details
• type Provider
• type Providers
  • func (p Providers) Find(curModule types.Module) Provider
• type StatusDetailReport
• type StatusDetailReports
• type StatusRecord
• type StatusRecords
• type StatusReport

Functions

func CreateDeploy

func CreateDeploy(nsConfig api.Config, stackId, appId, envId int64, version string) error

Types

type Details

type Details struct {
	App       *types.Application
	Env       *types.Environment
	Workspace *types.Workspace
	Module    *types.Module
}

type Provider

type Provider interface {
	DefaultLogProvider() string
	Push(nsConfig api.Config, details Details, userConfig map[string]string) error
	Deploy(nsConfig api.Config, details Details, userConfig map[string]string) error

	// Exec allows a user to execute a command (usually tunneling) into a running service
	// This only makes sense for container-based providers
	Exec(ctx context.Context, nsConfig api.Config, details Details, userConfig map[string]string) error

	// Ssh allows a user to SSH into a running service
	Ssh(ctx context.Context, nsConfig api.Config, details Details, userConfig map[string]any) error

	// Status returns a high-level status report on the specified app env
	Status(nsConfig api.Config, details Details) (StatusReport, error)

	// StatusDetail returns a detailed status report on the specified app env
	StatusDetail(nsConfig api.Config, details Details) (StatusDetailReports, error)
}

Provider provides a standard interface to run commands against an app Each Operator is responsible for:

• Collecting necessary information from a workspace's outputs
• Modifying infrastructure to perform each command (e.g. push, deploy, etc.)
• Each Provider is specific to Category+Type (Example: category=app/container, type=service/aws-fargate)

type Providers

type Providers map[types.ModuleContractName]Provider

func (Providers) Find

func (p Providers) Find(curModule types.Module) Provider

type StatusDetailReport

type StatusDetailReport struct {
	Name    string
	Records StatusRecords
}

type StatusDetailReports

type StatusDetailReports []StatusDetailReport

type StatusRecord

type StatusRecord struct {
	Fields []string
	Data   map[string]interface{}
}

type StatusRecords

type StatusRecords []StatusRecord

type StatusReport

type StatusReport struct {
	Fields []string
	Data   map[string]interface{}
}