Skip to content

Update entity_types.md #30595

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.

Sign up for GitHub

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Update entity_types.md #30595

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a953f87
Update entity_types.md
dgreen15 Jul 21, 2025
f6c68ca
Update entity_types.md
dgreen15 Jul 21, 2025
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
44 changes: 44 additions & 0 deletions content/en/internal_developer_portal/software_catalog/entity_model/entity_types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,50 @@

{{% /tab %}}

{{% tab "Frontend" %}}
In Software Catalog, a frontend (`kind:frontend`) represents a frontend application—such as a browser-based SPA or mobile app—that interacts with services and APIs. Frontend entities offer a structured way to model user-facing applications in the same catalog alongside backend services.

### Example YAML definitions

Check warning on line 407 in content/en/internal_developer_portal/software_catalog/entity_model/entity_types.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.headings 

'Example YAML definitions' should use sentence-style capitalization.
```
apiVersion: v3
kind: frontend
metadata:
name: "checkout-webapp"
displayName: "Checkout Web App"
description: Main frontend experience for the checkout flow in Shopist
owner: shopist-frontend
additionalOwners:
- name: ux-platform-team
type: team
links:
- name: "UX Design Guidelines"
type: doc
url: https://wiki.internal/checkout-design
- name: "Frontend Source Code"
type: repo
provider: github
url: https://github.com/shopist/checkout-webapp
spec:
type: browser
lifecycle: production
tier: tier1
dependsOn:
- service:checkout-api
- service:payment-service
componentOf:
- system:shopist-checkout-platform
```

When this definition is created:

1. The frontend app appears under the Frontend Apps section in Software Catalog.
2. If a RUM application exists with the same name, its telemetry is automatically linked.
3. The entity aggregates metadata, dependencies, and real-time RUM performance metrics in a unified view.

**Note:** This separation improves observability by clarifying the role of frontend applications and enables more targeted performance monitoring and scorecarding.

{{% /tab %}}

{{% tab "Custom entities" %}}

You can define custom entity types beyond service, system, datastore, queue, and API. Custom entities allow you to represent any component or resource that is important to your organization but does not fit into the standard categories.
Expand Down
Loading