Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

phase

package

Go to main page

Versions in this module

v0

v0.4.0

May 23, 2026

v0.3.0

May 7, 2026

Changes in this version

type KubeConfig

+ ClusterLB string

+ func (p *KubeConfig) ShouldRun() bool

v0.2.5

Apr 29, 2026

v0.2.4

Apr 29, 2026

v0.2.3

Apr 28, 2026

v0.2.2

Apr 28, 2026

v0.2.1

Apr 28, 2026

v0.2.0

Apr 28, 2026

v0.1.0

Apr 27, 2026

Changes in this version

+ const ContainerSELinux

+ const FAPOLICYD

+ const FAPolicydRuleFile

+ const FIREWALLD

+ const UnknownVersion

+ var ErrNoControllers = errors.New("no controllers are running")

+ var Force bool

+ var Interval = 10 * time.Second

+ var NoWait bool

+ type APTUploadFiles struct

+ func (p *APTUploadFiles) Explanation() string

+ func (p *APTUploadFiles) Prepare(ctx context.Context, c *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *APTUploadFiles) Run(ctx context.Context) (err error)

+ func (p *APTUploadFiles) Title() string

+ type BINUploadFiles struct

+ Distro distrocfg.Distro

+ func (p *BINUploadFiles) Explanation() string

+ func (p *BINUploadFiles) Prepare(ctx context.Context, c *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *BINUploadFiles) Run(ctx context.Context) (err error)

+ func (p *BINUploadFiles) Title() string

+ type ConfigureEngine struct

+ Distro distrocfg.Distro

+ func (p *ConfigureEngine) Explanation() string

+ func (p *ConfigureEngine) Prepare(ctx context.Context, c *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *ConfigureEngine) Run(ctx context.Context) error

+ func (p *ConfigureEngine) Title() string

+ type ConfigureFirewall struct

+ Distro distrocfg.Distro

+ Enabled bool

+ func (p *ConfigureFirewall) Explanation() string

+ func (p *ConfigureFirewall) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *ConfigureFirewall) Run(ctx context.Context) error

+ func (p *ConfigureFirewall) ShouldRun() bool

+ func (p *ConfigureFirewall) Title() string

+ type ConfigureFirewallPorts struct

+ Enabled bool

+ func (p *ConfigureFirewallPorts) Explanation() string

+ func (p *ConfigureFirewallPorts) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *ConfigureFirewallPorts) Run(ctx context.Context) error

+ func (p *ConfigureFirewallPorts) ShouldRun() bool

+ func (p *ConfigureFirewallPorts) Title() string

+ type Connect struct

+ func (p *Connect) Explanation() string

+ func (p *Connect) Run(ctx context.Context) error

+ func (p *Connect) Title() string

+ type DaemonReload struct

+ func (p *DaemonReload) Explanation() string

+ func (p *DaemonReload) Run(ctx context.Context) error

+ func (p *DaemonReload) ShouldRun() bool

+ func (p *DaemonReload) Title() string

+ type DeleteCommon struct

+ Distro distrocfg.Distro

+ func (p *DeleteCommon) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ type DeleteControllers struct

+ NoDrain bool

+ func (p *DeleteControllers) Explanation() string

+ func (p *DeleteControllers) Prepare(ctx context.Context, c *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *DeleteControllers) Run(ctx context.Context) error

+ func (p *DeleteControllers) ShouldRun() bool

+ func (p *DeleteControllers) Title() string

+ type DeleteWorkers struct

+ NoDrain bool

+ WorkerConcurrent int

+ func (p *DeleteWorkers) Explanation() string

+ func (p *DeleteWorkers) Prepare(ctx context.Context, c *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *DeleteWorkers) Run(ctx context.Context) error

+ func (p *DeleteWorkers) ShouldRun() bool

+ func (p *DeleteWorkers) Title() string

+ type DetectOS struct

+ func (p *DetectOS) Explanation() string

+ func (p *DetectOS) Run(ctx context.Context) error

+ func (p *DetectOS) Title() string

+ type Disconnect struct

+ func (p *Disconnect) DryRun() error

+ func (p *Disconnect) Explanation() string

+ func (p *Disconnect) Run(ctx context.Context) error

+ func (p *Disconnect) Title() string

+ type FirewallNodeConfig struct

+ Entries []string

+ Long string

+ Short string

+ Type string

+ XMLName xml.Name

+ type FirewallPortConfig struct

+ Ports []cluster.ZarfHostPort

+ Short string

+ XMLName xml.Name

+ type GatherFacts struct

+ func (p *GatherFacts) Explanation() string

+ func (p *GatherFacts) Run(ctx context.Context) error

+ func (p *GatherFacts) Title() string

+ type GatherFactsDistro struct

+ Distro distrocfg.Distro

+ func (p *GatherFactsDistro) Explanation() string

+ func (p *GatherFactsDistro) Prepare(_ context.Context, _ *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *GatherFactsDistro) Run(ctx context.Context) (err error)

+ func (p *GatherFactsDistro) Title() string

+ type GenericPhase struct

+ func (p *GenericPhase) GetConfig() *cluster.ZarfCluster

+ func (p *GenericPhase) GetDistro() *distro.ZarfDistro

+ func (p *GenericPhase) Prepare(c *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *GenericPhase) SetManager(m *Manager)

+ func (p *GenericPhase) VersionGreater(host *cluster.ZarfHost, version string) bool

+ func (p *GenericPhase) VersionLess(host *cluster.ZarfHost, version string) bool

+ func (p *GenericPhase) Wet(host fmt.Stringer, msg string, funcs ...errorfunc) error

+ type InitializeControllers struct

+ Distro distrocfg.Distro

+ func (p *InitializeControllers) Explanation() string

+ func (p *InitializeControllers) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *InitializeControllers) Run(ctx context.Context) error

+ func (p *InitializeControllers) ShouldRun() bool

+ func (p *InitializeControllers) Title() string

+ type InitializeWorkers struct

+ Distro distrocfg.Distro

+ WorkerConcurrent int

+ func (p *InitializeWorkers) Explanation() string

+ func (p *InitializeWorkers) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *InitializeWorkers) Run(ctx context.Context) error

+ func (p *InitializeWorkers) ShouldRun() bool

+ func (p *InitializeWorkers) Title() string

+ type InstallFapolicy struct

+ Enabled bool

+ func (p *InstallFapolicy) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *InstallFapolicy) Run(ctx context.Context) error

+ func (p *InstallFapolicy) ShouldRun() bool

+ func (p *InstallFapolicy) Title() string

+ type KubeConfig struct

+ ClusterID string

+ Distro distrocfg.Distro

+ Enabled bool

+ func (p *KubeConfig) Explanation() string

+ func (p *KubeConfig) Prepare(ctx context.Context, c *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *KubeConfig) Run(_ context.Context) error

+ func (p *KubeConfig) Title() string

+ type Lock struct

+ func (p *Lock) Cancel(_ context.Context)

+ func (p *Lock) CleanUp()

+ func (p *Lock) Explanation() string

+ func (p *Lock) Prepare(ctx context.Context, c *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *Lock) Run(ctx context.Context) error

+ func (p *Lock) Title() string

+ func (p *Lock) UnlockPhase() Phase

+ type Manager struct

+ Concurrency int

+ ConcurrentUploads int

+ Config *cluster.ZarfCluster

+ Distro *distro.ZarfDistro

+ DistroID string

+ DryRun bool

+ TempDirectory string

+ Timeout time.Duration

+ Writer io.Writer

+ func NewManager(config *cluster.ZarfCluster, distro distrocfg.Distro) (*Manager, error)

+ func (m *Manager) AddPhase(p ...Phase)

+ func (m *Manager) GetDistroOSFiles() v1alpha1.ZarfFiles

+ func (m *Manager) RetryTimeout(ctx context.Context, f func(ctx context.Context) error) error

+ func (m *Manager) Run(ctx context.Context) error

+ func (m *Manager) SetPhases(p Phases)

+ func (m *Manager) SetTimout(tm time.Duration)

+ func (m *Manager) Wet(_ fmt.Stringer, _ string, funcs ...errorfunc) error

+ type ManagerDistroConfig struct

+ Binary string

+ BinaryDir string

+ Config string

+ Data string

+ Token string

+ Version string

+ type ModifyHosts struct

+ Enabled bool

+ func (p *ModifyHosts) Explanation() string

+ func (p *ModifyHosts) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *ModifyHosts) Run(ctx context.Context) error

+ func (p *ModifyHosts) ShouldRun() bool

+ func (p *ModifyHosts) Title() string

+ type Phase interface

+ Explanation func() string

+ Run func(context.Context) error

+ Title func() string

+ type Phases []Phase

+ func (p *Phases) InsertAfter(title string, phase Phase)

+ func (p *Phases) InsertBefore(title string, phase Phase)

+ func (p *Phases) Replace(title string, phase Phase)

+ func (p Phases) Index(title string) int

+ type PrepareFapolicy struct

+ func (p *PrepareFapolicy) Explanation() string

+ func (p *PrepareFapolicy) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *PrepareFapolicy) Run(ctx context.Context) error

+ func (p *PrepareFapolicy) ShouldRun() bool

+ func (p *PrepareFapolicy) Title() string

+ type PrepareHosts struct

+ func (p *PrepareHosts) Explanation() string

+ func (p *PrepareHosts) Run(ctx context.Context) error

+ func (p *PrepareHosts) Title() string

+ type PrepareSelinux struct

+ func (p *PrepareSelinux) Explanation() string

+ func (p *PrepareSelinux) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *PrepareSelinux) Run(ctx context.Context) error

+ func (p *PrepareSelinux) ShouldRun() bool

+ func (p *PrepareSelinux) Title() string

+ type RPMUploadFiles struct

+ func (p *RPMUploadFiles) Explanation() string

+ func (p *RPMUploadFiles) Prepare(ctx context.Context, c *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *RPMUploadFiles) Run(ctx context.Context) (err error)

+ func (p *RPMUploadFiles) Title() string

+ type UninstallEngine struct

+ Distro distrocfg.Distro

+ WorkerConcurrent int

+ func (p *UninstallEngine) Explanation() string

+ func (p *UninstallEngine) Prepare(ctx context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *UninstallEngine) Run(ctx context.Context) error

+ func (p *UninstallEngine) Title() string

+ type Unlock struct

+ Cancel func(context.Context)

+ func (p *Unlock) Explanation() string

+ func (p *Unlock) Prepare(_ context.Context, c *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *Unlock) Run(ctx context.Context) error

+ func (p *Unlock) Title() string

+ type UpgradeController struct

+ func (p *UpgradeController) Explanation() string

+ func (p *UpgradeController) Prepare(ctx context.Context, _ *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *UpgradeController) Run(ctx context.Context) error

+ func (p *UpgradeController) Title() string

+ type UpgradeHosts struct

+ Distro distrocfg.Distro

+ func (p *UpgradeHosts) ShouldRun() bool

+ type UpgradeWorkers struct

+ WorkerConcurrent int

+ func (p *UpgradeWorkers) Explanation() string

+ func (p *UpgradeWorkers) Prepare(ctx context.Context, _ *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *UpgradeWorkers) Run(ctx context.Context) error

+ func (p *UpgradeWorkers) Title() string

+ type UploadFiles struct

+ func (p *UploadFiles) Explanation() string

+ func (p *UploadFiles) Prepare(ctx context.Context, c *cluster.ZarfCluster, d *distro.ZarfDistro) error

+ func (p *UploadFiles) Run(ctx context.Context) error

+ func (p *UploadFiles) ShouldRun() bool

+ func (p *UploadFiles) Title() string

+ type UploadFilesCommon struct

+ func (p *UploadFilesCommon) CleanUp(ctx context.Context)

+ func (p *UploadFilesCommon) Prepare(_ context.Context, _ *cluster.ZarfCluster, _ *distro.ZarfDistro) error

+ func (p *UploadFilesCommon) Run(ctx context.Context) (err error)

+ func (p *UploadFilesCommon) ShouldRun() bool

+ type ValidateHosts struct

+ func (p *ValidateHosts) Explanation() string

+ func (p *ValidateHosts) Run(ctx context.Context) error

+ func (p *ValidateHosts) Title() string