UDS Portal

UDS Portal is the landing page for UDS users — a single point of discovery for every application deployed in a UDS environment. It ships as a UDS Core layer that depends on base and identity-authorization.

Apps are derived from UDS Package Custom Resources in the cluster. One tile is created per network.expose entry; a package must also have an sso section or its tiles are not shown. If the sso section includes a groups.anyOf list, only members of those groups see the tiles.

App tiles display the package name as a title and a default logo unless overridden. To customize, set annotations in the Zarf package metadata:

metadata:
  annotations:
    dev.uds.title: My App        # display name shown on the tile
    dev.uds.icon: 'data:image/svg+xml;base64,<base64-encoded-svg>'  # tile logo

If dev.uds.title is absent, the title falls back to a formatted version of the package name (e.g. uds-registry → UDS Registry). If dev.uds.icon is absent, a default logo is shown.

Packages that expose multiple endpoints (e.g. GitLab) can control which ones appear as tiles:

• Expose entries with a wildcard host (e.g. *.pages) are always excluded.
• To hide specific endpoints, set the uds.dev/portal-hide-apps annotation on the Package CR to a comma-separated list of network.expose[].host values:

metadata:
  annotations:
    uds.dev/portal-hide-apps: "registry,pages"

Prerequisites

Install mise to manage development dependencies at the versions pinned in mise.toml, then install the pre-commit hook:

mise install
hk install

uds-cli is required to run tasks.

Development

Spin up a local UDS Core k3d cluster with seed apps:

uds run dev-setup

Deploy portal changes to the running cluster:

uds run dev-deploy

Run the backend and frontend dev servers separately (useful for rapid UI iteration):

uds run dev-server   # Go API with hot-reload on :8080
uds run dev-ui       # Svelte dev server

Building

uds run build:ui           # build Svelte frontend
uds run build:api          # build Go API for local platform
uds run build:container    # build container image (local arch)
uds run build:zarf-package # build Zarf package

Testing

uds run test:unit       # all unit tests (backend + frontend)
uds run test:e2e-setup  # deploy test cluster
uds run test:e2e        # run e2e tests against running cluster

Linting

uds run lint

Authentication Model

UDS Portal runs behind AuthService (from UDS Core), the trust boundary for identity.

• AuthService mints and validates JWTs; the portal does not perform independent JWT signature verification.
• Group claims from the validated Keycloak JWT determine which apps each user can see.

Deploying

For a test deployment:

uds run test:e2e-setup

For local dev clusters, UDS Portal is accessible at https://portal.uds.dev.

For production, UDS Portal is distributed as a UDS Core layer via OCI-hosted Zarf packages at oci://ghcr.io/defenseunicorns/packages/uds.

Contributing

See CONTRIBUTING.md.