From f4a496f69c505a2b541fe27589aae7e5cd3d223c Mon Sep 17 00:00:00 2001 From: Shibam Dhar Date: Wed, 16 Jul 2025 11:43:44 +0530 Subject: [PATCH 1/2] identifier rules added the link to guidelines for identifier creation at suitable places --- docs/internal-developer-portal/catalog/catalog-yaml.md | 2 +- docs/internal-developer-portal/catalog/manage-catalog.md | 4 ++-- docs/internal-developer-portal/flows/harness-pipeline.md | 1 + docs/internal-developer-portal/flows/manage-workflow-2o.md | 2 +- docs/internal-developer-portal/get-started/catalog-2o.md | 5 +++++ 5 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/internal-developer-portal/catalog/catalog-yaml.md b/docs/internal-developer-portal/catalog/catalog-yaml.md index b9d9286b621..ee95e3c0bd1 100644 --- a/docs/internal-developer-portal/catalog/catalog-yaml.md +++ b/docs/internal-developer-portal/catalog/catalog-yaml.md @@ -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** | |------------------------|-------------------------------------------------------------------------------------------------------| diff --git a/docs/internal-developer-portal/catalog/manage-catalog.md b/docs/internal-developer-portal/catalog/manage-catalog.md index 8df7d2e2355..b9c0c15b854 100644 --- a/docs/internal-developer-portal/catalog/manage-catalog.md +++ b/docs/internal-developer-portal/catalog/manage-catalog.md @@ -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) ::: @@ -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) ::: diff --git a/docs/internal-developer-portal/flows/harness-pipeline.md b/docs/internal-developer-portal/flows/harness-pipeline.md index fd5108c8640..1cf28c9f273 100644 --- a/docs/internal-developer-portal/flows/harness-pipeline.md +++ b/docs/internal-developer-portal/flows/harness-pipeline.md @@ -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. diff --git a/docs/internal-developer-portal/flows/manage-workflow-2o.md b/docs/internal-developer-portal/flows/manage-workflow-2o.md index 4cf6019e63c..f30f9f0d531 100644 --- a/docs/internal-developer-portal/flows/manage-workflow-2o.md +++ b/docs/internal-developer-portal/flows/manage-workflow-2o.md @@ -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. diff --git a/docs/internal-developer-portal/get-started/catalog-2o.md b/docs/internal-developer-portal/get-started/catalog-2o.md index 0a339de0517..f91a4bb6dd5 100644 --- a/docs/internal-developer-portal/get-started/catalog-2o.md +++ b/docs/internal-developer-portal/get-started/catalog-2o.md @@ -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. + @@ -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**. From 28b78ff47c1390c5d468d109d2974557d196efa0 Mon Sep 17 00:00:00 2001 From: Shibam Dhar Date: Wed, 16 Jul 2025 14:43:29 +0530 Subject: [PATCH 2/2] Update 2-0-overview-and-upgrade-path.md --- .../idp-2o-overview/2-0-overview-and-upgrade-path.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/internal-developer-portal/idp-2o-overview/2-0-overview-and-upgrade-path.md b/docs/internal-developer-portal/idp-2o-overview/2-0-overview-and-upgrade-path.md index 06fc8043c16..4ed421fc6fe 100644 --- a/docs/internal-developer-portal/idp-2o-overview/2-0-overview-and-upgrade-path.md +++ b/docs/internal-developer-portal/idp-2o-overview/2-0-overview-and-upgrade-path.md @@ -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. :::