executors

Documentation

Index

• Constants
• func NewBaremetalExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)
• func NewClusterctlExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)
• func NewContainerExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)
• func NewEphemeralExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)
• func NewKubeApplierExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)
• func RegisterExecutor(executorName string, registry map[schema.GroupVersionKind]ifc.ExecutorFactory) error
• type BaremetalManagerExecutor
  • func (e *BaremetalManagerExecutor) Render(w io.Writer, _ ifc.RenderOptions) error
  • func (e *BaremetalManagerExecutor) Run(opts ifc.RunOptions) error
  • func (e *BaremetalManagerExecutor) Status() (ifc.ExecutorStatus, error)
  • func (e *BaremetalManagerExecutor) Validate() error
• type ClusterctlExecutor
  • func (c *ClusterctlExecutor) Render(w io.Writer, ro ifc.RenderOptions) error
  • func (c *ClusterctlExecutor) Run(opts ifc.RunOptions) error
  • func (c *ClusterctlExecutor) Status() (ifc.ExecutorStatus, error)
  • func (c *ClusterctlExecutor) Validate() error
• type ContainerExecutor
  • func (c *ContainerExecutor) Render(w io.Writer, o ifc.RenderOptions) error
  • func (c *ContainerExecutor) Run(opts ifc.RunOptions) error
  • func (c *ContainerExecutor) SetKubeConfig() (kubeconfig.Cleanup, error)
  • func (c *ContainerExecutor) Status() (ifc.ExecutorStatus, error)
  • func (c *ContainerExecutor) Validate() error
• type EphemeralExecutor
  • func (c *EphemeralExecutor) Render(w io.Writer, _ ifc.RenderOptions) error
  • func (c *EphemeralExecutor) Run(opts ifc.RunOptions) error
  • func (c *EphemeralExecutor) Status() (ifc.ExecutorStatus, error)
  • func (c *EphemeralExecutor) Validate() error
• type KubeApplierExecutor
  • func (e *KubeApplierExecutor) Render(w io.Writer, o ifc.RenderOptions) error
  • func (e *KubeApplierExecutor) Run(runOpts ifc.RunOptions) error
  • func (e *KubeApplierExecutor) Status() (ifc.ExecutorStatus, error)
  • func (e *KubeApplierExecutor) Validate() error

Constants

const (
	Clusterctl       = "clusterctl"
	KubernetesApply  = "kubernetes-apply"
	GenericContainer = "generic-container"
	Ephemeral        = "ephemeral"
	BMHManager       = "BaremetalManager"
)

Constants related to phase executor names

Functions

func NewBaremetalExecutor

func NewBaremetalExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)

NewBaremetalExecutor constructor for baremetal executor

func NewClusterctlExecutor

func NewClusterctlExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)

NewClusterctlExecutor creates instance of 'clusterctl' phase executor

func NewContainerExecutor

func NewContainerExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)

NewContainerExecutor creates instance of phase executor

func NewEphemeralExecutor

func NewEphemeralExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)

NewEphemeralExecutor creates instance of phase executor

func NewKubeApplierExecutor

func NewKubeApplierExecutor(cfg ifc.ExecutorConfig) (ifc.Executor, error)

NewKubeApplierExecutor returns instance of executor

func RegisterExecutor

func RegisterExecutor(executorName string, registry map[schema.GroupVersionKind]ifc.ExecutorFactory) error

RegisterExecutor adds executor to phase executor registry

Types

type BaremetalManagerExecutor

type BaremetalManagerExecutor struct {
	// contains filtered or unexported fields
}

BaremetalManagerExecutor is abstraction built on top of baremetal commands of airshipctl

func (*BaremetalManagerExecutor) Render

func (e *BaremetalManagerExecutor) Render(w io.Writer, _ ifc.RenderOptions) error

Render baremetal hosts

func (*BaremetalManagerExecutor) Run

func (e *BaremetalManagerExecutor) Run(opts ifc.RunOptions) error

Run runs baremetal operations as executor

func (*BaremetalManagerExecutor) Status

func (e *BaremetalManagerExecutor) Status() (ifc.ExecutorStatus, error)

Status returns the status of the given phase

func (*BaremetalManagerExecutor) Validate

func (e *BaremetalManagerExecutor) Validate() error

Validate executor configuration and documents

type ClusterctlExecutor

type ClusterctlExecutor struct {
	// contains filtered or unexported fields
}

ClusterctlExecutor phase executor

func (*ClusterctlExecutor) Render

func (c *ClusterctlExecutor) Render(w io.Writer, ro ifc.RenderOptions) error

Render executor documents

func (*ClusterctlExecutor) Run

func (c *ClusterctlExecutor) Run(opts ifc.RunOptions) error

Run clusterctl init as a phase runner

func (*ClusterctlExecutor) Status

func (c *ClusterctlExecutor) Status() (ifc.ExecutorStatus, error)

Status returns the status of the given phase

func (*ClusterctlExecutor) Validate

func (c *ClusterctlExecutor) Validate() error

Validate executor configuration and documents

type ContainerExecutor

type ContainerExecutor struct {
	ResultsDir    string
	MountBasePath string

	Container        *v1alpha1.GenericContainer
	ClientFunc       container.ClientV1Alpha1FactoryFunc
	ExecutorBundle   document.Bundle
	ExecutorDocument document.Document
	Options          ifc.ExecutorConfig
}

ContainerExecutor contains resources for generic container executor

func (*ContainerExecutor) Render

func (c *ContainerExecutor) Render(w io.Writer, o ifc.RenderOptions) error

Render executor documents

func (*ContainerExecutor) Run

func (c *ContainerExecutor) Run(opts ifc.RunOptions) error

Run generic container as a phase runner

func (*ContainerExecutor) SetKubeConfig

func (c *ContainerExecutor) SetKubeConfig() (kubeconfig.Cleanup, error)

SetKubeConfig adds env variable and mounts kubeconfig to container

func (*ContainerExecutor) Status

func (c *ContainerExecutor) Status() (ifc.ExecutorStatus, error)

Status returns the status of the given phase

func (*ContainerExecutor) Validate

func (c *ContainerExecutor) Validate() error

Validate executor configuration and documents

type EphemeralExecutor

type EphemeralExecutor struct {
	ExecutorBundle   document.Bundle
	ExecutorDocument document.Document

	BootConf  *v1alpha1.BootConfiguration
	Container container.Container
}

EphemeralExecutor contains resources for ephemeral executor

func (*EphemeralExecutor) Render

func (c *EphemeralExecutor) Render(w io.Writer, _ ifc.RenderOptions) error

Render executor documents

func (*EphemeralExecutor) Run

func (c *EphemeralExecutor) Run(opts ifc.RunOptions) error

Run ephemeral as a phase runner

func (*EphemeralExecutor) Status

func (c *EphemeralExecutor) Status() (ifc.ExecutorStatus, error)

Status returns the status of the given phase

func (*EphemeralExecutor) Validate

func (c *EphemeralExecutor) Validate() error

Validate executor configuration and documents

type KubeApplierExecutor

type KubeApplierExecutor struct {
	ExecutorBundle   document.Bundle
	ExecutorDocument document.Document
	BundleName       string
	// contains filtered or unexported fields
}

KubeApplierExecutor applies resources to kubernetes

func (*KubeApplierExecutor) Render

func (e *KubeApplierExecutor) Render(w io.Writer, o ifc.RenderOptions) error

Render document set

func (*KubeApplierExecutor) Run

func (e *KubeApplierExecutor) Run(runOpts ifc.RunOptions) error

Run executor, should be performed in separate go routine

func (*KubeApplierExecutor) Status

func (e *KubeApplierExecutor) Status() (ifc.ExecutorStatus, error)

Status returns the status of the given phase

func (*KubeApplierExecutor) Validate

func (e *KubeApplierExecutor) Validate() error

Validate document set