oam

Documentation

Index

• Constants
• func ApplyComponent(ctx context.Context, params *oamprovidertypes.OAMParams[cue.Value]) (cue.Value, error)
• func GetProviders() map[string]cuexruntime.ProviderFn
• func GetTemplate() string
• func RenderComponent(ctx context.Context, params *oamprovidertypes.OAMParams[cue.Value]) (cue.Value, error)
• type LoadParams
• type LoadResult
  • func LoadComponent(ctx context.Context, params *LoadParams) (*LoadResult, error)
  • func LoadComponentInOrder(ctx context.Context, params *LoadParams) (*LoadResult, error)
  • func LoadPolicies(_ context.Context, params *LoadParams) (*LoadResult, error)
• type LoadVars

Constants

const (
	// ProviderName is provider name for install.
	ProviderName = "oam"
)

Functions

func ApplyComponent

func ApplyComponent(ctx context.Context, params *oamprovidertypes.OAMParams[cue.Value]) (cue.Value, error)

ApplyComponent apply component.

func GetProviders

func GetProviders() map[string]cuexruntime.ProviderFn

GetProviders returns the cue providers.

func GetTemplate

func GetTemplate() string

GetTemplate returns the cue template.

func RenderComponent

func RenderComponent(ctx context.Context, params *oamprovidertypes.OAMParams[cue.Value]) (cue.Value, error)

RenderComponent render component

Types

type LoadParams

type LoadParams = oamprovidertypes.OAMParams[LoadVars]

LoadParams is the load provider params.

type LoadResult

type LoadResult struct {
	Value any `json:"value"`
}

LoadResult is the load provider result.

func LoadComponent

func LoadComponent(ctx context.Context, params *LoadParams) (*LoadResult, error)

LoadComponent load component describe info in application.

func LoadComponentInOrder

func LoadComponentInOrder(ctx context.Context, params *LoadParams) (*LoadResult, error)

LoadComponentInOrder load component describe info in application output will be a list with order defined in application.

func LoadPolicies

func LoadPolicies(_ context.Context, params *LoadParams) (*LoadResult, error)

LoadPolicies load policy describe info in application.

type LoadVars

type LoadVars struct {
	App string `json:"app,omitempty"`
}

LoadVars is the load provider vars.