process

Documentation

Index

• Constants
• func NewContext(data ContextData) process.Context
• type ContextData

Constants

const (
	// OutputFieldName is the reference of context base object
	OutputFieldName = "output"
	// OutputsFieldName is the reference of context Auxiliaries
	OutputsFieldName = "outputs"
	// ConfigFieldName is the reference of context config
	ConfigFieldName = "config"
	// ParameterFieldName is the keyword in CUE template to define users' input and the reference to the context parameter
	ParameterFieldName = "parameter"
	// ContextName is the name of context
	ContextName = "name"
	// ContextAppName is the appName of context
	ContextAppName = "appName"
	// ContextAppRevision is the revision name of app of context
	ContextAppRevision = "appRevision"
	// ContextAppRevisionNum is the revision num of app of context
	ContextAppRevisionNum = "appRevisionNum"
	// ContextAppLabels is the labels of app of context
	ContextAppLabels = "appLabels"
	// ContextAppAnnotations is the annotations of app of context
	ContextAppAnnotations = "appAnnotations"
	// ContextNamespace is the namespace of the app
	ContextNamespace = "namespace"
	// ContextCluster is the cluster currently focusing on
	ContextCluster = "cluster"
	// ContextClusterVersion is the version object info of cluster
	ContextClusterVersion = "clusterVersion"
	// ContextPublishVersion is the publish version of the app
	ContextPublishVersion = "publishVersion"
	// ContextWorkflowName is the name of the workflow
	ContextWorkflowName = "workflowName"
	// OutputSecretName is used to store all secret names which are generated by cloud resource components
	OutputSecretName = "outputSecretName"
	// ContextCompRevisionName is the component revision name of context
	ContextCompRevisionName = "revision"
	// ContextComponents is the components of app
	ContextComponents = "components"
	// ContextComponentType is the component type of current trait binding with
	ContextComponentType = "componentType"
	// ComponentRevisionPlaceHolder is the component revision name placeHolder, this field will be replaced with real value
	// after component be created
	ComponentRevisionPlaceHolder = "KUBEVELA_COMPONENT_REVISION_PLACEHOLDER"
	// ContextDataArtifacts is used to store unstructured resources of components
	ContextDataArtifacts = "artifacts"
	// ContextReplicaKey is the key of replication in context
	ContextReplicaKey = "replicaKey"
)

Functions

func NewContext

func NewContext(data ContextData) process.Context

NewContext creates a new process context

Types

type ContextData

type ContextData struct {
	Namespace       string
	Cluster         string
	AppName         string
	CompName        string
	StepName        string
	AppRevisionName string
	WorkflowName    string
	PublishVersion  string
	ReplicaKey      string

	Ctx            context.Context
	BaseHooks      []process.BaseHook
	AuxiliaryHooks []process.AuxiliaryHook
	Components     []common.ApplicationComponent

	AppLabels      map[string]string
	AppAnnotations map[string]string

	ClusterVersion types.ClusterVersion
}

ContextData is the core data of process context