For the complete documentation index, see llms.txt. This page is also available as Markdown.

Link an external application

Publish an existing external destination in the DataOS catalog using a link Resource.

A Link publishes an existing external destination in the DataOS catalog. It is metadata plus a URL; it does not deploy or operate the destination.

Use a Link for:

  • Existing Superset or Grafana deployments

  • Internal documentation or wikis

  • Externally hosted dashboards

  • SaaS tools

  • Any experience that already has its own runtime and URL

Use an App instead when DataOS must run the container or provide ingress, secrets, OIDC, CORS, rate limits, scaling, metrics, or storage.

Resource envelope

Key
Required
Description

version

Yes

Resource schema version.

type

Yes

Must be link.

name

Yes

Stable machine identifier.

title

Yes

Human-readable title.

description

Yes

Resource-level description.

owner

Yes

Primary resource owner.

tags

No

Resource labels.

spec

Yes

Link-specific configuration.

Key
Required
Description

spec.runAsUser

No

Resource identity where required by the environment.

link.icon

No

Catalog icon URL or data URI.

link.domain

Yes

Business or platform domain.

link.description

Yes

User-facing purpose.

link.owners

Yes

One or more accountable DataOS users.

link.products

No

Associated product identifiers.

link.tags

No

Catalog labels.

link.references

No

Supporting title and url pairs.

link.title

No

Action label; defaults to Open app.

link.url

Yes

Complete external destination URL.

link.visibility

No

Scoped catalog visibility.

Unlike an App Open path, the Link URL remains absolute and is stored as written.

Complete example

Visibility

Global:

Selected tenants:

Tenant pattern:

Visibility controls catalog discovery. Authentication and authorization remain the responsibility of the external destination.

Deploy and verify

Verify that:

  1. The catalog entry is visible to the intended tenants.

  2. Its description, owners, products, tags, and references are correct.

  3. The action opens the exact external URL.

  4. The destination handles authentication and authorization correctly.

Common problems

Symptom
Cause
Resolution

Link creates no Service

Expected behavior

Use an App if DataOS must run software.

Entry is missing for a tenant

Visibility excludes it

Review the visibility object.

Open action goes to the wrong place

Incorrect link.url

Supply the complete external URL.

Users reach the site but cannot sign in

Destination configuration

Fix authentication at the external system.

Last updated

Was this helpful?