uds-runtime

command module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

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.0
  • Node >= v21.1.0
In Cluster

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

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

*See all tags

Locally (Out of Cluster)
  1. clone this repo
  2. compile: uds run compile
  3. run: ./build/main

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 deploy ghcr.io/defenseunicorns/packages/uds/uds-runtime:nightly-unstable

Tech Stack

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
api
api/auth
Package auth provides an endpoint for authenticating against the runtime server.
Package auth provides an endpoint for authenticating against the runtime server.
api/docs
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
k8s
SPDX-License-Identifier: Apache-2.0 SPDX-FileCopyrightText: 2024-Present The UDS Authors Package k8s contains k8s client logic
SPDX-License-Identifier: Apache-2.0 SPDX-FileCopyrightText: 2024-Present The UDS Authors Package k8s contains k8s client logic
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
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
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL