variable

Documentation

Index

• type FieldDescriptor
• type ResourceField
  • func (rv *ResourceField) AddDependencies(dep ...string)
• type ResourceVariableKind
  • func (r ResourceVariableKind) IsDynamic() bool
  • func (r ResourceVariableKind) IsIncludeWhen() bool
  • func (r ResourceVariableKind) IsStatic() bool
  • func (r ResourceVariableKind) String() string

Types

type FieldDescriptor

type FieldDescriptor struct {
	// Path is the path of the field in the resource (JSONPath-like)
	// example: spec.template.spec.containers[0].env[0].value
	// Since the object's we're dealing with are mainly made up of maps,
	// arrays and native types, we can use a string to represent the path.
	Path string
	// Expressions is a list of CEL expressions in the field.
	Expressions []string
	// ExpectedType is the expected type of the field.
	ExpectedType string
	// ExpectedSchema is the expected schema of the field if it is a complex type.
	// This is only set if the field is a OneShotCEL expression, and the schema
	// is expected to be a complex type (object or array).
	ExpectedSchema *spec.Schema
	// StandaloneExpression is true if the field contains a single CEL expression
	// that is not part of a larger string. example: "${foo}" is a standalone expression
	// but not "hello-${foo}" or "${foo}${bar}"
	StandaloneExpression bool
}

FieldDescriptor represents a field that contains CEL expressions in it. It contains the path of the field in the resource, the CEL expressions and the expected type of the field. The field may contain multiple expressions.

type ResourceField

type ResourceField struct {
	// CELField is the object that contains the expression, the path, and the
	// the expected type (OpenAPI schema).
	FieldDescriptor
	// ResourceVariableKind is the kind of the variable (static or dynamic).
	Kind ResourceVariableKind
	// Dependencies is a list of resources this variable depends on. We need
	// this information to wait for the dependencies to be resolved before
	// evaluating the variable.
	Dependencies []string
}

ResourceVariable represents a variable in a resource. Variables are any field in a resource (under resources[*].definition) that is not a constant value a.k.a contains one or multiple expressions. For example

spec:
  replicas: ${schema.spec.mycustomReplicasField + 5}

Contains a variable named "spec.mycustomReplicasField". Variables can be static or dynamic. Static variables are resolved at the beginning of the execution and their value is constant. Dynamic variables are resolved at runtime and their value can change during the execution.

ResourceVariables are an extension of CELField and they contain additional information about the variable kind.

func (*ResourceField) AddDependencies

func (rv *ResourceField) AddDependencies(dep ...string)

AddDependencies adds dependencies to the ResourceField.

type ResourceVariableKind

type ResourceVariableKind string

ResourceVariableKind represents the kind of a resource variable.

const (
	// ResourceVariableKindStatic represents a static variable. Static variables
	// are resolved at the beginning of the execution and their value is constant.
	// Static variables are easy to find, they always start with 'spec'. Refereing
	// to the instance spec.
	//
	// For example:
	//   spec:
	//      replicas: ${schema.spec.replicas + 5}
	ResourceVariableKindStatic ResourceVariableKind = "static"
	// ResourceVariableKindDynamic represents a dynamic variable. Dynamic variables
	// are resolved at runtime and their value can change during the execution. Dynamic
	// cannot start with 'spec' and they must refer to another resource in the
	// ResourceGroup.
	//
	// For example:
	//    spec:
	//	    vpcID: ${vpc.status.vpcID}
	ResourceVariableKindDynamic ResourceVariableKind = "dynamic"
	// ResourceVariableKindReadyWhen represents readyWhen variables. ReadyWhen variables
	// are resolved at runtime. The difference between them, and the dynamic variables
	// is that dynamic variable resolutions wait for other resources to provide a value
	// while ReadyWhen variables are created and wait for certain conditions before
	// moving forward to the next resource to create
	//
	// For example:
	//   name: cluster
	//   readyWhen:
	//   - ${cluster.status.status == "Active"}
	ResourceVariableKindReadyWhen ResourceVariableKind = "readyWhen"
	// ResourceVariableKindIncludeWhen represents an includeWhen variable.
	// IncludeWhen variables are resolved at the beginning of the execution and
	// their value is constant. They decide whether we are going to create
	// a resource or not
	//
	// For example:
	//   name: deployment
	//   includeWhen:
	//   - ${schema.spec.replicas > 1}
	ResourceVariableKindIncludeWhen ResourceVariableKind = "includeWhen"
)

func (ResourceVariableKind) IsDynamic

func (r ResourceVariableKind) IsDynamic() bool

IsDynamic returns true if the ResourceVariableKind is dynamic

func (ResourceVariableKind) IsIncludeWhen

func (r ResourceVariableKind) IsIncludeWhen() bool

IsIncludeWhen returns true if the ResourceVariableKind is includeWhen

func (ResourceVariableKind) IsStatic

func (r ResourceVariableKind) IsStatic() bool

IsStatic returns true if the ResourceVariableKind is static

func (ResourceVariableKind) String

func (r ResourceVariableKind) String() string

String returns the string representation of a ResourceVariableKind.