Skip to main content

Internal Developer Portal FAQs

How do I use git based data-sources in a scorecard to evaluate a repository/file that is not present in the source-location path?​

Users can use the additional annotation harnessData in their catalog-info.yaml and add the path that they want to evaluate in relative to the source-location of the software component which can further be used as an input variable. for eg., if the source location mentioned is https://github.com/harness/developer-hub and the path added is /src/service-name/file-name.extenstion(adding the leading slash /src is required) then the final path would be https://github.com/harness/developer-hub/src/service-name/file-name.extenstion.

Can I use .md files as a doc?​

Yes we support markdown files in docs, but only if they are present in mkdocs format with a mkdocs.yaml present in the directory.

I have registered a new template but it doesn't show up on my workflows page.​

It usually takes 3-5 minutes for IDP to process the entity before it's available to use in the workflows. You can check about failed or processing entities using the devtools plugin.

Failed to register Software Components​

If, after registering an entity, your're unable to find the same in your catalog, check the Devtools Plugin for Unprocessed Entities. If it's under the Pending tab, wait a few minutes for registration to complete. If it's under the Failed tab. try re-registering the entity.

Can we currently use RBAC to only show workflows to specific usergroups?​

We're already inheriting the pipeline's permission for the workflows. So if only a specific set of users, groups or roles are added the project where the pipeline lives, only they will be able to trigger the workflow. However, they will still see the workflow on IDP.

What are the supported annotations for CI/CD plugins?​

We only support harness.io/pipelines and harness.io/services annotations at present, previously supported annotations like harness.io/serviceid and harness.io/project-url are deprecated, also the annotations should be provided as a key value pair as given in the example below label: pipeline URL to avoid the Failed to construct URL: Invalid URL error.

harness.io/pipelines: |
    labelA: <harness_pipeline_url>

How can we import teams to Harness IDP from third-party applications?​

The teams/groups in Harness IDP are the same as the platform user groups which can be setup today to sync from third party sources using the SCIM protocol.

As a user how can I rid of Catalog entities for which there is no valid YAML file location a.k.a orphaned entities?​

During onboarding into IDP we mass onboard all the services using a catalog-info.yaml for each of them and add it to the catalog as an entity. But when we get rid of multiple of those services together or the location where we stored the catalog-info.yaml changes for multiple of these entities, it becomes a daunting task to delete all of these entities individually. To make it easy for users we recommend you to use the catalog deletion API to get rid of such entities.

  1. Use Catalog Entities Delete API.

  2. In case the entities are already orphaned, you can use the metadata.uid to delete them.

  3. In some cases the entities get into the hasError state. You can know whether the entity is in orphaned state or hasError state, by checking for the Processing Status dropdown on the Catalog page

  4. Additionally, here is an example script that finds and delete all the entities that has NotFoundError, because the source-location for these entities are no more valid (YAML files moved or renamed).