clusterorder

Documentation

Overview

The package clusterorder provides the interface and the factory method to create a new clusterorder based on the provider TODO: This might be a implementation in the upcoming ResourceFramework

TODO: This library is imported from ror, should determine if its a public library or not

Index

• type ClusterOrder
  • func NewClusterOrder(ctx context.Context, orderspec apiresourcecontracts.ResourceClusterOrderSpec) (ClusterOrder, error)
  • func NewClusterOrderFromResource(ctx context.Context, resource apiresourcecontracts.ResourceClusterOrder) (ClusterOrder, error)

Types

type ClusterOrder

type ClusterOrder interface {
	Validate(ctx context.Context) error
	GetProviderConfig() any
	Save(ctx context.Context) error
	UpdateStatus(ctx context.Context, status apiresourcecontracts.ResourceClusterOrderStatus) error
}

ClusterOrder is an interface that defines the methods that a clusterprovider must implement

func NewClusterOrder

func NewClusterOrder(ctx context.Context, orderspec apiresourcecontracts.ResourceClusterOrderSpec) (ClusterOrder, error)

NewClusterOrder returns a new clusterorder based on the provider

func NewClusterOrderFromResource

func NewClusterOrderFromResource(ctx context.Context, resource apiresourcecontracts.ResourceClusterOrder) (ClusterOrder, error)

NewClusterOrderFromResource is a wrapper for the newClusterOrder function. Its intended use is to be called from the outside of the package after the clusterorder is persisted.