Skip to content

Resource Spec

owner [Required]

An entity reference to the owner of the entity, e.g. owner: user:enu43627. Users and Groups are automatically populated, and can listed in the catalog by filtering by Kind of User or Group respectively.

The owner of an entity is the group or user that bears ultimate responsibility for the entity, and has the authority and capability to develop and maintain it. They will be the point of contact if something goes wrong, or if features are to be requested. The main purpose of this field is for display purposes in Backstage, so that people looking at catalog items can get an understanding of to whom this entity belongs. It is not to be used by automated processes to for example assign authorization in runtime systems. There may be others that also develop or otherwise touch the entity, but there will always be one ultimate owner.

type [Required]

The type of resource as a string, e.g. database. There is currently no enforced set of values for this field, so it is left up to the user to decide an appropriate name, in doing so the user is encouraged to reference existing Resources on the developer portal.

Some common values for this field may include:

  • database
  • s3-bucket
  • cluster

system [Optional]

An entity reference to the System that the entity belongs to, e.g. developer-portal. There is no requirement for this System to be created within the same location; Existing Systems can be listed in the catalog by filtering by Kind of System.

dependsOn [Optional]

An array of entity references to the Components and Resources that this entity depends on, e.g. dependsOn: [component:developer-portal-backend]. There is no requirement for these entities to be created within the same location; Existing entities can be listed in the catalog.

dependencyOf [Optional]

An array of entity references to the Components and Resources that this resource is a dependency of, e.g. dependencyOf: [artist-lookup]. There is no requirement for these entities to be created within the same location; Existing entities can be listed in the catalog. Use of this field is discouraged in favour defining dependsOn on the dependant Component or Resource.