README
¶
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:
If building locally:
Go >= 1.22.0Node >= 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)
- clone this repo
- compile:
uds run compile - 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:
-
Frontend:
-
Networking:
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
src
|
|
|
pkg/api/docs
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
|
pkg/config
Package config contains configuration for the application.
|
Package config contains configuration for the application. |
|
pkg/pepr
Package pepr contains the logic monitoring Pepr operations in a UDS Cluster
|
Package pepr contains the logic monitoring Pepr operations in a UDS Cluster |
|
pkg/stream
Package stream contains the logic for streaming logs from from UDS Core
|
Package stream contains the logic for streaming logs from from UDS Core |
|
pkg/style
Package style contains the styles for the UDS CLI and UDS Runtime streaming output.
|
Package style contains the styles for the UDS CLI and UDS Runtime streaming output. |