settings

Documentation

Index

• type JSONLog
• type Kubernetes
• type Manifest
• type Settings
  • func New() *Settings
  • func (s *Settings) ValidateChartsSource() error
  • func (s *Settings) ValidateManifestPath() error

Types

type JSONLog

type JSONLog struct {
	Path string
	File *os.File
}

JSONLog are settings related to the written JSON log file

type Kubernetes

type Kubernetes struct {
	KubeconfigPath string // absolute path to the k8s config path to use
	KubeContext    string // name of the kubeconfig context to use
}

Kubernetes are settings and data related to Kubernetes API communication

type Manifest

type Manifest struct {
	Name       string // name of the manifest, used in avast operations
	Path       string // local path to the loftsman manifest to use for a ship
	Content    []byte // the bytes of the manifest file
	ChartNames string // comma-delimited list of charts provided when creating a new manifest file
}

Manifest are those specific to operations using, producing, validating manifests

type Settings

type Settings struct {
	RunID          string
	TempDirectory  string
	JSONLog        *JSONLog
	Namespace      string // the namespace where loftsman will keep internal-use resources
	Manifest       *Manifest
	ChartsSource   *interfaces.HelmChartsSource
	Kubernetes     *Kubernetes
	HelmExecConfig *interfaces.HelmExecConfig
}

Settings are all dynamic settings and data to be used in Loftsman operations

func New

func New() *Settings

New gets a settings object with defaults

func (*Settings) ValidateChartsSource

func (s *Settings) ValidateChartsSource() error

ValidateChartsSource will make sure related charts source settings are set up correctly

func (*Settings) ValidateManifestPath

func (s *Settings) ValidateManifestPath() error

ValidateManifestPath will ensure our manifest path setting is valid