cluster

Documentation

Index

• Constants
• Variables
• func CheckPhase(phase string) error
• func GetPhase(phase string) string
• func GetPhasesOrder() []string
• func RegisterCreatorFactory(apiVersion, kind string, factory CreatorFactory)
• func RegisterDeleterFactory(apiVersion, kind string, factory DeleterFactory)
• func ValidateOperationPhase(phase string) error
• type Creator
  • func NewCreator(minimalConf config.Furyctl, kfdManifest config.KFD, paths CreatorPaths, ...) (Creator, error)
• type CreatorFactory
  • func NewCreatorFactory[T Creator, S any](cc T) CreatorFactory
• type CreatorPaths
• type CreatorProperty
• type Deleter
  • func NewDeleter(minimalConf config.Furyctl, kfdManifest config.KFD, paths DeleterPaths, ...) (Deleter, error)
• type DeleterFactory
  • func NewDeleterFactory[T Deleter, S any](dd T) DeleterFactory
• type DeleterPaths
• type DeleterProperty
• type OperationPhase
  • func NewOperationPhase(folder string, kfdTools config.KFDTools, binPath string) *OperationPhase
  • func (*OperationPhase) CopyFromTemplate(cfg template.Config, prefix, sourcePath, targetPath, furyctlConfPath string) error
  • func (op *OperationPhase) CopyPathsToConfig(cfg *template.Config)
  • func (op *OperationPhase) CreateFolderStructure() error
  • func (op *OperationPhase) CreateRootFolder() error
  • func (op *OperationPhase) Self() *OperationPhase
• type OperationPhaseOption

Constants

const (
	CreatorPropertyConfigPath           = "configpath"
	CreatorPropertyWorkDir              = "workdir"
	CreatorPropertyFuryctlConf          = "furyctlconf"
	CreatorPropertyKfdManifest          = "kfdmanifest"
	CreatorPropertyDistroPath           = "distropath"
	CreatorPropertyBinPath              = "binpath"
	CreatorPropertyPhase                = "phase"
	CreatorPropertySkipVpn              = "skipvpn"
	CreatorPropertyVpnAutoConnect       = "vpnautoconnect"
	CreatorPropertyDryRun               = "dryrun"
	CreatorPropertyForce                = "force"
	CreatorPropertyUpgrade              = "upgrade"
	CreatorPropertyExternalUpgradesPath = "externalupgradespath"
)

const (
	DeleterPropertyFuryctlConf    = "furyctlconf"
	DeleterPropertyPhase          = "phase"
	DeleterPropertyWorkDir        = "workdir"
	DeleterPropertyKfdManifest    = "kfdmanifest"
	DeleterPropertyBinPath        = "binpath"
	DeleterPropertySkipVpn        = "skipvpn"
	DeleterPropertyVpnAutoConnect = "vpnautoconnect"
	DeleterPropertyDryRun         = "dryrun"
)

const (
	OperationPhasePreFlight             = "preflight"
	OperationPhaseInfrastructure        = "infrastructure"
	OperationSubPhasePreInfrastructure  = "pre-infrastructure"
	OperationSubPhasePostInfrastructure = "post-infrastructure"
	OperationPhaseKubernetes            = "kubernetes"
	OperationSubPhasePreKubernetes      = "pre-kubernetes"
	OperationSubPhasePostKubernetes     = "post-kubernetes"
	OperationPhaseDistribution          = "distribution"
	OperationSubPhasePreDistribution    = "pre-distribution"
	OperationSubPhasePostDistribution   = "post-distribution"
	OperationPhasePlugins               = "plugins"
	OperationPhasePreUpgrade            = "pre-upgrade"
	OperationPhaseAll                   = ""

	OperationPhaseOptionVPNAutoConnect = "vpnautoconnect"
)

Variables

var (
	ErrUnsupportedPhase = errors.New(
		"unsupported phase, options are: infrastructure, kubernetes, distribution, plugins",
	)
	ErrUnsupportedOperationPhase = errors.New(
		"unsupported operation phase, options are: pre-infrastructure, infrastructure, post-infrastructure, " +
			"pre-kubernetes, kubernetes, post-kubernetes, pre-distribution, distribution, post-distribution, plugins",
	)
)

var ErrCannotSetEnvVar = errors.New("cannot set env var")

Functions

func CheckPhase

func CheckPhase(phase string) error

func GetPhase

func GetPhase(phase string) string

func GetPhasesOrder

func GetPhasesOrder() []string

func RegisterCreatorFactory

func RegisterCreatorFactory(apiVersion, kind string, factory CreatorFactory)

func RegisterDeleterFactory

func RegisterDeleterFactory(apiVersion, kind string, factory DeleterFactory)

func ValidateOperationPhase

func ValidateOperationPhase(phase string) error

Types

type Creator

type Creator interface {
	SetProperties(props []CreatorProperty)
	SetProperty(name string, value any)
	Create(startFrom string, timeout int) error
	GetPhasePath(phase string) (string, error)
}

func NewCreator

func NewCreator(
	minimalConf config.Furyctl,
	kfdManifest config.KFD,
	paths CreatorPaths,
	phase string,
	skipVpn,
	vpnAutoConnect,
	dryRun,
	force bool,
	upgrade bool,
	externalUpgradesPath string,
) (Creator, error)

type CreatorFactory

type CreatorFactory func(configPath string, props []CreatorProperty) (Creator, error)

func NewCreatorFactory

func NewCreatorFactory[T Creator, S any](cc T) CreatorFactory

type CreatorPaths

type CreatorPaths struct {
	ConfigPath string
	WorkDir    string
	DistroPath string
	BinPath    string
}

type CreatorProperty

type CreatorProperty struct {
	Name  string
	Value any
}

type Deleter

type Deleter interface {
	SetProperties(props []DeleterProperty)
	SetProperty(name string, value any)
	Delete() error
}

func NewDeleter

func NewDeleter(
	minimalConf config.Furyctl,
	kfdManifest config.KFD,
	paths DeleterPaths,
	phase string,
	skipVpn,
	vpnAutoConnect,
	dryRun bool,
) (Deleter, error)

type DeleterFactory

type DeleterFactory func(configPath string, props []DeleterProperty) (Deleter, error)

func NewDeleterFactory

func NewDeleterFactory[T Deleter, S any](dd T) DeleterFactory

type DeleterPaths

type DeleterPaths struct {
	ConfigPath string
	WorkDir    string
	BinPath    string
}

type DeleterProperty

type DeleterProperty struct {
	Name  string
	Value any
}

type OperationPhase

type OperationPhase struct {
	Path                 string
	TerraformPath        string
	KustomizePath        string
	KubectlPath          string
	YqPath               string
	HelmPath             string
	HelmfilePath         string
	TerraformPlanPath    string
	TerraformLogsPath    string
	TerraformOutputsPath string
	TerraformSecretsPath string
	// contains filtered or unexported fields
}

func NewOperationPhase

func NewOperationPhase(folder string, kfdTools config.KFDTools, binPath string) *OperationPhase

func (*OperationPhase) CopyFromTemplate

func (*OperationPhase) CopyFromTemplate(
	cfg template.Config,
	prefix,
	sourcePath,
	targetPath,
	furyctlConfPath string,
) error

func (*OperationPhase) CopyPathsToConfig

func (op *OperationPhase) CopyPathsToConfig(cfg *template.Config)

func (*OperationPhase) CreateFolderStructure

func (op *OperationPhase) CreateFolderStructure() error

func (*OperationPhase) CreateRootFolder

func (op *OperationPhase) CreateRootFolder() error

func (*OperationPhase) Self

func (op *OperationPhase) Self() *OperationPhase

type OperationPhaseOption

type OperationPhaseOption struct {
	Name  string
	Value any
}