Skip to content

Latest commit

 

History

History
155 lines (114 loc) · 4.95 KB

File metadata and controls

155 lines (114 loc) · 4.95 KB

Koreo Glossary of Terminology

C

Condition

A convention used on Kubernetes resources to communicate status information. Koreo may optionally set Conditions on a parent object based on the Outcome from a step.

Contract Testing

Used to ensure that correctly structured API calls are made based on a set of inputs.

Control Loop

A control loop observes conditions and state. If the observed conditions or state do not meet the target state, then the control loop will attempt to bring them into alignment with the target state by making adjustments.

D

DepSkip

An Outcome that indicates a dependency is not yet ready. It means the Logic was skipped without an attempt to evaluate.

E

Expression

See Koreo Expression

F

Function

Refers to a ValueFunction or ResourceFunction.

Function Test

Koreo's built in control loop friendly testing framework. Allows for unit-testing style validation in addition to contract testing.

Function Under Test

Refers to a ValueFunction or ResourceFunction that is being tested by a FunctionTest.

K

Koreo

Arguably the most pleasant to use Kubernetes templating and workflow orchestration system currently in existence.

Koreo Expression

A simple expression language that is modelled after CEL, provides capabilities needed for basic logic, arithmetic, string manipulation, and data reshaping.

L

Logic

Refers to a Function or Workflow. Most often the term is used to refer to the Function or Workflow to be run as a Workflow step.

M

Managed Resource

A Kubernetes resource that a ResourceFunction is managing to ensures its specification matches a Target Resource Specification or reads values from (for readonly functions).

O

Ok

The Outcome that indicates a successful evaluation. A return-value may be present, if expected.

Outcome

Refers to the return type of a Function or Workflow, the types are Skip, DepSkip, Retry, PermFail, and Ok.

P

Parent Object

A Kubernetes object which is used to trigger Workflow reconciliations and provide configuration to the Workflow instance.

PermFail

An Outcome that indicates a permanent failure condition that will require intervention in order to resolve.

R

Reconcile

To run a control loop in order to ensure the conditions and observed state match the desired state. If they do not match, the differences will be reconciled to bring them into alignment.

ResourceFunction

A Function which manages or reads values from a Managed Resource. These functions are an interface to external state, which they may set and load. When managing a resource, they define a control loop.

ResourceTemplate

Provides a simple means of specifying static values as a base Target Resource Specification. A ResourceTemplate may be dynamically loaded by a ResourceFunction, allowing for configuration based template selection. The static values may be overlaid with values provided to (or computed by) a ResourceFunction.

Retry

An Outcome that indicates the Logic should be retried after a specified delay. Typically this indicates an active waiting status that is expected to self-resolve over time.

S

Skip

An Outcome that indicates the Logic was skipped without an attempt to evaluate due to an input or other condition.

State

Some of all of a Logic's return value which will be set on the parent object's status.state property.

Step

A Workflow step specifies Logic to be run, how inputs from other steps will map into the Logic's inputs, if a Condition should be reported, and if any state should be extracted and returned (either to a calling Workflow or parent object).

T

Target Resource Specification

The specification that a resource is expected to match after all Koreo Expressions have been evaluated and all overlays applied. The is the fully materialized resource view that will be applied to the cluster.

V

ValueFunction

A pure function which may be used to perform validations, compute values, or restructure data.

W

Workflow

Defines a collection of Steps to be run and manages their execution.