types

Documentation

Index

• type ClaimResource
• type ClaimType
• type ClaimedResource
• type ClaimedType
• type FSMResource
• type Resource
• type ResourceManager

Types

type ClaimResource

type ClaimResource interface {
	// GetClaimedRef returns a reference to the resource claimed by this claim.
	GetClaimedRef() *api.TypedObjectRef
	// SetClaimedRef sets the reference to the resource claimed by this claim.
	SetClaimedRef(ref *api.TypedObjectRef)
}

ClaimResource is a k8s resource that can act as a Claim.

type ClaimType

type ClaimType[T any] interface {
	Resource[T]
	ClaimResource
}

ClaimType constrains a resource to a ClaimResource.

type ClaimedResource

type ClaimedResource interface {
	// GetClaimRef returns a reference to the claim that created this resource.
	GetClaimRef() *api.TypedObjectRef
	// SetClaimRef sets the reference to the claim that created this resource.
	SetClaimRef(ref *api.TypedObjectRef)
}

ClaimedResource is a k8s resource that can act as a Claimed.

type ClaimedType

type ClaimedType[T any] interface {
	FSMResource[T]
	ClaimedResource
}

ClaimedType constrains a resource to a ClaimedResource.

type FSMResource

type FSMResource[T any] interface {
	client.Object   // must be a k8s resource
	api.Conditioned // must have Conditions
	ResourceManager // must manage a set of child resources
	*T              // must be a pointer
}

FSMResource constrains to the types necessary for controller management.

type Resource

type Resource[T any] interface {
	client.Object   // must be a k8s resource
	api.Conditioned // must have Conditions
	*T              // must be a pointer
}

Resource constrains to the types necessary for controller management.

type ResourceManager

type ResourceManager interface {
	// SetManagedResources sets the refs for child resources managed by the controller.
	SetManagedResources(refs []api.TypedObjectRef)
	// GetManagedResources gets the refs for child resources managed by the controller.
	GetManagedResources() []api.TypedObjectRef
}

ResourceManager is a k8s resource that manages a set of child resources.