deploy

Documentation

Index

• type CmdRunResultBuffer
  • func NewCmdRunResultBuffer() *CmdRunResultBuffer
  • func (w *CmdRunResultBuffer) Copy() exec.CmdRunResult
  • func (w *CmdRunResultBuffer) WriteStderr(data []byte) (int, error)
  • func (w *CmdRunResultBuffer) WriteStdout(data []byte) (int, error)
• type Deploy
• type Factory
  • func NewFactory(coreClient kubernetes.Interface, kubeconfig *kubeconfig.Kubeconfig, ...) Factory
  • func (f Factory) NewKapp(opts v1alpha1.AppDeployKapp, saName string, clusterOpts *v1alpha1.AppCluster, ...) (*Kapp, error)
  • func (f Factory) NewKappPrivilegedForPackageRepository(opts v1alpha1.AppDeployKapp, clusterAccess kubeconfig.AccessInfo, ...) (*Kapp, error)
• type Kapp
  • func NewKapp(appSuffix string, opts v1alpha1.AppDeployKapp, ...) *Kapp
  • func (a *Kapp) Delete(startedApplyingFunc func(), changedFunc func(exec.CmdRunResult)) exec.CmdRunResult
  • func (a *Kapp) Deploy(tplOutput string, startedApplyingFunc func(), ...) exec.CmdRunResult
  • func (a *Kapp) Inspect() exec.CmdRunResult
  • func (a *Kapp) InternalAppMeta() (*Meta, error)
• type KappConfiguration
• type Meta
• type WriterFunc
  • func (f WriterFunc) Write(data []byte) (int, error)

Types

type CmdRunResultBuffer

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

func NewCmdRunResultBuffer

func NewCmdRunResultBuffer() *CmdRunResultBuffer

func (*CmdRunResultBuffer) Copy

func (w *CmdRunResultBuffer) Copy() exec.CmdRunResult

func (*CmdRunResultBuffer) WriteStderr

func (w *CmdRunResultBuffer) WriteStderr(data []byte) (int, error)

func (*CmdRunResultBuffer) WriteStdout

func (w *CmdRunResultBuffer) WriteStdout(data []byte) (int, error)

type Deploy

type Deploy interface {
	Deploy(tplOutput string, startedApplyingFunc func(),
		changedFunc func(exec.CmdRunResult)) exec.CmdRunResult

	Delete(startedApplyingFunc func(),
		changedFunc func(exec.CmdRunResult)) exec.CmdRunResult

	Inspect() exec.CmdRunResult
}

type Factory

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

Factory allows to build various deployers. kapp deployer is standard, kapp privileged deployer should only be used for PackageRepository reconciliation.

func NewFactory

func NewFactory(coreClient kubernetes.Interface, kubeconfig *kubeconfig.Kubeconfig,
	kappConfig KappConfiguration, cmdRunner exec.CmdRunner, _ logr.Logger) Factory

NewFactory returns deploy factory.

func (Factory) NewKapp

func (f Factory) NewKapp(opts v1alpha1.AppDeployKapp, saName string,
	clusterOpts *v1alpha1.AppCluster, cancelCh chan struct{}, location kubeconfig.AccessLocation,
	defaultNamespace string, appNamespace string) (*Kapp, error)

NewKapp configures and returns a deployer of type Kapp

func (Factory) NewKappPrivilegedForPackageRepository

func (f Factory) NewKappPrivilegedForPackageRepository(opts v1alpha1.AppDeployKapp, clusterAccess kubeconfig.AccessInfo, cancelCh chan struct{}, appNamespace string) (*Kapp, error)

NewKappPrivileged is used for package repositories where users aren't required to provide a service account, so it will install resources using its own privileges.

type Kapp

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

func NewKapp

func NewKapp(appSuffix string, opts v1alpha1.AppDeployKapp, clusterAccess kubeconfig.AccessInfo,
	globalDeployRawOpts []string, cancelCh chan struct{}, cmdRunner exec.CmdRunner, appNamespace string) *Kapp

NewKapp takes the kapp yaml from spec.deploy.kapp as arg kapp, additional info from the larger app resource (e.g. service account, name, namespace) as genericOpts, and a cancel channel that gets passed through to the exec call that runs kapp.

func (*Kapp) Delete

func (a *Kapp) Delete(startedApplyingFunc func(), changedFunc func(exec.CmdRunResult)) exec.CmdRunResult

Delete takes the app name, it shells out, running kapp delete ...

func (*Kapp) Deploy

func (a *Kapp) Deploy(tplOutput string, startedApplyingFunc func(),
	changedFunc func(exec.CmdRunResult)) exec.CmdRunResult

Deploy takes the output from templating, and the app name, it shells out, running kapp deploy ...

func (*Kapp) Inspect

func (a *Kapp) Inspect() exec.CmdRunResult

Inspect takes the app name, it shells out, running kapp inspect ...

func (*Kapp) InternalAppMeta

func (a *Kapp) InternalAppMeta() (*Meta, error)

InternalAppMeta exposes the internal configmap kapp maintains on every app deploy

type KappConfiguration

type KappConfiguration interface {
	KappDeployRawOptions() []string
}

KappConfiguration provides a way to inject shared kapp settings.

type Meta

type Meta struct {
	LabelKey   string `yaml:"labelKey"`
	LabelValue string `yaml:"labelValue"`
	LastChange struct {
		Namespaces []string `yaml:"namespaces"`
	} `yaml:"lastChange"`
	UsedGKs []struct {
		Group string `yaml:"Group"`
		Kind  string `yaml:"Kind"`
	} `yaml:"usedGKs"`
}

Meta contains app meta allowing for an AppCR to surface the associated namespaces and GKs

type WriterFunc

type WriterFunc func([]byte) (int, error)

func (WriterFunc) Write

func (f WriterFunc) Write(data []byte) (int, error)