Skip to content

[IDP] - identifier rules #10924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 21, 2025
Merged
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
2 changes: 1 addition & 1 deletion docs/internal-developer-portal/catalog/catalog-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Each kind represents a different type of entity within the Harness-native data m

### `identifier`

The `identifier` field is a **unique, machine-readable** reference for the entity. It serves as the primary key for identifying and interacting with the entity.
The `identifier` field is a **unique, machine-readable** reference for the entity. It serves as the primary key for identifying and interacting with the entity. Ensure your `identifier` follows [naming rules](https://developer.harness.io/docs/platform/references/entity-identifier-reference/#identifier-naming-rules). Invalid identifiers may lead to entity registration errors.

| **Property** | **Description** |
|------------------------|-------------------------------------------------------------------------------------------------------|
Expand Down
4 changes: 2 additions & 2 deletions docs/internal-developer-portal/catalog/manage-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ To create a new entity, navigate to the Harness IDP portal and click on **“Cre

:::info
**YAML validation** is performed to ensure compatibility with the **Harness-native Catalog YAML** model. Any errors will be shown in the Validation logs.

Ensure your `identifier` follows [naming rules](https://developer.harness.io/docs/platform/references/entity-identifier-reference/#identifier-naming-rules). Invalid identifiers may lead to entity registration errors.
![](./static/yaml-validation.png)
:::

Expand Down Expand Up @@ -98,7 +98,7 @@ You can also use the [Catalog YAML](/docs/internal-developer-portal/catalog/cata
![](./static/yaml-conversion.png)

:::info
Note: **YAML validation** is automatically performed to ensure compatibility with the **Harness-native Catalog YAML model**. Any validation errors will be displayed in the Validation Logs.
Note: **YAML validation** is automatically performed to ensure compatibility with the **Harness-native Catalog YAML model**. Any validation errors will be displayed in the Validation Logs. Ensure your `identifier` follows [naming rules](https://developer.harness.io/docs/platform/references/entity-identifier-reference/#identifier-naming-rules). Invalid identifiers may lead to entity registration errors.
![](./static/yaml-validation.png)
:::

Expand Down
1 change: 1 addition & 0 deletions docs/internal-developer-portal/flows/harness-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,7 @@ spec:
owner: test
lifecycle: experimental
```
> Ensure your `identifier` follows [naming rules](https://developer.harness.io/docs/platform/references/entity-identifier-reference/#identifier-naming-rules). Invalid identifiers may lead to entity registration errors.

</TabItem>
<TabItem value="YAML" label="YAML">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Let's try creating a **Workflow** using both the methods:
![](./static/workflow-yaml.png)

:::info
**Note:** **YAML validation** is performed to ensure compatibility with the **Harness-native Data Model**. Any errors will be shown in the Validation logs.
**YAML validation** is performed to ensure compatibility with the **Harness-native Data Model**. Any errors will be shown in the Validation logs. Ensure your `identifier` follows [naming rules](https://developer.harness.io/docs/platform/references/entity-identifier-reference/#identifier-naming-rules). Invalid identifiers may lead to entity registration errors.
:::

6. Once everything is set, click **“Create Workflow”** to finalize and create the Workflow.
Expand Down
5 changes: 5 additions & 0 deletions docs/internal-developer-portal/get-started/catalog-2o.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ To create a **Component** via the UI:

![](./static/yaml-view.png)

> ⚠️ **Note:** Ensure your `identifier` follows [naming rules](https://developer.harness.io/docs/platform/references/entity-identifier-reference/#identifier-naming-rules). Invalid identifiers may lead to entity registration errors.

</TabItem>

<TabItem value="YAML" label="Catalog YAML">
Expand All @@ -87,8 +89,11 @@ To create a Component using Catalog YAML:
2. In the **Visual View**, switch to **YAML View** via the toggle at the top.
![](./static/yaml-way.png)
3. Paste your existing Backstage YAML if available. Harness will auto-convert it into the native format.

![](./static/yaml-conversion.png)

> ⚠️ **Note:** Ensure your `identifier` follows [naming rules](https://developer.harness.io/docs/platform/references/entity-identifier-reference/#identifier-naming-rules). Invalid identifiers may lead to entity registration errors.

4. Define the **scope** of the entity in two ways: either switch to the Visual View and select the desired scope, or specify the **[projectIdentifier](/docs/internal-developer-portal/catalog/catalog-yaml.md#projectidentifier)** or **[orgIdentifier](/docs/internal-developer-portal/catalog/catalog-yaml.md#orgidentifier)** directly in the YAML to set the project or organization scope.
![](./static/scope-entity.png)
5) Add any plugin configurations by including the relevant **annotations**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,10 @@ This approach is no longer supported in IDP 2.0. To align with the Harness platf

This change ensures better alignment with GitX workflows and simplifies entity lifecycle management.

> NOTE: This update also impacts the Git Experience documentation and onboarding flows. Ensure each service or entity has its own entity YAML file.
> NOTE: This update also impacts the Git Experience documentation and onboarding flows. Ensure each service or entity has its own entity YAML file. Ensure your `identifier` follows [naming rules](https://developer.harness.io/docs/platform/references/entity-identifier-reference/#identifier-naming-rules). Invalid identifiers may lead to entity registration errors.

:::note
Identifiers must use only letters, numbers, and underscores. Hyphens and special characters aren’t allowed.
Identifiers must use only letters, numbers, and underscores. Hyphens and special characters aren’t allowed.

:::

Expand Down