Entities overview

Entities are the foundational building blocks for representing your software ecosystem. Each entity models a distinct software construct—like a service, library, or team—giving your organization a shared, structured way to describe what exists and how it fits together. A defined collection of entities forms a catalog: a single source of truth that everyone, from engineers to leadership, can rely on.

Entities are designed to be both flexible and interconnected. They're defined in YAML so they're portable and version-controlled, enriched through integrations that pull in live data from the tools you already use, and measured against standards through Scorecards to drive quality and consistency over time.

Every entity has a dedicated page that brings its data together in one place, making it easy to understand context, ownership, and health at a glance. See Entity details for more information.

circle-check

Catalog and entities overview video

The video below shows how Cortex catalogs your engineering assets to improve visibility, adoption, and productivity:

Entity types

Choose from the default entity types or define your own.

Default entity types

Cortex provides a set of built-in entity types that cover the most common building blocks of a software organization. These defaults give you a strong foundation out of the box, so you can start cataloging your ecosystem without needing to design a schema from scratch.

Entity type
Purpose
Typical use

Services

Represent codebase-like modules

Microservices, libraries, components

Domains

Group entities into logical units

Product areas, business capabilities, system boundaries

Teams

Represent the 'people side' of your catalog

Ownership, membership, contact info

Cloud resources

Sync infrastructure into your catalog

AWS, Azure, and Google Cloud resources

Services are the core of your catalog and the default entity type. Use them to represent any codebase-like module, e.g. microservices, libraries, components, and similar building blocks. Services are typically where the majority of your catalog activity happens, since they connect to code, deployments, ownership, and quality standards. See Add services.

Domains let you group services, resources, and other domains into hierarchical, logical units. They're useful for modeling how your organization actually thinks about its software—by product area, business capability, or system boundary—and for rolling up insights across related entities. See Add domains.

Teams represent the people side of your catalog. Use them to capture team membership, ownership relationships, and contact information, so it's always clear who's responsible for what. See Add teams.

Cloud resources can be pulled in directly from your cloud providers and represented as their corresponding entity types, keeping your catalog in sync with what's actually running in your infrastructure:

Custom entity types

While Cortex's built-in entity types cover most common needs, every organization has its own way of modeling its software ecosystem. Custom entity types let you extend your catalog to reflect the concepts that matter to your teams, whether that's APIs, data pipelines, ML models, or anything else you want to track.

You can create unlimited custom entity types through the Cortex UI or API. Once a type is defined, you can begin adding entities of that type using the UI, API, or GitOps, just like you would with built-in types.

See Add custom entity types for more information.

Last updated

Was this helpful?