app

Documentation

Index

• type App
  • func NewApp(app v1alpha1.App, hooks Hooks, fetchFactory fetch.Factory, ...) *App
  • func (a *App) ConfigMapRefs() map[reftracker.RefKey]struct{}
  • func (a App) HasImageOrImgpkgBundle() bool
  • func (a *App) Name() string
  • func (a *App) Namespace() string
  • func (a *App) Reconcile(force bool) (reconcile.Result, error)
  • func (a *App) SecretRefs() map[reftracker.RefKey]struct{}
  • func (a *App) Status() v1alpha1.AppStatus
  • func (a *App) StatusAsYAMLBytes() ([]byte, error)
• type CRDApp
  • func NewCRDApp(appModel *kcv1alpha1.App, log logr.Logger, appMetrics *metrics.AppMetrics, ...) *CRDApp
  • func (a *CRDApp) Reconcile(force bool) (reconcile.Result, error)
  • func (a *CRDApp) ResourceRefs() map[reftracker.RefKey]struct{}
• type CRDAppFactory
  • func (f *CRDAppFactory) NewCRDApp(app *kcv1alpha1.App, log logr.Logger) *CRDApp
• type CRDAppWatcher
  • func NewCRDAppWatcher(app v1alpha1.App, appClient kcclient.Interface) CRDAppWatcher
  • func (w CRDAppWatcher) Watch(callback func(v1alpha1.App), cancelCh chan struct{}) error
• type Hooks
• type ReconcileTimer
  • func NewReconcileTimer(app v1alpha1.App) ReconcileTimer
  • func (rt ReconcileTimer) DurationUntilReady(err error) time.Duration
  • func (rt ReconcileTimer) IsReadyAt(timeAt time.Time) bool
• type Reconciler
  • func NewReconciler(appClient kcclient.Interface, log logr.Logger, crdAppFactory CRDAppFactory, ...) *Reconciler
  • func (r *Reconciler) AppRefTracker() *reftracker.AppRefTracker
  • func (r *Reconciler) AttachWatches(controller controller.Controller) error
  • func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error)
  • func (r *Reconciler) UpdateAppRefs(refKeys map[reftracker.RefKey]struct{}, app *v1alpha1.App)

Types

type App

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

func NewApp

func NewApp(app v1alpha1.App, hooks Hooks,
	fetchFactory fetch.Factory, templateFactory template.Factory,
	deployFactory deploy.Factory, log logr.Logger, appMetrics *metrics.AppMetrics) *App

func (*App) ConfigMapRefs

func (a *App) ConfigMapRefs() map[reftracker.RefKey]struct{}

Get all ConfigMapRefs from App spec

func (App) HasImageOrImgpkgBundle

func (a App) HasImageOrImgpkgBundle() bool

HasImageOrImgpkgBundle is used to determine if the App's spec contains a fetch stage for an image or imgpkgbundle. It is mainly used to determine whether to retry a fetch attempt when placeholder secrets are involved with authenticating to private registries. Placeholder secrets are not always populated quick enough for Apps to use the secret, and private auth is only supported for images/bundles, so this helps to narrow down when to retry a fetch attempt.

func (*App) Name

func (a *App) Name() string

func (*App) Namespace

func (a *App) Namespace() string

func (*App) Reconcile

func (a *App) Reconcile(force bool) (reconcile.Result, error)

Reconcile is not expected to be called concurrently

func (*App) SecretRefs

func (a *App) SecretRefs() map[reftracker.RefKey]struct{}

Get all SecretRefs from App spec

func (*App) Status

func (a *App) Status() v1alpha1.AppStatus

func (*App) StatusAsYAMLBytes

func (a *App) StatusAsYAMLBytes() ([]byte, error)

type CRDApp

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

func NewCRDApp

func NewCRDApp(appModel *kcv1alpha1.App, log logr.Logger, appMetrics *metrics.AppMetrics,
	appClient kcclient.Interface, fetchFactory fetch.Factory,
	templateFactory template.Factory, deployFactory deploy.Factory) *CRDApp

NewCRDApp creates new CRD app

func (*CRDApp) Reconcile

func (a *CRDApp) Reconcile(force bool) (reconcile.Result, error)

func (*CRDApp) ResourceRefs

func (a *CRDApp) ResourceRefs() map[reftracker.RefKey]struct{}

Get both secret refs/configmap refs as single map with all ref entries.

type CRDAppFactory

type CRDAppFactory struct {
	CoreClient kubernetes.Interface
	AppClient  kcclient.Interface
	KcConfig   *config.Config
	AppMetrics *metrics.AppMetrics
}

CRDAppFactory allows to create CRDApps.

func (*CRDAppFactory) NewCRDApp

func (f *CRDAppFactory) NewCRDApp(app *kcv1alpha1.App, log logr.Logger) *CRDApp

NewCRDApp creates a CRDApp injecting necessary dependencies.

type CRDAppWatcher

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

func NewCRDAppWatcher

func NewCRDAppWatcher(app v1alpha1.App, appClient kcclient.Interface) CRDAppWatcher

func (CRDAppWatcher) Watch

func (w CRDAppWatcher) Watch(callback func(v1alpha1.App), cancelCh chan struct{}) error

type Hooks

type Hooks struct {
	BlockDeletion   func() error
	UnblockDeletion func() error
	UpdateStatus    func(string) error
	WatchChanges    func(func(v1alpha1.App), chan struct{}) error
}

type ReconcileTimer

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

func NewReconcileTimer

func NewReconcileTimer(app v1alpha1.App) ReconcileTimer

func (ReconcileTimer) DurationUntilReady

func (rt ReconcileTimer) DurationUntilReady(err error) time.Duration

func (ReconcileTimer) IsReadyAt

func (rt ReconcileTimer) IsReadyAt(timeAt time.Time) bool

type Reconciler

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

Reconciler is responsible for reconciling Apps.

func NewReconciler

func NewReconciler(appClient kcclient.Interface, log logr.Logger, crdAppFactory CRDAppFactory,
	appRefTracker *reftracker.AppRefTracker, appUpdateStatus *reftracker.AppUpdateStatus) *Reconciler

NewReconciler constructs new Reconciler.

func (*Reconciler) AppRefTracker

func (r *Reconciler) AppRefTracker() *reftracker.AppRefTracker

nolint: revive TODO should be removed since AppRefTracker is passed into this object

func (*Reconciler) AttachWatches

func (r *Reconciler) AttachWatches(controller controller.Controller) error

AttachWatches configures watches needed for reconciler to reconcile Apps.

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error)

nolint: revive

func (*Reconciler) UpdateAppRefs

func (r *Reconciler) UpdateAppRefs(refKeys map[reftracker.RefKey]struct{}, app *v1alpha1.App)

nolint: revive TODO should be made private