definition

Documentation

Index

• Constants
• func GetBaseContextLabels(ctx process.Context) map[string]string
• func GetCommonLabels(contextLabels map[string]string) map[string]string
• type AbstractEngine
  • func NewTraitAbstractEngine(name string) AbstractEngine
  • func NewWorkloadAbstractEngine(name string) AbstractEngine

Constants

const (
	// OutputFieldName is the name of the struct contains the CR data
	OutputFieldName = velaprocess.OutputFieldName
	// OutputsFieldName is the name of the struct contains the map[string]CR data
	OutputsFieldName = velaprocess.OutputsFieldName
	// PatchFieldName is the name of the struct contains the patch of CR data
	PatchFieldName = "patch"
	// PatchOutputsFieldName is the name of the struct contains the patch of outputs CR data
	PatchOutputsFieldName = "patchOutputs"
	// CustomMessage defines the custom message in definition template
	CustomMessage = "message"
	// HealthCheckPolicy defines the health check policy in definition template
	HealthCheckPolicy = "isHealth"
	// ErrsFieldName check if errors contained in the cue
	ErrsFieldName = "errs"
)

const (
	// AuxiliaryWorkload defines the extra workload obj from a workloadDefinition,
	// e.g. a workload composed by deployment and service, the service will be marked as AuxiliaryWorkload
	AuxiliaryWorkload = "AuxiliaryWorkload"
)

Functions

func GetBaseContextLabels

func GetBaseContextLabels(ctx process.Context) map[string]string

GetBaseContextLabels get base context labels

func GetCommonLabels

func GetCommonLabels(contextLabels map[string]string) map[string]string

GetCommonLabels will convert context based labels to OAM standard labels

Types

type AbstractEngine

type AbstractEngine interface {
	Complete(ctx process.Context, abstractTemplate string, params interface{}) error
	HealthCheck(templateContext map[string]interface{}, healthPolicyTemplate string, parameter interface{}) (bool, error)
	Status(templateContext map[string]interface{}, customStatusTemplate string, parameter interface{}) (string, error)
	GetTemplateContext(ctx process.Context, cli client.Client, accessor util.NamespaceAccessor) (map[string]interface{}, error)
}

AbstractEngine defines Definition's Render interface

func NewTraitAbstractEngine

func NewTraitAbstractEngine(name string) AbstractEngine

NewTraitAbstractEngine create Trait Definition AbstractEngine

func NewWorkloadAbstractEngine

func NewWorkloadAbstractEngine(name string) AbstractEngine

NewWorkloadAbstractEngine create Workload Definition AbstractEngine