setup

Documentation

Index

• func NewDoguStepGenerator(client kubernetes.Interface, clusterConfig *rest.Config, dogus context.Dogus, ...) (*doguStepGenerator, error)
• func NewResourcePatchStep(phase patch.Phase, patcher resourcePatcher, patches []patch.ResourcePatch) *resourcePatchStep
• func NewValidatorStep(registry remote.Registry, setupCtx *appcontext.SetupContext) *setupValidatorStep
• func SetupAPI(ctx context.Context, router ginRoutes, clusterConfig *rest.Config, ...)
• type Executor
  • func NewExecutor(clusterConfig *rest.Config, k8sClient kubernetes.Interface, ...) (*Executor, error)
  • func (e *Executor) PerformSetup(ctx context.Context) (err error, errCausingAction string)
  • func (e *Executor) RegisterComponentSetupSteps() error
  • func (e *Executor) RegisterDataSetupSteps(etcdRegistry registry.Registry) error
  • func (e *Executor) RegisterDoguInstallationSteps() error
  • func (e *Executor) RegisterLoadBalancerFQDNRetrieverSteps() error
  • func (e *Executor) RegisterSSLGenerationStep() error
  • func (e *Executor) RegisterSetupSteps(steps ...ExecutorStep)
  • func (e *Executor) RegisterValidationStep() error
• type ExecutorStep
• type SetupExecutor
• type Starter
  • func NewStarter(ctx context.Context, clusterConfig *rest.Config, ...) (*Starter, error)
  • func (s *Starter) StartSetup(ctx context.Context) error

Functions

func NewDoguStepGenerator

func NewDoguStepGenerator(client kubernetes.Interface, clusterConfig *rest.Config, dogus context.Dogus, registry remote.Registry, namespace string) (*doguStepGenerator, error)

NewDoguStepGenerator creates a new generator capable of generating dogu installation steps.

func NewResourcePatchStep

func NewResourcePatchStep(phase patch.Phase, patcher resourcePatcher, patches []patch.ResourcePatch) *resourcePatchStep

NewResourcePatchStep creates a new setup step which patches arbitrary Kubernetes resources according the given setup phase.

func NewValidatorStep

func NewValidatorStep(registry remote.Registry, setupCtx *appcontext.SetupContext) *setupValidatorStep

NewValidatorStep creates a new setup step to validate the setup configuration.

func SetupAPI

func SetupAPI(ctx context.Context, router ginRoutes, clusterConfig *rest.Config, k8sClient kubernetes.Interface, setupContextBuilder *appcontext.SetupContextBuilder)

SetupAPI setups the REST API for configuration information

Types

type Executor

type Executor struct {
	// SetupContext contains information about the current context.
	SetupContext *appcontext.SetupContext
	// ClientSet is the actual k8s client responsible for the k8s API communication.
	ClientSet kubernetes.Interface
	// ClusterConfig is the current rest config used to create a kubernetes clients.
	ClusterConfig *rest.Config
	// Steps contains all necessary steps for the setup
	Steps []ExecutorStep
	// Registry is the dogu registry
	Registry remote.Registry
}

Executor is responsible to perform the actual steps of the setup.

func NewExecutor

func NewExecutor(clusterConfig *rest.Config, k8sClient kubernetes.Interface, setupCtx *appcontext.SetupContext) (*Executor, error)

NewExecutor creates a new setup executor with the given app configuration.

func (*Executor) PerformSetup

func (e *Executor) PerformSetup(ctx context.Context) (err error, errCausingAction string)

PerformSetup starts the setup and executes all registered setup steps

func (*Executor) RegisterComponentSetupSteps

func (e *Executor) RegisterComponentSetupSteps() error

RegisterComponentSetupSteps adds all setup steps responsible to install vital components into the ecosystem.

func (*Executor) RegisterDataSetupSteps

func (e *Executor) RegisterDataSetupSteps(etcdRegistry registry.Registry) error

RegisterDataSetupSteps adds all setup steps responsible to read, write, or verify data needed by the setup.

func (*Executor) RegisterDoguInstallationSteps

func (e *Executor) RegisterDoguInstallationSteps() error

RegisterDoguInstallationSteps creates install steps for the dogu install list

func (*Executor) RegisterLoadBalancerFQDNRetrieverSteps

func (e *Executor) RegisterLoadBalancerFQDNRetrieverSteps() error

RegisterLoadBalancerFQDNRetrieverSteps registers the steps for creating a loadbalancer retrieving the fqdn

func (*Executor) RegisterSSLGenerationStep

func (e *Executor) RegisterSSLGenerationStep() error

RegisterSSLGenerationStep registers all ssl steps

func (*Executor) RegisterSetupSteps

func (e *Executor) RegisterSetupSteps(steps ...ExecutorStep)

RegisterSetupSteps adds a new step to the setup

func (*Executor) RegisterValidationStep

func (e *Executor) RegisterValidationStep() error

RegisterValidationStep registers all validation steps

type ExecutorStep

type ExecutorStep interface {
	// GetStepDescription returns the description of the setup step. The Executor prints the description of every step
	// when executing the setup.
	GetStepDescription() string
	// PerformSetupStep is called for every registered step when executing the setup.
	PerformSetupStep(ctx context.Context) error
}

ExecutorStep describes a valid step in the setup.

type SetupExecutor

type SetupExecutor interface {
	// RegisterLoadBalancerFQDNRetrieverSteps registers the FQDN retriever step
	RegisterLoadBalancerFQDNRetrieverSteps() error
	// RegisterSSLGenerationStep registers all ssl steps
	RegisterSSLGenerationStep() error
	// RegisterValidationStep registers all validation steps
	RegisterValidationStep() error
	// RegisterComponentSetupSteps adds all setup steps responsible to install vital components into the ecosystem.
	RegisterComponentSetupSteps() error
	// RegisterDataSetupSteps adds all setup steps responsible to read, write, or verify data needed by the setup.
	RegisterDataSetupSteps(registry.Registry) error
	// RegisterDoguInstallationSteps creates install steps for the dogu install list
	RegisterDoguInstallationSteps() error
	// PerformSetup starts the setup and executes all registered setup steps
	PerformSetup(ctx context.Context) (error, string)
}

SetupExecutor is uses to register all necessary steps and executes them

type Starter

type Starter struct {
	EtcdRegistry  registry.Registry
	ClientSet     kubernetes.Interface
	ClusterConfig *rest.Config
	SetupContext  *appcontext.SetupContext
	Namespace     string
	SetupExecutor SetupExecutor
}

Starter is used to init and start the setup process

func NewStarter

func NewStarter(ctx context.Context, clusterConfig *rest.Config, k8sClient kubernetes.Interface, setupContextBuilder *appcontext.SetupContextBuilder) (*Starter, error)

NewStarter creates a new setup starter struct which one inits registries and starts the setup process

func (*Starter) StartSetup

func (s *Starter) StartSetup(ctx context.Context) error

StartSetup creates necessary k8s config and client, register steps and executes them