deployment

Documentation

Overview

Package deployment provides a top-level API to control Kyma deployment and uninstallation.

Package deployment provides a top-level API to control Kyma deployment and uninstallation.

Package deployment provides a top-level API to control Kyma deployment and uninstallation.

Index

• type CertificateOverrideInterceptor
  • func NewCertificateOverrideInterceptor(tlsCrtOverrideKey, tlsKeyOverrideKey string) *CertificateOverrideInterceptor
  • func (i *CertificateOverrideInterceptor) Intercept(value interface{}, key string) (interface{}, error)
  • func (i *CertificateOverrideInterceptor) String(value interface{}, key string) string
  • func (i *CertificateOverrideInterceptor) Undefined(overrides map[string]interface{}, key string) error
• type Deletion
  • func NewDeletion(cfg *config.Config, ob *OverridesBuilder, kubeClient kubernetes.Interface, ...) (*Deletion, error)
  • func (i *Deletion) StartKymaUninstallation() error
• type Deployment
  • func NewDeployment(cfg *config.Config, ob *OverridesBuilder, kubeClient kubernetes.Interface, ...) (*Deployment, error)
  • func (i *Deployment) StartKymaDeployment() error
• type DomainNameOverrideInterceptor
  • func NewDomainNameOverrideInterceptor(kubeClient kubernetes.Interface, log logger.Interface) *DomainNameOverrideInterceptor
  • func (i *DomainNameOverrideInterceptor) Intercept(value interface{}, key string) (interface{}, error)
  • func (i *DomainNameOverrideInterceptor) String(value interface{}, key string) string
  • func (i *DomainNameOverrideInterceptor) Undefined(overrides map[string]interface{}, key string) error
• type FallbackOverrideInterceptor
  • func NewFallbackOverrideInterceptor(fallback interface{}) *FallbackOverrideInterceptor
  • func (i *FallbackOverrideInterceptor) Fallback() interface{}
  • func (i *FallbackOverrideInterceptor) Intercept(value interface{}, key string) (interface{}, error)
  • func (i *FallbackOverrideInterceptor) String(value interface{}, key string) string
  • func (i *FallbackOverrideInterceptor) Undefined(overrides map[string]interface{}, key string) error
• type InstallationPhase
• type OverrideInterceptor
• type Overrides
  • func (o Overrides) Find(key string) (interface{}, bool)
  • func (o Overrides) Map() map[string]interface{}
  • func (o Overrides) String() string
• type OverridesBuilder
  • func (ob *OverridesBuilder) AddFile(file string) error
  • func (ob *OverridesBuilder) AddInterceptor(overrideKeys []string, interceptor OverrideInterceptor)
  • func (ob *OverridesBuilder) AddOverrides(chart string, overrides map[string]interface{}) error
  • func (ob *OverridesBuilder) Build() (Overrides, error)
• type ProcessEvent
• type ProcessUpdate
  • func (pu *ProcessUpdate) IsComponentUpdate() bool
  • func (pu ProcessUpdate) String() string

Types

type CertificateOverrideInterceptor

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

CertificateOverrideInterceptor handles certificates

func NewCertificateOverrideInterceptor

func NewCertificateOverrideInterceptor(tlsCrtOverrideKey, tlsKeyOverrideKey string) *CertificateOverrideInterceptor

func (*CertificateOverrideInterceptor) Intercept

func (i *CertificateOverrideInterceptor) Intercept(value interface{}, key string) (interface{}, error)

func (*CertificateOverrideInterceptor) String

func (i *CertificateOverrideInterceptor) String(value interface{}, key string) string

func (*CertificateOverrideInterceptor) Undefined

func (i *CertificateOverrideInterceptor) Undefined(overrides map[string]interface{}, key string) error

type Deletion

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

Deletion removes Kyma from a cluster

func NewDeletion

func NewDeletion(cfg *config.Config, ob *OverridesBuilder, kubeClient kubernetes.Interface, processUpdates chan<- ProcessUpdate) (*Deletion, error)

NewDeletion creates a new Deployment instance for deleting Kyma on a cluster.

func (*Deletion) StartKymaUninstallation

func (i *Deletion) StartKymaUninstallation() error

StartKymaUninstallation removes Kyma from a cluster

type Deployment

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

Deployment deploys Kyma on a cluster

func NewDeployment

func NewDeployment(cfg *config.Config, ob *OverridesBuilder, kubeClient kubernetes.Interface, processUpdates chan<- ProcessUpdate) (*Deployment, error)

NewDeployment creates a new Deployment instance for deploying Kyma on a cluster.

func (*Deployment) StartKymaDeployment

func (i *Deployment) StartKymaDeployment() error

StartKymaDeployment deploys Kyma to a cluster

type DomainNameOverrideInterceptor

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

DomainNameOverrideInterceptor resolves the domain name for the cluster

func NewDomainNameOverrideInterceptor

func NewDomainNameOverrideInterceptor(kubeClient kubernetes.Interface, log logger.Interface) *DomainNameOverrideInterceptor

func (*DomainNameOverrideInterceptor) Intercept

func (i *DomainNameOverrideInterceptor) Intercept(value interface{}, key string) (interface{}, error)

func (*DomainNameOverrideInterceptor) String

func (i *DomainNameOverrideInterceptor) String(value interface{}, key string) string

func (*DomainNameOverrideInterceptor) Undefined

func (i *DomainNameOverrideInterceptor) Undefined(overrides map[string]interface{}, key string) error

type FallbackOverrideInterceptor

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

FallbackOverrideInterceptor sets a default value for an undefined overwrite

func NewFallbackOverrideInterceptor

func NewFallbackOverrideInterceptor(fallback interface{}) *FallbackOverrideInterceptor

func (*FallbackOverrideInterceptor) Fallback

func (i *FallbackOverrideInterceptor) Fallback() interface{}

func (*FallbackOverrideInterceptor) Intercept

func (i *FallbackOverrideInterceptor) Intercept(value interface{}, key string) (interface{}, error)

func (*FallbackOverrideInterceptor) String

func (i *FallbackOverrideInterceptor) String(value interface{}, key string) string

func (*FallbackOverrideInterceptor) Undefined

func (i *FallbackOverrideInterceptor) Undefined(overrides map[string]interface{}, key string) error

type InstallationPhase

type InstallationPhase string

InstallationPhase represents the current installation phase

const (
	// InstallPreRequisites indicates the main process is installing pre-requisites
	InstallPreRequisites InstallationPhase = "InstallPreRequisites"
	// UninstallPreRequisites indicates the main process is removing pre-requisites
	UninstallPreRequisites InstallationPhase = "UninstallPreRequisites"
	// InstallComponents indicates the main process is installing components
	InstallComponents InstallationPhase = "InstallComponents"
	// UninstallComponents indicates the main process is removing components
	UninstallComponents InstallationPhase = "UninstallComponents"
)

type OverrideInterceptor

type OverrideInterceptor interface {
	//String shows the value of the override
	String(value interface{}, key string) string
	//Intercept is executed when the override is retrieved
	Intercept(value interface{}, key string) (interface{}, error)
	//Undefined is executed when the override is not defined
	Undefined(overrides map[string]interface{}, key string) error
}

OverrideInterceptor is controlling access to override values

type Overrides

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

func (Overrides) Find

func (o Overrides) Find(key string) (interface{}, bool)

Find returns a value on the overrides following a path separated by "." and if it exists.

func (Overrides) Map

func (o Overrides) Map() map[string]interface{}

Map returns a copy of the overrides in map form

func (Overrides) String

func (o Overrides) String() string

String all provided overrides

type OverridesBuilder

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

Overrides manages override merges

func (*OverridesBuilder) AddFile

func (ob *OverridesBuilder) AddFile(file string) error

AddFile adds overrides defined in a file to the builder

func (*OverridesBuilder) AddInterceptor

func (ob *OverridesBuilder) AddInterceptor(overrideKeys []string, interceptor OverrideInterceptor)

AddInterceptor registers an interceptor for a particular override keys

func (*OverridesBuilder) AddOverrides

func (ob *OverridesBuilder) AddOverrides(chart string, overrides map[string]interface{}) error

AddOverrides adds overrides for a chart to the builder

func (*OverridesBuilder) Build

func (ob *OverridesBuilder) Build() (Overrides, error)

Build an overrides object merging all provided sources

type ProcessEvent

type ProcessEvent string

ProcessEvent represents an event fired during process executing

const (
	// ProcessStart is set when main process gets started
	ProcessStart ProcessEvent = "ProcessStart"
	// ProcessRunning is indicating a running main process
	ProcessRunning ProcessEvent = "ProcessRunning"
	// ProcessFinished indicates a successfully finished main process
	ProcessFinished ProcessEvent = "ProcessFinished"
	// ProcessExecutionFailure indicates a failure during the execution (install/uninstall of a component failed)
	ProcessExecutionFailure ProcessEvent = "ProcessExecutionFailure"
	// ProcessTimeoutFailure indicates an exceeded timeout
	ProcessTimeoutFailure ProcessEvent = "ProcessTimeoutFailure"
	// ProcessForceQuitFailure indicates an cancelled main process
	ProcessForceQuitFailure ProcessEvent = "ProcessForceQuitFailure"
)

type ProcessUpdate

type ProcessUpdate struct {
	Event ProcessEvent
	Phase InstallationPhase
	Error error
	//Component is only set during the component install/uninstall phase
	Component components.KymaComponent
}

ProcessUpdate is an update of the main process

func (*ProcessUpdate) IsComponentUpdate

func (pu *ProcessUpdate) IsComponentUpdate() bool

func (ProcessUpdate) String

func (pu ProcessUpdate) String() string