Skip to content

Latest commit

 

History

History
114 lines (69 loc) · 4.9 KB

Glossary.md

File metadata and controls

114 lines (69 loc) · 4.9 KB

Glossary

Aggregated Blueprint

Aggregated Blueprints are Blueprints that bundle multiple other blueprints. They contain instructions how they these referenced blueprints interact with each other.

Their pratical use is to install mutliple components that depend on each other.

Blueprint

Blueprints contain actual instructions and steps on how to install a software component and what is needed to perform these actions.

Background Knowledge:

Blueprints consists of: - Configuration Data (Imports) - Installation instructions - DeployItems or - Subinstallations - Output

Component Descriptor_

A Component Descriptor contains references and locations to all resources that are used by Landscaper to deploy and install an application. Typically a Component Descriptor is stored in an OCI registry.

For more details see here and here.

Context

A context defines the scope in which an Installation runs and all of its data lives. For every Installation a dedicated context is created and data can only be accessed within the same context. Data can be exchanged between contexts via Import and Export declarations.

Since Installations can be nested, the resulting Contexts are nested as well.

For more information see here.

DataObject

DataObjects are vehicles to store arbitrary kinds of data. They exist in a Context and provide data to Imports / receive data from Exports. They can be considerd to be the implementation of the data flow in an installation.

Deployer

Deployer are highly specialized controllers that act on DeployItems of a certain type. They execute the installation instructions and aim to maintain the declared desired state.

DeployExecutions

A list of templates to generate deploy items as part of a Blueprint. Mainly used to describe the installation instructions and customize it using the data provided as imports.

DeployItem

A DeployItem is the interface between the Landscaper controller and the Deployers. It contains input data and a set of Deployer-specific instructions on how to install a component (e.g. install a helm chart with some custom values). Additionally, it is used to record the status as returned by the Deployer.

Execution

Export

Export has 2 ambigious meanings, whether we are talking about Blueprints or Installations.

Blueprint Export

Exports declare the output expected from a processed Blueprint.

Installation Export

Exports of an Installation pick up actual values and make them accessible for a user, parent or sibling Installation.

Background Knowledge:

Parent Installations can use exports of their subinstallations as their own export. They cannot be used as inputs for their deploy items.

ExportExecutions

A list of templates describing how to generate exports as part of a Blueprint. These templates contain the instructions which data gets written into the exports and how it might be preprocessed.

Import

Import has 2 ambigious meanings, whether we are talking about Blueprints or Installations.

Blueprint Import

Imports declare what data will be required to process the Blueprint. Part of the declaration is also the format, which can either be of type Target or any valid jsonschema.

Installation Import

Imports in an Installation assign acutal values and make them accessible for further processing. They satisfy the requirements (imports) defined in the Blueprint.

Installation

An installation is the parameterized instance of a Blueprint deployed by a user. Landscaper acts upon creation or update and creates or updates dependent Execution and Subinstallations.

Sibling Installations

Sibling Installations refer to Installations belonging to the same parent.

Subinstallations

Subinstallations are Installations that are automatically created by the landscaper as part of a running installation (the installation references a Aggregated Blueprint).

Background Knowledge:

Subinstallations define the usage of other blueprints within an [Aggregated Blueprint](#_aggregated-blueprint_). Subinstallations can be nested, when deployed, they are managed by their parent (sub)installation.

Target

A Target defines the system in which Landscaper will run the installation steps. Target resources contain all relevant data to access this environment including credentials.