Skip to content

Commit 683c1a8

Browse files
authored
Merge pull request #11302 from harness/system-and-sto-update
[IDP] - Update : some link and YAML update of the new features
2 parents 803c835 + 94d5d4a commit 683c1a8

File tree

3 files changed

+78
-6
lines changed

3 files changed

+78
-6
lines changed

docs/internal-developer-portal/catalog/system-entity.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ Use Systems to:
4343
In Harness IDP, a **System** represents a logical grouping of related services, APIs, and resources. Systems help improve catalog visibility, support governance across scopes, and make it easier for teams to discover and manage what they own.
4444

4545
Systems can be created through:
46-
- The **Harness UI/YAML** view
47-
- The **Create Entity API** by mentioning the `kind: System`
46+
- The **[Harness UI](/docs/internal-developer-portal/catalog/manage-catalog#harness-idp-ui)** or **[YAML](/docs/internal-developer-portal/catalog/manage-catalog#catalog-yaml)** view
47+
- The **[Create Entity API](https://apidocs.harness.io/tag/Entities#operation/create-entity)** by mentioning the `kind: System`
4848

4949
They can exist at **Project**, **Organization**, or **Account** scope, based on how broadly you want to apply grouping logic.
5050

@@ -105,7 +105,7 @@ We can edit the **System Layout** under `Admin → Layout → Catalog Entities
105105

106106

107107

108-
The configuration is defined in YAML, for example:
108+
#### The configuration is defined in YAML, for example:
109109

110110
```yaml
111111
page:
@@ -123,6 +123,7 @@ page:
123123
variant: gridItem
124124
gridProps:
125125
md: 6
126+
// highlight-start
126127
- component: EntityCatalogGraphCard
127128
specs:
128129
props:
@@ -131,11 +132,11 @@ page:
131132
gridProps:
132133
md: 6
133134
xs: 12
135+
// highlight-end
134136
- component: EntityScoreCard
135137
specs:
136138
gridProps:
137139
md: 6
138-
// highlight-start
139140
- component: EntityLinksCard
140141
specs:
141142
props:
@@ -144,7 +145,6 @@ page:
144145
gridProps:
145146
md: 6
146147
xs: 12
147-
// highlight-end
148148
- component: CatalogTable
149149
specs:
150150
props:

docs/internal-developer-portal/plugins/available-plugins/harness-native-plugins/sto-integration.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,25 @@ Here, you will see:
304304

305305
This view bridges the gap between high-level visibility and actionable insight.
306306

307+
#### How to Add or Remove the STO Vulnerabilities Card
308+
309+
You can customize whether the STO Vulnerabilities card appears on the entity overview page by modifying the layout configuration in the IDP admin UI.
310+
311+
Navigate to **Layout**, then select the appropriate entity kind (e.g., `component`) and entity type (e.g., `service`). Here, you can add or remove the STO Vulnerabilities card component for the overview tab.
312+
313+
To **add** the STO Vulnerabilities card, include the following in your layout YAML:
314+
315+
```yaml
316+
- component: EntitySecurityIssueCard
317+
specs:
318+
props:
319+
variant: gridItem
320+
height: 400
321+
gridProps:
322+
md: 6
323+
xs: 12
324+
```
325+
307326
<DocImage path={require('./static/sto-vul-summary.png')} />
308327

309328
### Vulnerabilities Tab of Entity View
@@ -344,6 +363,57 @@ To **remove** the tab, simply delete or comment out this section from the layout
344363

345364
The highlighted section in the image above shows the configuration for the Vulnerabilities tab. Once added, developers will see a dedicated tab for STO security findings directly on each service's entity page, making it easy to review and act on vulnerabilities in context.
346365

366+
367+
<details>
368+
<summary>Sample Catalog Layout YAML</summary>
369+
370+
```yaml
371+
page:
372+
name: EntityLayout
373+
tabs:
374+
- name: Overview
375+
path: /
376+
title: Overview
377+
contents:
378+
- component: EntityOrphanWarning
379+
- component: EntityRelationWarning
380+
- component: EntityProcessingErrorsPanel
381+
- component: EntityAboutCard
382+
specs:
383+
props:
384+
variant: gridItem
385+
gridProps:
386+
md: 6
387+
- component: EntityScoreCard
388+
specs:
389+
gridProps:
390+
md: 6
391+
- component: EntityCatalogGraphCard
392+
specs:
393+
props:
394+
variant: gridItem
395+
height: 400
396+
gridProps:
397+
md: 6
398+
xs: 12
399+
// highlight-start
400+
- component: EntitySecurityIssueCard
401+
specs:
402+
props:
403+
variant: gridItem
404+
height: 400
405+
gridProps:
406+
md: 6
407+
xs: 12
408+
- name: EntitySecurityIssueContent
409+
path: /security
410+
title: Vulnerabilities
411+
contents:
412+
- component: EntitySecurityIssueContent
413+
// highlight-end
414+
```
415+
</details>
416+
347417
## Scorecards – Measuring Vulnerability
348418

349419
Harness IDP Scorecards let you track your security posture automatically, using data from STO scans. You can set up custom vulnerability checks—like thresholds on critical vulnerabilities—and see compliance at a glance for all your services.

release-notes/internal-developer-portal.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Harness Internal Developer Portal (IDP) now supports System as a high-level cata
7272

7373
* Systems can be created at Account, Organization, or Project scope.
7474
* Define Systems using the IDP UI, YAML, or the Create Entity API (`kind: System`).
75-
* New default System layout includes tabs for Overview, Entities, Scorecard, and Diagram. Existing customers can apply the provided YAML layout under **Admin → Layout → Catalog Entities → System**.
75+
* New default System layout includes tabs for Overview, Entities, Scorecard, and Diagram. Existing customers can apply the provided [YAML layout](/docs/internal-developer-portal/catalog/system-entity#the-configuration-is-defined-in-yaml-for-example) under **Admin → Layout → Catalog Entities → System**.
7676
![](./static/system-layout.png)
7777
* The Entities tab offers a searchable, filterable, and sortable table of all Components, APIs, and Resources within the System.
7878
* Many-to-many relationships are supported — an entity can belong to multiple Systems.
@@ -118,6 +118,8 @@ metadata:
118118
- java
119119
```
120120
121+
Learn more about [System Entity](/docs/internal-developer-portal/catalog/system-entity)
122+
121123
### [New Feature] Link to Source Code Repository
122124
123125
Harness IDP now supports defining a Link to Source Code Repository for Components, APIs, and Resources in the Software Catalog. This optional field is strongly recommended for Git-based workflows and enables key capabilities such as:

0 commit comments

Comments
 (0)