Resources

Summary

A resource describes the infrastructure a System needs to operate, like BigTable databases, Pub/Sub topics, S3 buckets or CDNs. Modelling them together with components and systems allows to visualize resource footprint, and create tooling around them.

Definitions

!!! info "Backstage Docs"

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

As with all other entities, a resource 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 resource this must be Resource, e.g. kind: Resource.

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/resource-spec.md" start="" end="" heading-offset=2 %}