Skip to main content

Custom Entity Kinds Overview

Last updated on

Introduction​

Harness IDP includes a set of built-in entity kinds such as:

  • Component
  • API
  • Resource
  • Environment
  • Group
  • System
  • Hierarchy
  • Workflow
  • User

While these cover most standard catalog use cases, teams might want to model objects that don't fit into any of the above kinds.

Therefore, Custom Entity Kinds let you define your own entity kinds in the IDP Catalog. Each custom kind has:

  • A name and icon that appear across the catalog UI
  • A JSON Schema that controls the structure and validation of its entities
  • Full support for layouts, scorecards, plugins, and ingestion APIs
Prerequisites

RBAC: You need to have IDP_CATALOG resource permissions for creating, updating, and deleting custom entity kinds.

Once a custom kind is created, entities of that kind behave identically to entities of any built-in kind. They appear in catalog search and filters, layouts, aggregation rules, support relations and dependency graphs. Moreover, they work with scorecards and plugins, and can be ingested via the Catalog Ingestion API.

Next Steps​