UDS Runtime

UDS Runtime is the frontend for all things UDS, providing views and insights into your UDS cluster.

Quickstart Deploy

!WARNING
UDS Runtime is in early alpha, expect breaking changes to functionality

Pre-requisites

Recommended:

• UDS-CLI

If building locally:

• Go >= 1.22.0
• Node >= v21.1.0

In Cluster

Assumes a K8s cluster is running and the appropriate K8s context has been selected

uds zarf package deploy oci://ghcr.io/defenseunicorns/packages/uds/uds-runtime:<tag> --confirm

*See all tags

Resource Requirements

When running in cluster, the Runtime pod will need more or less resources based on the number of resources in the cluster it will be watching. The current defaults work for a cluster running mainly UDS Core (about 44 pods). For running in larger clusters, UDS Core + SWF + Leapfrog for example (150+ pods), the resource.limits.memory will need to be more like 2Gi.

Locally (Out of Cluster)

1. clone this repo
2. compile: uds run compile
3. run: ./build/uds-runtime

Quickstart Development

For a full guide on developing for UDS Runtime, please read the CONTRIBUTING.md

To start the backend development server, run the following command:

With UDS-CLI

uds run dev-server

Without UDS-CLI

air

NOTE: If you do not have air installed, you can find instructions for how to install at here

To start the frontend server, run the following command:

With UDS-CLI

uds run dev-ui

Wihtout UDS-CLI

cd ui
npm ci
npm run dev

Nightly Releases

UDS Runtime publishes a canary release of latest changes every night tagged nightly-unstable

uds zarf package deploy oci://ghcr.io/defenseunicorns/packages/uds/uds-runtime:nightly-unstable

Tech Stack

• Backend:

  • Golang
  • Chi HTTP Router
  • K8s client-go

• Frontend:

  • Sveltekit
  • Vite
  • Typescript
  • TailwindCSS (Flowbite)
  • Carbon Icons
  • svelte-apexcharts

• Networking:

  • Server Sent Events
  • REST API
  • K8s Shared Informers