Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ redirect_from:

## Introduction

In this tutorial we will be using the catalog metadata ingestion APIs to add additional metadata for the software components in the catalog, display them in the component overview page using [additional info card](/docs/internal-developer-portal/catalog/catalog-ui.md#adding-an-additional-info-card) and track the values ingested using [Scorecard](https://developer.harness.io/docs/internal-developer-portal/scorecards/custom-data-sources).
In this tutorial we will be using the catalog metadata ingestion APIs to add additional metadata for the software components in the catalog, display them in the component overview page using [additional info card](/docs/internal-developer-portal/catalog/manage-catalog/catalog-ui.md#adding-an-additional-info-card) and track the values ingested using [Scorecard](https://developer.harness.io/docs/internal-developer-portal/scorecards/custom-data-sources).

<DocImage path={require('./static/ccp-usecase.png')} />

<DocVideo src="https://www.youtube.com/embed/MB-IWGoYjOo?si=y87PPJlPdVYeqd99" />

## Pre-requisites

1. You must have components registered in your software catalog. If you don't have any components registered, follow this [tutorial](/docs/internal-developer-portal/catalog/manage-catalog.md) to register one. We recommend you to register [this software component](https://github.com/harness-community/idp-samples/blob/main/example-catalog-info/tutorial-catalog-ingestion.yaml) for this tutorial.
1. You must have components registered in your software catalog. If you don't have any components registered, follow this [tutorial](/docs/internal-developer-portal/catalog/manage-catalog/manage-catalog.md) to register one. We recommend you to register [this software component](https://github.com/harness-community/idp-samples/blob/main/example-catalog-info/tutorial-catalog-ingestion.yaml) for this tutorial.

## Add a new metadata

Expand Down Expand Up @@ -212,7 +212,7 @@ In case you want to display the same information you have ingested on your Overv

![](./static/add-additional-info-card.png)

2. Now go to the **Warehouse** Software Component in the **Catalog**, and you'll find an additional info card populated with information we ingested using the API above. You can read more about [additional info card](/docs/internal-developer-portal/catalog/catalog-ui.md#adding-an-additional-info-card)
2. Now go to the **Warehouse** Software Component in the **Catalog**, and you'll find an additional info card populated with information we ingested using the API above. You can read more about [additional info card](/docs/internal-developer-portal/catalog/manage-catalog/catalog-ui.md#adding-an-additional-info-card)

![](./static/additional-info-card-new.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/internal-developer-portal/catalog/catalog-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,8 +191,8 @@ These fields define the entity's scope. For project-scoped entities, both fields
If you have entities defined using legacy Backstage YAML (from IDP 1.0), you can easily convert them to the new Harness-native data model schema. There are two ways to perform this conversion:

1. **Using the Harness IDP UI:**
Navigate to the **[Harness IDP UI](/docs/internal-developer-portal/catalog/manage-catalog.md#harness-idp-ui)** and open the **YAML view** while creating an entity. Paste your legacy Backstage Catalog YAML, and the system will automatically generate the corresponding Harness-native Catalog YAML.
Learn more in the **[Catalog YAML View documentation](/docs/internal-developer-portal/catalog/manage-catalog.md#catalog-yaml)**.
Navigate to the **[Harness IDP UI](/docs/internal-developer-portal/catalog/manage-catalog/manage-catalog.md#harness-idp-ui)** and open the **YAML view** while creating an entity. Paste your legacy Backstage Catalog YAML, and the system will automatically generate the corresponding Harness-native Catalog YAML.
Learn more in the **[Catalog YAML View documentation](/docs/internal-developer-portal/catalog/manage-catalog/manage-catalog.md#catalog-yaml)**.

2. **Using the YAML Conversion API:**
To streamline migration, we've also introduced an API that converts Backstage Catalog YAML to the Harness-native format. [Read more in the IDP 2.0 migration guide.](/docs/internal-developer-portal/idp-2o-overview/migrating-idp-2o.md)
Expand Down Expand Up @@ -1127,7 +1127,7 @@ The current set of well-known and common values for this field is:
In the Harness Internal Developer Portal, the owner of a component can be identified by either:

* **Platform User Group ID**: The [Harness User Group ID](https://developer.harness.io/docs/platform/role-based-access-control/add-user-groups) for groups synced from identity providers
* **Custom User Group** [IDP 2.0]: A [Custom User Group](/docs/internal-developer-portal/catalog/user-group) created directly within IDP as a first-class catalog entity
* **Custom User Group** [IDP 2.0]: A [Custom User Group](/docs/internal-developer-portal/catalog/data-model/user-group) created directly within IDP as a first-class catalog entity

In both cases, this User Group represents the collective entity that holds ultimate responsibility for the component and possesses the authority and capability to develop and maintain it. Should any issues arise or if there are requests for features, this User Group will serve as the primary point of contact. The primary purpose of this field in the Harness IDP is for display, ensuring that individuals accessing catalog items can easily identify the responsible User Group for a given component.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"label": "Data Model",
"collapsible": "true",
"collapsed": "true",
"position": 2,
"link": {
"type": "generated-index",
"title": "Information on how to ingest information related to entities in catalog"
},
"customProps": {}
}
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ A **System** is a high-level organizational unit that groups together related co

In Harness IDP 2.0, Systems play a crucial role in organizing your catalog. Components belong to Systems, and Systems can belong to Domains. This hierarchical structure makes it easier to manage large catalogs with many interconnected components.

For more details on how to use this entity, please refer to the [detailed docs](/docs/internal-developer-portal/catalog/system-entity.md) here.
For more details on how to use this entity, please refer to the [detailed docs](/docs/internal-developer-portal/catalog/data-model/system-entity.md) here.

## Harness Platform Entities [IDP 2.0]

Expand All @@ -102,7 +102,7 @@ Custom User Groups can:
* Own components, systems, and other entities
* Be enriched with metadata for better context

For more details on Custom User Groups, please refer to the [detailed docs](/docs/internal-developer-portal/catalog/user-group) here.
For more details on Custom User Groups, please refer to the [detailed docs](/docs/internal-developer-portal/catalog/data-model/user-group) here.

Roles and resource groups can be assigned directly to users or inherited from user groups. Here's how you can [add users](https://developer.harness.io/docs/platform/role-based-access-control/add-users/) in Harness IDP.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"label": "Manage Catalog",
"collapsible": "true",
"collapsed": "true",
"position": 4,
"link": {
"type": "generated-index",
"title": "Information on how to ingest information related to entities in catalog"
},
"customProps": {}
}
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ After enabling the integration, configure what to sync:

That’s it; your CD services will appear in the IDP Catalog.

For suspending auto-discovery, see [Suspend Auto-Discovery](/docs/internal-developer-portal/catalog/catalog-discovery/harness-cd.md#4-suspend-auto-discovery).
For suspending auto-discovery, see [Suspend Auto-Discovery](/docs/internal-developer-portal/catalog/manage-catalog/catalog-discovery/harness-cd.md#4-suspend-auto-discovery).

### 3. View & manage CD services in the IDP Catalog

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Manage Catalog UI
description: Understand more on how to create and manage custom Catalog UI.
sidebar_position: 4
sidebar_position: 8
sidebar_label: Manage Catalog UI
redirect_from:
- /docs/internal-developer-portal/catalog/add-links-docs.md
Expand Down
Empty file.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Manage Catalog
description: Learn more about creating and managing your Catalog entities.
sidebar_position: 2
sidebar_position: 5
redirect_from: /docs/internal-developer-portal/catalog/register-software-component
---
import Tabs from '@theme/Tabs';
Expand Down Expand Up @@ -49,7 +49,7 @@ To create a new entity, navigate to the Harness IDP portal and click on **“Cre
3. Define the **entity scope** — choose whether the entity should reside at the Account, Project, or Organization level. Read more about Catalog RBAC.
<DocImage path={require('./static/scope-entity.png')} />
4. **Associate with System Entities**
Systems in Harness IDP are high-level catalog entities used to logically group related components, APIs, and resources. Associating your component with one or more Systems helps organize the catalog and improves visibility. [Learn more about System entities](/docs/internal-developer-portal/catalog/system-entity.md).
Systems in Harness IDP are high-level catalog entities used to logically group related components, APIs, and resources. Associating your component with one or more Systems helps organize the catalog and improves visibility. [Learn more about System entities](/docs/internal-developer-portal/catalog/data-model/system-entity.md).

<DocImage path={require('./static/multiple-system.png')} />

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"label": "Tutorials & Use Cases",
"collapsible": "true",
"collapsed": "true",
"position": 6,
"link": {
"type": "generated-index",
"title": "Information on how to ingest information related to entities in catalog"
},
"customProps": {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Tutorials & Use Cases
description: Learn how to use Harness IDP catalog features through practical tutorials and real-world use cases.
sidebar_position: 1
---

# Tutorials & Use Cases

This section contains practical tutorials and real-world use cases to help you get the most out of Harness IDP's catalog features.

## Available Tutorials

### Catalog Management
- Learn how to create, manage, and organize your software catalog
- Understand entity relationships and system modeling
- Best practices for catalog organization

### Data Ingestion
- [Catalog Ingestion API Tutorial](/docs/internal-developer-portal/catalog/catalog-ingestion/catalog-ingestion-api-tutorial) - Learn how to use APIs to add metadata to your catalog entities

### Integration Use Cases
- Discover how to integrate IDP with your existing tools and workflows
- Examples of common integration patterns
- Troubleshooting guides

## Getting Started

If you're new to Harness IDP, we recommend starting with:

1. **[Understanding the Data Model](/docs/internal-developer-portal/catalog/data-model/data-model.md)** - Learn about the core concepts and entity types
2. **[Managing Your Catalog](/docs/internal-developer-portal/catalog/manage-catalog/manage-catalog.md)** - Create and manage catalog entities
3. **[Catalog YAML Structure](/docs/internal-developer-portal/catalog/catalog-yaml.md)** - Understand the YAML format for defining entities

## Need Help?

If you need assistance with any of these tutorials or have questions about implementing specific use cases, please refer to our documentation or reach out to support.
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ Behind the scenes, Catalog Components are entities backed by CD. This basically
Please note that in a couple of months after **CD based auto-discovery**, every CD service will automatically appear as Catalog Components, so you will not have to create them manually.
:::

Switch to the IDP module, and use “Create” from the sidebar. Choose “Component” and use the following YAML to create the Catalog entities. Go to [Create Catalog Entities](/docs/internal-developer-portal/catalog/manage-catalog.md#creating-entities-idp-20) to learn more.
Switch to the IDP module, and use “Create” from the sidebar. Choose “Component” and use the following YAML to create the Catalog entities. Go to [Create Catalog Entities](/docs/internal-developer-portal/catalog/manage-catalog/manage-catalog.md#creating-entities-idp-20) to learn more.

<details>
<summary>Sample Frontend Component YAML</summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ You can inspect the Workflow YAML in two ways:
## Managing Workflows (IDP 2.0)

### Creating Workflows
With IDP 2.0, we are moving towards a Harness-native Data Model designed for enterprise scale and access control. To learn more about the different changes in the schema, go to [Data Model](/docs/internal-developer-portal/catalog/data-model.md).
With IDP 2.0, we are moving towards a Harness-native Data Model designed for enterprise scale and access control. To learn more about the different changes in the schema, go to [Data Model](/docs/internal-developer-portal/catalog/data-model/data-model.md).

There are two ways for you to add and create a new Workflow in your IDP:
- **Create a Workflow via the Harness IDP UI**: Use the Harness UI to create Workflows directly—no YAML required. This method offers a streamlined, code-free experience for adding entities.
Expand Down
6 changes: 3 additions & 3 deletions docs/internal-developer-portal/get-started/catalog-2o.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Get Started with Catalog
sidebar_position: 3
sidebar_label: Get Started with Catalog
title: Setup Catalog
sidebar_position: 2
sidebar_label: Setup Catalog
redirect_from: /docs/internal-developer-portal/get-started/register-a-new-software-component
---

Expand Down

This file was deleted.

Loading