oam

Documentation

Overview

Package oam contains core OAM types.

Index

• type Conditioned
• type Finalizer
• type Object
• type Trait
• type TraitKind
• type Workload
• type WorkloadKind
• type WorkloadReferencer

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 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.