uds-core monorepo

[!WARNING]
uds-core is in early alpha and is not ready for general consumption.

The UDS Core Bundle groups foundational Unicorn Delivery Service applications that are heavily influence by PlatformOne's Big Bang.

The core applications are:

• Authservice
• Grafana
• Istio
• KeyCloak
• Kiali
• Kyverno
• Loki
• Metrics Server
• Neuvector
• Prometheus
• Promtail
• Tempo
• Velero

Prerequisites

Users

Quickstart

A common need is bootrapping a new UDS Core environment for development or testing. The command below will deploy a local K3d cluster with UDS Core on a Mac M1. See the remaining sections for more details if the different bundles & capabilities available.

uds deploy oci://ghcr.io/defenseunicorns/packages/uds/bundles/k3d-core:0.1.3-arm64

The bundle includes the uds.dev certs by default. To use custom certs, you can set the appropriate env variables and run

npx ts-node bundles/tls-certs.ts

UDS Core Capabilities

UDS core publishes two capabilities:

• core: The standard UDS Core capability that is a collection of individual capabilities that are deployed as a single unit.

• core-istio: The UDS Core Istio capability that is a collection of individual capabilities that are deployed as a single unit.

UDS Core Bundles

Thes bundles are intended for boostrapping common development & testing environments and should not be used for produciton. They also serve as examples to create custom bundles.

• k3d-core: A bundle to create a local k3d cluster with UDS Core installed.

• k3d-core-istio: A bundle to create a local k3d cluster with only Istio from UDS Core installed.

Development: Create, build, and test UDS Core Package

For complete testing, we test against a UDS Bundle that uses a locally-built Zarf package. Manually testing against the packages found under /packages is also possible using the zarf command.

uds run -f tasks/test.yaml uds-core

Working with an individual capability

Create, build, and test a single Capability (e.g. Neuvector)

CAPABILITY=neuvector uds run -f tasks/test.yaml single-capability

To build a single capability (e.g. Neuvector)

CAPABILITY=neuvector uds run -f tasks/create.yaml single-capability

To deploy a single built capability (e.g. Neuvector)

CAPABILITY=neuvector uds run -f tasks/deploy.yaml single-capability

To test a single capability (e.g. Neuvector)

uds run -f capabilities/neuvector/tasks/validate.yaml run