oam

Documentation

Overview

Package oam contains miscellaneous OAM helper types.

Index

• Constants
• Variables
• type Conditioned
• type Finalizer
• type Object
• type Scope
• type ScopeKind
• type Trait
• type TraitKind
• type Workload
• type WorkloadKind
• type WorkloadReferencer
• type WorkloadsReferencer

Constants

const (
	// LabelAppName records the name of AppConfig
	LabelAppName = "app.oam.dev/name"
	// LabelAppRevision records the name of Application, it's equal to name of AppConfig created by Application
	LabelAppRevision = "app.oam.dev/appRevision"
	// LabelAppDeployment records the name of AppDeployment.
	LabelAppDeployment = "app.oam.dev/appDeployment"
	// LabelAppComponent records the name of Component
	LabelAppComponent = "app.oam.dev/component"
	// LabelAppComponentRevision records the revision name of Component
	LabelAppComponentRevision = "app.oam.dev/revision"
	// LabelOAMResourceType whether a CR is workload or trait
	LabelOAMResourceType = "app.oam.dev/resourceType"
	// LabelAppRevisionHash records the Hash value of the application revision
	LabelAppRevisionHash = "app.oam.dev/app-revision-hash"

	// WorkloadTypeLabel indicates the type of the workloadDefinition
	WorkloadTypeLabel = "workload.oam.dev/type"
	// TraitTypeLabel indicates the type of the traitDefinition
	TraitTypeLabel = "trait.oam.dev/type"
	// TraitResource indicates which resource it is when a trait is composed by multiple resources in KubeVela
	TraitResource = "trait.oam.dev/resource"

	// LabelComponentDefinitionName records the name of ComponentDefinition
	LabelComponentDefinitionName = "componentdefinition.oam.dev/name"
	// LabelComponentDefinitionName records the name of TraitDefinition
	LabelTraitDefinitionName = "trait.oam.dev/name"
)

Label key strings. AppConfig controller will add these labels into workloads.

const (
	// ResourceTypeTrait mark this K8s Custom Resource is an OAM trait
	ResourceTypeTrait = "TRAIT"
	// ResourceTypeWorkload mark this K8s Custom Resource is an OAM workload
	ResourceTypeWorkload = "WORKLOAD"
)

const (
	// AnnotationAppGeneration records the generation of AppConfig
	AnnotationAppGeneration = "app.oam.dev/generation"

	// AnnotationLastAppliedConfig records the previous configuration of a
	// resource for use in a three way diff during a patching apply
	AnnotationLastAppliedConfig = "app.oam.dev/last-applied-configuration"

	// AnnotationAppRollout indicates that the application is still rolling out
	// the application controller should treat it differently
	AnnotationAppRollout = "app.oam.dev/rollout-template"

	// AnnotationInplaceUpgrade indicates the workload should upgrade with the the same name
	// the name of the workload instance should not changing along with the revision
	AnnotationInplaceUpgrade = "app.oam.dev/inplace-upgrade"

	// AnnotationRollingComponent indicates that the component is rolling out
	// this is to enable any concerned controllers to handle the first component apply logic differently
	// the value of the annotation is a list of component name of all the new component
	AnnotationRollingComponent = "app.oam.dev/rolling-components"

	// AnnotationAppRevision indicates that the object is an application revision
	//	its controller should not try to reconcile it
	AnnotationAppRevision = "app.oam.dev/app-revision"

	// AnnotationAppRevisionOnly the Application update should only generate revision,
	// not any appContexts or components.
	AnnotationAppRevisionOnly = "app.oam.dev/revision-only"
)

Variables

var (
	SystemDefinitonNamespace string = "vela-system"
)

SystemDefinitonNamespace golbal value for controller and webhook systemlevel namespace

Types

type Conditioned

type Conditioned interface {
	SetConditions(c ...runtimev1alpha1.Condition)
	GetCondition(runtimev1alpha1.ConditionType) runtimev1alpha1.Condition
}

A Conditioned may have conditions set or retrieved. Conditions are typically indicate the status of both a resource and its reconciliation process.

type Finalizer

type Finalizer interface {
	AddFinalizer(ctx context.Context, obj Object) error
	RemoveFinalizer(ctx context.Context, obj Object) error
}

A Finalizer manages the finalizers on the resource.

type Object

type Object interface {
	metav1.Object
	runtime.Object
}

An Object is a Kubernetes object.

type Scope

type Scope interface {
	Object

	Conditioned
	WorkloadsReferencer
}

A Scope is a type of OAM scope.

type ScopeKind

type ScopeKind schema.GroupVersionKind

ScopeKind contains the type metadata for a kind of an OAM scope resource.

type Trait

type Trait interface {
	Object

	Conditioned
	WorkloadReferencer
}

A Trait is a type of OAM trait.

type TraitKind

type TraitKind schema.GroupVersionKind

TraitKind contains the type metadata for a kind of an OAM trait resource.

type Workload

type Workload interface {
	Object

	Conditioned
}

A Workload is a type of OAM workload.

type WorkloadKind

type WorkloadKind schema.GroupVersionKind

WorkloadKind contains the type metadata for a kind of an OAM workload resource.

type WorkloadReferencer

type WorkloadReferencer interface {
	GetWorkloadReference() runtimev1alpha1.TypedReference
	SetWorkloadReference(runtimev1alpha1.TypedReference)
}

A WorkloadReferencer may reference an OAM workload.

type WorkloadsReferencer

type WorkloadsReferencer interface {
	GetWorkloadReferences() []runtimev1alpha1.TypedReference
	AddWorkloadReference(runtimev1alpha1.TypedReference)
}

A WorkloadsReferencer may reference an OAM workload.