Documentation
¶
Overview ¶
Package oam contains miscellaneous OAM helper types.
Index ¶
Constants ¶
const (
// LabelAppName records the name of AppConfig
LabelAppName = "app.oam.dev/name"
// 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"
// WorkloadTypeLabel indicates the type of the workloadDefinition
WorkloadTypeLabel = "workload.oam.dev/type"
// TraitTypeLabel indicates the type of the traitDefinition
TraitTypeLabel = "trait.oam.dev/type"
)
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"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Conditioned ¶ added in v0.2.0
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 ¶ added in v0.2.0
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 ¶ added in v0.2.0
type Object interface {
metav1.Object
runtime.Object
}
An Object is a Kubernetes object.
type Scope ¶ added in v0.2.0
type Scope interface {
Object
Conditioned
WorkloadsReferencer
}
A Scope is a type of OAM scope.
type ScopeKind ¶ added in v0.2.0
type ScopeKind schema.GroupVersionKind
ScopeKind contains the type metadata for a kind of an OAM scope resource.
type Trait ¶ added in v0.2.0
type Trait interface {
Object
Conditioned
WorkloadReferencer
}
A Trait is a type of OAM trait.
type TraitKind ¶ added in v0.2.0
type TraitKind schema.GroupVersionKind
TraitKind contains the type metadata for a kind of an OAM trait resource.
type Workload ¶ added in v0.2.0
type Workload interface {
Object
Conditioned
}
A Workload is a type of OAM workload.
type WorkloadKind ¶ added in v0.2.0
type WorkloadKind schema.GroupVersionKind
WorkloadKind contains the type metadata for a kind of an OAM workload resource.
type WorkloadReferencer ¶ added in v0.2.0
type WorkloadReferencer interface {
GetWorkloadReference() runtimev1alpha1.TypedReference
SetWorkloadReference(runtimev1alpha1.TypedReference)
}
A WorkloadReferencer may reference an OAM workload.
type WorkloadsReferencer ¶ added in v0.2.0
type WorkloadsReferencer interface {
GetWorkloadReferences() []runtimev1alpha1.TypedReference
AddWorkloadReference(runtimev1alpha1.TypedReference)
}
A WorkloadsReferencer may reference an OAM workload.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package mock provides fake OAM resources for use in tests.
|
Package mock provides fake OAM resources for use in tests. |