application

Documentation

Index

• Constants
• Variables
• func ComputeAppRevisionHash(appRevision *v1beta1.ApplicationRevision) (string, error)
• func ComputeComponentRevisionHash(comp *types.ComponentManifest) (string, error)
• func DeepEqualRevision(old, new *v1beta1.ApplicationRevision) bool
• func Setup(mgr ctrl.Manager, args core.Args) error
• func SprintComponentManifest(cm *types.ComponentManifest) string
• type AppHandler
  • func NewAppHandler(ctx context.Context, r *Reconciler, app *v1beta1.Application, ...) (*AppHandler, error)
  • func (h *AppHandler) Delete(ctx context.Context, cluster string, owner common.ResourceCreatorRole, ...) error
  • func (h *AppHandler) Dispatch(ctx context.Context, cluster string, owner common.ResourceCreatorRole, ...) error
  • func (h *AppHandler) FinalizeAndApplyAppRevision(ctx context.Context) error
  • func (h *AppHandler) GenerateApplicationSteps(ctx context.Context, app *v1beta1.Application, appParser *appfile.Parser, ...) ([]wfTypes.TaskRunner, error)
  • func (h *AppHandler) HandleComponentsRevision(ctx context.Context, compManifests []*types.ComponentManifest) error
  • func (h *AppHandler) PrepareCurrentAppRevision(ctx context.Context, af *appfile.Appfile) error
  • func (h *AppHandler) ProduceArtifacts(ctx context.Context, comps []*types.ComponentManifest, ...) error
  • func (h *AppHandler) UpdateAppLatestRevisionStatus(ctx context.Context) error
• type Reconciler
  • func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error

Constants

const (
	// ConfigMapKeyComponents is the key in ConfigMap Data field for containing data of components
	ConfigMapKeyComponents = "components"
	// ConfigMapKeyPolicy is the key in ConfigMap Data field for containing data of policies
	ConfigMapKeyPolicy = "policies"
	// ManifestKeyWorkload is the key in Component Manifest for containing workload cr.
	ManifestKeyWorkload = "StandardWorkload"
	// ManifestKeyTraits is the key in Component Manifest for containing Trait cr.
	ManifestKeyTraits = "Traits"
	// ManifestKeyScopes is the key in Component Manifest for containing scope cr reference.
	ManifestKeyScopes = "Scopes"
	// ComponentRevisionNamespaceContextKey is the key in context that defines the override namespace of component revision
	ComponentRevisionNamespaceContextKey = contextKey("component-revision-namespace")
)

Variables

var (
	// EnableReconcileLoopReduction optimize application reconcile loop by fusing phase transition
	EnableReconcileLoopReduction = false
	// EnableResourceTrackerDeleteOnlyTrigger optimize ResourceTracker mutate event trigger by only receiving deleting events
	EnableResourceTrackerDeleteOnlyTrigger = true
)

var (
	// DisableAllComponentRevision disable component revision creation
	DisableAllComponentRevision = false
	// DisableAllApplicationRevision disable application revision creation
	DisableAllApplicationRevision = false
)

var (
	// DisableResourceApplyDoubleCheck optimize applyComponentFunc by disable post resource existing check after dispatch
	DisableResourceApplyDoubleCheck = false
)

Functions

func ComputeAppRevisionHash

func ComputeAppRevisionHash(appRevision *v1beta1.ApplicationRevision) (string, error)

ComputeAppRevisionHash computes a single hash value for an appRevision object Spec of Application/WorkloadDefinitions/ComponentDefinitions/TraitDefinitions/ScopeDefinitions will be taken into compute

func ComputeComponentRevisionHash

func ComputeComponentRevisionHash(comp *types.ComponentManifest) (string, error)

ComputeComponentRevisionHash to compute component hash

func DeepEqualRevision

func DeepEqualRevision(old, new *v1beta1.ApplicationRevision) bool

DeepEqualRevision will compare the spec of Application and Definition to see if the Application is the same revision Spec of AC and Component will not be compared as they are generated by the application and definitions Note the Spec compare can only work when the RawExtension are decoded well in the RawExtension.Object instead of in RawExtension.Raw(bytes)

func Setup

func Setup(mgr ctrl.Manager, args core.Args) error

Setup adds a controller that reconciles AppRollout.

func SprintComponentManifest

func SprintComponentManifest(cm *types.ComponentManifest) string

SprintComponentManifest formats and returns the resulting string.

Types

type AppHandler

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

AppHandler handles application reconcile

func NewAppHandler

func NewAppHandler(ctx context.Context, r *Reconciler, app *v1beta1.Application, parser *appfile.Parser) (*AppHandler, error)

NewAppHandler create new app handler

func (*AppHandler) Delete

func (h *AppHandler) Delete(ctx context.Context, cluster string, owner common.ResourceCreatorRole, manifest *unstructured.Unstructured) error

Delete delete manifests from k8s.

func (*AppHandler) Dispatch

func (h *AppHandler) Dispatch(ctx context.Context, cluster string, owner common.ResourceCreatorRole, manifests ...*unstructured.Unstructured) error

Dispatch apply manifests into k8s.

func (*AppHandler) FinalizeAndApplyAppRevision

func (h *AppHandler) FinalizeAndApplyAppRevision(ctx context.Context) error

FinalizeAndApplyAppRevision finalise AppRevision object and apply it

func (*AppHandler) GenerateApplicationSteps

func (h *AppHandler) GenerateApplicationSteps(ctx context.Context,
	app *v1beta1.Application,
	appParser *appfile.Parser,
	af *appfile.Appfile,
	appRev *v1beta1.ApplicationRevision) ([]wfTypes.TaskRunner, error)

GenerateApplicationSteps generate application steps. nolint:gocyclo

func (*AppHandler) HandleComponentsRevision

func (h *AppHandler) HandleComponentsRevision(ctx context.Context, compManifests []*types.ComponentManifest) error

HandleComponentsRevision manages Component revisions 1. if update component create a new component Revision 2. check all componentTrait rely on componentRevName, if yes fill it

func (*AppHandler) PrepareCurrentAppRevision

func (h *AppHandler) PrepareCurrentAppRevision(ctx context.Context, af *appfile.Appfile) error

PrepareCurrentAppRevision will generate a pure revision without metadata and rendered result the generated revision will be compare with the last revision to see if there's any difference.

func (*AppHandler) ProduceArtifacts

func (h *AppHandler) ProduceArtifacts(ctx context.Context, comps []*types.ComponentManifest, policies []*unstructured.Unstructured) error

ProduceArtifacts will produce Application artifacts that will be saved in configMap.

func (*AppHandler) UpdateAppLatestRevisionStatus

func (h *AppHandler) UpdateAppLatestRevisionStatus(ctx context.Context) error

UpdateAppLatestRevisionStatus only call to update app's latest revision status after applying manifests successfully otherwise it will override previous revision which is used during applying to do GC jobs

type Reconciler

type Reconciler struct {
	client.Client

	Scheme   *runtime.Scheme
	Recorder event.Recorder
	// contains filtered or unexported fields
}

Reconciler reconciles an Application object

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

Reconcile process app event nolint:gocyclo

func (*Reconciler) SetupWithManager

func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager install to manager