internal

Documentation

Overview

Package internal is for internal loftsman operations

Index

• Constants
• type Loftsman
  • func NewLoftsman() *Loftsman
  • func (loftsman *Loftsman) Avast() error
  • func (loftsman *Loftsman) Initialize(commandString string) error
  • func (loftsman *Loftsman) ManifestCreate() error
  • func (loftsman *Loftsman) ManifestValidate(args ...string) error
  • func (loftsman *Loftsman) Ship() error

Constants

const (
	// ShipCmd is the cli ship command identifier
	ShipCmd = "ship"
	// ManifestCmd is the cli manifest command identifier
	ManifestCmd = "manifest"
	// CreateCmd is the cli create command identifier
	CreateCmd = "create"
	// ValidateCmd is the cli validate command identifier
	ValidateCmd = "validate"
	// AvastCmd is the cli avast command identifier
	AvastCmd = "avast"
)

Types

type Loftsman

type Loftsman struct {
	Settings *settings.Settings
	// contains filtered or unexported fields
}

Loftsman is the central object for loftsman operations, settings, data, etc.

func NewLoftsman

func NewLoftsman() *Loftsman

NewLoftsman will return the default, initial Loftsman object

func (*Loftsman) Avast

func (loftsman *Loftsman) Avast() error

Avast will look for an existing, locked manifest being shipped and tell it to halt NOTE: this command/method won't actually be able to kill any existing loftsman cli operation in progress, this is more about updating the state stored in the cluster about a given ship run in the case of that getting stuck by catastrophic failures of the loftsman cli during a ship

func (*Loftsman) Initialize

func (loftsman *Loftsman) Initialize(commandString string) error

Initialize will go through the process of initializing or setting up common needs/objects across all commands

func (*Loftsman) ManifestCreate

func (loftsman *Loftsman) ManifestCreate() error

ManifestCreate will create a new manifest and output it to stdout

func (*Loftsman) ManifestValidate

func (loftsman *Loftsman) ManifestValidate(args ...string) error

ManifestValidate will validate a manifest

func (*Loftsman) Ship

func (loftsman *Loftsman) Ship() error

Ship is the main operation to prep and ship out workloads to the cluster via Helm, etc.