pkgrepository

Documentation

Index

• func FilterResources(inputYAML string) (string, error)
• func NewPackageRepoApp(pkgRepository *pkgingv1alpha1.PackageRepository) (*kcv1alpha1.App, error)
• type App
  • func NewApp(app v1alpha1.App, hooks Hooks, fetchFactory fetch.Factory, ...) *App
  • 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
• type AppFactory
  • func (f *AppFactory) NewCRDPackageRepo(app *kcv1alpha1.App, pkgr *pkgv1alpha1.PackageRepository, log logr.Logger) *CRDApp
• type CRDApp
  • func NewCRDApp(appModel *kcv1alpha1.App, packageRepo *pkgingv1alpha1.PackageRepository, ...) *CRDApp
  • func (a *CRDApp) Reconcile(force bool) (reconcile.Result, error)
  • func (a *CRDApp) ResourceRefs() map[reftracker.RefKey]struct{}
• 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, coreClient kubernetes.Interface, log logr.Logger, ...) *Reconciler
  • func (r *Reconciler) AttachWatches(controller controller.Controller) error
  • func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (reconcile.Result, error)
  • func (r *Reconciler) ReconcileFetchPlaceholderSecrets(pkgr pkgv1alpha1.PackageRepository, app *v1alpha1.App) error
  • func (r *Reconciler) UpdatePackageRepoRefs(refKeys map[reftracker.RefKey]struct{}, app *v1alpha1.App)

Functions

func FilterResources

func FilterResources(inputYAML string) (string, error)

FilterResources takes a multi-doc yaml of the templated contents of a PKGR, and filters out unexpected fields on each resource by deserializing and re-serializing. This filtering step allows us to use newer CRDs (with new fields) in older versions of kc without triggering a mistmatch in the rebase "is_identical" checker.

func NewPackageRepoApp

func NewPackageRepoApp(pkgRepository *pkgingv1alpha1.PackageRepository) (*kcv1alpha1.App, error)

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) *App

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{}

func (*App) Status

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

type AppFactory

type AppFactory struct {
	CoreClient kubernetes.Interface
	AppClient  kcclient.Interface
	KcConfig   *config.Config
}

AppFactory allows to create "hidden" Apps for reconciling PackageRepositories.

func (*AppFactory) NewCRDPackageRepo

func (f *AppFactory) NewCRDPackageRepo(app *kcv1alpha1.App, pkgr *pkgv1alpha1.PackageRepository, log logr.Logger) *CRDApp

NewCRDPackageRepo constructs "hidden" App to reconcile PackageRepository.

type CRDApp

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

func NewCRDApp

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

func (*CRDApp) Reconcile

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

func (*CRDApp) ResourceRefs

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

type Hooks

type Hooks struct {
	BlockDeletion   func() error
	UnblockDeletion func() error
	UpdateStatus    func(string) 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 PackageRepositories.

func NewReconciler

func NewReconciler(appClient kcclient.Interface, coreClient kubernetes.Interface,
	log logr.Logger, appFactory AppFactory, appRefTracker *reftracker.AppRefTracker,
	appUpdateStatus *reftracker.AppUpdateStatus) *Reconciler

NewReconciler is the constructor for the Reconciler struct

func (*Reconciler) AttachWatches

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

AttachWatches configures watches needed for reconciler to reconcile PackageRepository.

func (*Reconciler) Reconcile

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

Reconcile ensures that Packages/PackageMetadatas are imported into the cluster from given PackageRepository.

func (*Reconciler) ReconcileFetchPlaceholderSecrets

func (r *Reconciler) ReconcileFetchPlaceholderSecrets(pkgr pkgv1alpha1.PackageRepository, app *v1alpha1.App) error

ReconcileFetchPlaceholderSecrets helps determine if a placeholder secret needs to be created for the PackageRepository. This placeholder secret is populated by secretgen-controller so PackageRepositories can authenticate to private registries without needing to explicitly declare a secretRef. If no secretRef is specified for the PackageRepository, the placeholder is created and used by the PackageRepository.

func (*Reconciler) UpdatePackageRepoRefs

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

nolint: revive