Skip to main content

Backstage Glossary

API​

In the Backstage Catalog, an API is an entity representing a boundary between two components.

https://backstage.io/docs/features/software-catalog/system-model

Administrator​

Someone responsible for installing and maintaining a Backstage app for an organization. A user role.

App​

An installed instance of Backstage. An app can be local, intended for a single development group or individual developer, or organizational, for use by an entire enterprise.

Backstage​

A platform for creating and deploying developer portals, originally created at Spotify.

Backstage is an incubation-stage open source project of the Cloud Native Computing Foundation.

Catalog​

An organization's portfolio of software products managed in Backstage.

Cloud Native Computing​

A set of technologies that "empower organizations to build and run scalable applications in modern, dynamic environments such as public, private, and hybrid clouds. Containers, service meshes, microservices, immutable infrastructure, and declarative APIs exemplify this approach." (CNCF Cloud Native Definition v1.0).

Cloud Native Computing Foundation​

A foundation dedicated to the promotion and advancement of Cloud Native Computing. The mission of the Cloud Native Computing Foundation (CNCF) is "to make cloud native computing ubiquitous" (CNCF Charter).

CNCF is part of the Linux Foundation.

CNCF​

Cloud Native Computing Foundation.

Component​

A software product that is managed in the Backstage Software Catalog. A component can be a service, website, library, data pipeline, or any other piece of software managed as a single project.

https://backstage.io/docs/features/software-catalog/system-model

Contributor​

A volunteer who helps to improve an OSS product such as Backstage. This volunteer effort includes coding, testing, technical writing, user support, and other work. A user role.

Developer​

Someone who writes code and develops software.

A user role defined as someone who uses a Backstage app. Might or might not actually be a software developer.

Developer Portal​

A centralized system comprising a user interface and database used to facilitate and document all the software projects within an organization. Backstage is both a developer portal and (by virtue of being based on plugins) a platform for creating developer portals.

Domain​

In the Backstage Catalog, a domain is an area that relates systems or entities to a business unit.

https://backstage.io/docs/features/software-catalog/system-model

Entity​

What is cataloged in the Backstage Software Catalog. An entity is identified by kind, namespace, and name.

Evaluator​

Someone who assesses whether Backstage is a suitable solution for their organization. The only user role with a pre-deployment use case.

Integrator​

Someone who develops one or more plugins that enable Backstage to interoperate with another software system. A user role.

Kind​

Classification of an entity in the Backstage Software Catalog, for example service, database, and team.

Kubernetes Plugin​

A plugin enabling configuration of Backstage on a Kubernetes cluster. Kubernetes plugin has been promoted to a Backstage core feature.

Mono-Repo​

A single repository for a collection of related software projects, such as all projects belonging to an organization.

Namespace​

In the Backstage Software Catalog, an optional attribute that can be used to organize entities.

Objective​

A high level goal of a user role interacting with Backstage. Some goals of the administrator user role, for example, are to maintain an instance ("app") of Backstage; to add and update functionality via plugins; and to troubleshoot issues.

OSS​

Open source software.

Persona​

Alternative term for a User Role.

Plugin​

A module in Backstage that adds a feature. All functionality in Backstage, even the core features, are implemented as plugins.

Procedure​

A set of actions that accomplish a goal, usually as part of a use case. A procedure can be high-level, containing other procedures, or can be as simple as a single task.

Resource​

In the Backstage Catalog, an entity that represents a piece of physical or virtual infrastructure, for example a database, required by a component.

https://backstage.io/docs/features/software-catalog/system-model

Role​

See User Role.

A Backstage plugin that provides a framework for searching a Backstage app, including the Software Catalog and TechDocs. One of the core features of Backstage.

Software Catalog​

A centralized system that keeps track of ownership and metadata for any number and type of software components. A core feature of Backstage.

Software Templates​

A tool in Backstage with which to create components in Backstage. A core feature of Backstage.

A "skeleton" software project created and managed in the Backstage Software Templates tool.

System​

In the Backspace Catalog, a system is a collection of entities that cooperate to perform a function.

https://backstage.io/docs/features/software-catalog/system-model

Task​

A low-level step-by-step Procedure.

TechDocs​

A documentation solution that manages and generates a technical documentation from Markdown files stored with software component code. A core feature of Backstage.

Use Case​

A purpose for which a user role interacts with Backstage. Related to Objective: An objective is what the user wants to do; a use case is how the user does it.

User Role​

A class of Backspace user for purposes of analyzing use cases. One of: evaluator; administrator; developer; integrator; and contributor.