You are reading the documentation for an outdated Corteza release. 2023.9 is the latest stable Corteza release.

Corteza Envoy

Corteza Envoy defines a data transportation framework that we use when working with complex data with lots of dependencies. The goal is to simplify data-related operations as much as possible.

Envoy consists of a series of layers which allow flexibility while preserving fairly trivial basic implementation.

The diagram outlines Envoy’s architecture; the main layers.
Figure 1. The diagram outlines Envoy’s architecture; the main layers.

Resources

A resource is some generic intermediate structure that represents the provided source data with some additional context to enable further processing (things like dependency management via the dependency graph).

Data shaping

Data shaping lets us define templates how some input source should be shaped (processed) before being encoded.

Data shaping is useful for unstructured sources (such as .csv) where we can’t automatically extract contextual information (such as what module and namespace to use).

Source decoder

The source decoding layer takes in different data formats (such as json and yaml) and outputs a set of resource structures.

The source decoder is usually the first layer but we can also omit it if we construct resource structures manually.

Source encoder

The resource encoding layer takes in resources structures and encodes them to different destinations (such as the store layer).

Different encoders (YAML, JSON, and CSV) are on their way.

Dependency graph

The dependency graph is the heart of the system, as it lets us determine the order in which the resources should be processed in.

It is a result of the graph building flow that enables you to do any pre-processing to the raw data.