Systems

Summary

A system is a collection of resources and components. The system may expose or consume one or several APIs. It is viewed as abstraction level that provides potential consumers insights into exposed features without needing a too detailed view into the details of all components. This also gives the owning team the possibility to decide about published artifacts and APIs.

Definition

!!! info "Backstage Docs"

See [the backstage docs](https://backstage.io/docs/features/software-catalog/descriptor-format/#kind-system) for a full description of the `System` entity definition.

As with all other entities, a system consists of the envelope types, apiVersion and kind, as well as generic metadata and a specific spec.

{% include-markdown "../references/entity-envelope.md" start="" end="" heading-offset=1 %}

kind [Required]

The kind is the high level entity type being described. For a software system this must be System, e.g. kind: System.

Other available kinds are enumerated in the entity types reference.

{% include-markdown "../references/entity-envelope.md" start="" end="" heading-offset=1 %}

{% include-markdown "../references/entity-metadata.md" start="" end="" heading-offset=2 %}

spec [Required]

The actual specification data that describes the entity.

{% include-markdown "../references/system-spec.md" start="" end="" heading-offset=2 %}