Entity Details Page
Introduction
An entity in Harness IDP is any software component, service, API, resource, or team that has been registered in the Catalog. Each entity is described by a YAML definition that captures its metadata, ownership, lifecycle, and relationships. Clicking an entity opens a comprehensive view of that entity.
Every entity details page has a header along with several tabs beneath it, each displaying a focused set of information from a specific domain or integration such as SonarQube, GitHub, PagerDuty, Harness CD, and many more.
Entity Header
The entity header appears at the top of every entity page. In IDP, core identity and classification fields are in the header so they are always visible regardless of which tab you are on.
| Field | Description |
|---|---|
| Kind | The entity kind, for example Component, API, Resource. |
| Type | The entity type within its kind, for example service, library, website. |
| Owner | The user or group responsible for this entity. |
| Lifecycle | The maturity stage, for example production, experimental, deprecated. |
| System | The system this entity belongs to. |
| Scope | The Harness account or org scope. |
| Branch | The Git branch associated with this entity, if applicable. |
| Git Source (icon) | Opens the entity's Git repository directly. Shown as a GitHub (or relevant SCM) icon. |
| TechDocs (icon) | Opens the entity's TechDocs site, if enabled. Shown as a document icon. |
The header also provides the following actions in the top-right corner:
| Action | Description |
|---|---|
| View YAML | Opens the Entity Inspector to review raw YAML, JSON, and ingested properties. |
| Edit | Opens the entity edit view in either the Visual or YAML editor. |
| Three-dot menu | Additional options including Delete (for deleting the entity) and Copy URL. |
Tabs Available in Entity Details
The tabs visible on an entity page depend on the layout configured for that entity's kind and type, as well as which integrations are configured for your account.
Overview tab
The Overview tab is the default landing view for every entity. It is designed as a health dashboard that aggregates the most important signals onto a single page. You can:
- Review ownership, lifecycle, relationships, and scorecard results
- See who is on-call right now via PagerDuty and monitor active incidents
- Review code quality metrics from SonarQube and check the quality gate status
- Track open pull requests and merge activity from GitHub
- Measure DORA performance benchmarks
The IntegrationsContent card includes the following signals:
| Signal | Description |
|---|---|
| Incidents | Shows active incidents linked to this entity from connected PagerDuty integration. Resolved incidents are not shown in this summary, so navigate to the dedicated Incidents tab for a full list. |
| On-Call | The current on-call schedule from the PagerDuty integration, showing who is responsible for responding to incidents right now. |
| Source Control Management | A summary of SCM activity from the connected GitHub integration, including open PR count, merged PRs, and average cycle time. PR data covers the last 30 days. The Top Language field shows a single primary language only, not a multi-language breakdown. |
| Code Quality | A summary of code quality metrics from the connected SonarQube integration, including Reliability Rating, Security Rating, SQALE (Maintainability) Rating, Coverage percentage, and Technical Debt. A quality gate badge shows passed or failed status. |
| Scorecard | A summary of the entity's scorecard results, including overall score. Go to Scorecards to view details. |
| DORA | The four DORA metrics that measure software delivery performance: Deploy Frequency, Lead Time for Changes, Change Failure Rate, and Failed Deploy Recovery. Ratings are shown as Good, Fair, or Poor based on DORA benchmark thresholds. Rendered from ingested YAML properties available through Harness CD integration. |
Instead of requiring you to add and configure individual cards for every integration signal, the IntegrationsContent card bundles all integration-sourced data into a single card:
page:
name: EntityLayout
tabs:
- name: Overview
path: /
title: Overview
contents:
- component: IntegrationsContent
specs:
gridProps:
md: 12 # Use md: 6 for half width
(...add your remaining components)
If you are unable to view Integrations data in your Overview page, you may add it as shown in the video below:
If an integration is not yet set up, the relevant section may show a Not configured message with a link to configure it. Sections with active integrations continue to display data normally.
Each section also shows the timestamp when its data was last refreshed, so you always know how current the information is.
Currently, the arrangement of data within the IntegrationsContent card cannot be reordered or customized. You can control only the card size (for example, full width or half width) via the Layout editor.
Code Quality tab
The Code Quality tab provides a full, paginated view of code quality data from the connected SonarQube integration. It shows everything in the Overview summary, plus:
- Full issues list (bugs, code smells, vulnerabilities) with pagination
- Security hotspots
The Code Quality tab, Source Code tab, Incidents tab may not be present in the layout by default. You can explicitly add them via the Layout editor for the relevant entity kind and type. Here are the respective component names:
CodeQualityTabSourceControlTabIncidentTabContent
Source Code tab
The Source Code tab provides a full view of source control activity from the connected SCM integration such as GitHub. It shows the same pull request summary as the Integration Content card, plus a detailed, paginated list of individual pull requests.
Key details:
- PR data covers the last 30 days.
- Top Language shows a single primary language only.
Incidents tab
The Incidents tab provides a full view of incident data for this entity from PagerDuty. An incident is an alert or event that indicates something may be wrong with the service, for example, a spike in error rate or a failed health check. This tab is distinct from the Integration Content card on the Overview tab, which shows only active incidents. The Incidents tab includes:
- A list of both active and resolved incidents.
- On-call persons with their schedule, showing when each user is on-call for this entity. For permanently on-call individuals, no schedule is shown.
- Service metrics from PagerDuty, including total incident count and mean time to resolve (MTTR).
Other tabs
Here are a few examples of the tabs available for a specific kind and type. If required, you may explicitly add them or remove them via the Layout editor for your relevant entity kind and type.
| Tab | Description |
|---|---|
| Relations | Full interactive relationship graph showing all dependsOn, partOf, ownedBy, and hasPart links to other catalog entities. |
| API | API definitions the entity provides or consumes, as defined by providesApis and consumesApis in the entity YAML. Renders OpenAPI, AsyncAPI, GraphQL, and gRPC specs inline. |
| Docs | TechDocs site for this entity, generated from Markdown files stored in Git. See Enable Docs. |
| IACM | Harness IACM workspace data including state, resource counts, and recent runs. |
| Scorecard | Full scorecard report across all configured scorecards, including overall score, tier, and per-check pass/fail breakdown. See Scorecards. |
| Dependencies | Package-level dependency graph. Distinct from the catalog-level Relations tab. |
| Cloud Costs | Cloud cost data from Harness CCM including spend trends and anomaly alerts. |
| Custom Plugin | Custom frontend plugin tabs that can display any data relevant to your organization. See Custom Plugins. |
| HarnessCICD | Pipeline run history from Harness CI and Harness CD, including run status, trigger type, and environment. Requires the Harness pipeline annotation on the entity. |
Configure Tabs and Layout
The tabs and cards shown on an entity details page are controlled by the Layout configuration for that entity's kind and type. You can add, remove, reorder, and resize cards and tabs using the Layout editor.
To access the Layout editor:
- In Harness, open Internal Developer Portal.
- From the left sidebar, click Configure.
- Click Layout.
- Select the layout for the entity kind and type you want to modify, or create a new layout.
When you create a new layout type, it comes pre-filled with a default set of cards and tabs as a starting point.
Frequently Asked Questions
Why is my integration data not showing on the Overview tab?
The Integration Content card only shows data for integrations that are configured for your account and linked to the entity. If a section shows Not configured, navigate to Configure → Integrations and set up the relevant integration. Once configured, the data will appear after the next sync.
If the integration is configured but data is still missing, check the last synced timestamp on the card. If it hasn't synced recently, go to the integration page and trigger a manual sync.
I added a tab in the Layout editor but it is not showing up on the entity page. Why?
Two things to check:
- Layout scope: Make sure you added the tab to the correct layout for the entity's Kind and Type. A tab added to
Component/servicewill not appear on aComponent/libraryentity. - Integration not configured: If the tab relies on an integration (for example, the Incidents tab needs PagerDuty), the tab may render empty or not appear if that integration is not configured. Set up the integration first, then revisit the layout.
Can I reorder the data inside the Integration Content card?
Not currently. The arrangement of signals within the Integration Content card (Incidents, On-Call, Source Control, Code Quality, Scorecard, DORA) is fixed and managed by Harness. You can only control the overall card size (full width or half width) in the Layout editor. The ability to reorder signals inside the card is planned for a future release.
The Overview tab shows only active incidents. Where do I see the rest?
The Integration Content card on the Overview tab intentionally shows you active incidents only to keep the dashboard focused on actionable and insightful items. To see the full incident history including resolved incidents, open the Incidents tab.
My entity is connected to two SonarQube instances but only one shows up. Why?
The Integration Content card currently shows data from one integration per signal type per entity. If your entity is linked to more than one SonarQube instance, only one integration's data is displayed. A future release will add a dropdown to switch between multiple integrations of the same type on the same entity.
The Code Quality / Source Code / Incidents tab is not visible on my entity. How do I add it?
These three tabs are not included in the default layout. You need to add them manually:
- Go to Configure → Layout.
- Select the layout for your entity's kind and type.
- Add the relevant tab (Code Quality, Source Code, or Incidents) to the layout (as shown here)
- Save the layout. The tab will now appear for all entities of that kind and type.
The Source Control section shows only one language and calls it Top Language. Is it accurate?
The Top Language field shows the single most-used language in the repo by file share percentage. It reflects the primary language at the time of the last GitHub sync, not the language you might consider as "main". If the value looks unexpected, it may be because generated files, config files, or vendored dependencies are skewing the count on the GitHub side.
Why does the Entity Inspector show data I did not add to the entity YAML?
The Entity Inspector shows two types of data: the entity YAML you authored, and ingested properties pulled in automatically from connected integrations. For example, if your entity is linked to GitHub via the GitHub integration, repository metadata like team associations and repository URL are automatically stored under integration_properties.GitHub. This data is read-only and managed by the integration sync.