Unicorn Delivery Service - Core (UDS Core)

Warning

UDS Core is in early alpha and is not ready for general use.

UDS Core groups foundational Unicorn Delivery Service applications inspired by Big Bang.

The core applications are:

• Authservice - Authorization
• Grafana - Monitoring
• Istio - Service Mesh
• KeyCloak - Identity & Access Management
• Kiali - Service Mesh Observability
• Loki - Log Aggregation
• Metrics Server - Metrics
• Neuvector - Container Security
• Pepr - UDS policy engine & operator
• Prometheus Stack - Monitoring
• Promtail - Log Aggregation
• Tempo - Tracing
• Velero - Backup & Restore

Prerequisites

Dependency	Minimum Version
Zarf	0.32.1
UDS CLI	0.6.1
NodeJS	LTS or Current

Users

Quickstart

A common need is bootstrapping a new UDS Core environment for development or testing. The commands below will deploy the latest version of UDS Core. See the remaining sections for more details on the different bundles and packages available.

# ARM version
uds deploy oci://ghcr.io/defenseunicorns/packages/uds/bundles/upstream/k3d-core:arm64

# AMD version
uds deploy oci://ghcr.io/defenseunicorns/packages/uds/bundles/upstream/k3d-core:amd64

The bundle includes the uds.dev certs by default. You can use the UDS environment variables to override the default values. E.g.

# Set environment variables with the contents of your certificate and key files (must be base64 encoded)
UDS_ADMIN_TLS_CERT=$(cat admin.crt)
UDS_ADMIN_TLS_KEY=$(cat admin.key)
UDS_TENANT_TLS_CERT=$(cat tenant.crt)
UDS_TENANT_TLS_KEY=$(cat tenant.key)

UDS_DOMAIN=example.com

uds deploy oci://ghcr.io/defenseunicorns/package/uds/bundles/upstream/k3d-core:amd64

Note: In order to deploy using Iron Bank images, update the registry path replaceing upstream with registry1 For example:

# ARM version
uds deploy oci://ghcr.io/defenseunicorns/packages/uds/bundles/registry1/k3d-core:arm64

UDS Core Packages

UDS core publishes two packages:

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

• core-istio: The UDS Core Istio package that only deploys Istio.

UDS Core Bundles

These bundles are intended for bootstrapping common development & testing environments and should not be used for production. 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 the 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.

Create, build, and test the UDS Core Package

uds run test-uds-core

Working with an individual package

The individual packages that make up UDS Core are broken down in src/, the commands below can be used to work with them individually in development.

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

UDS_PKG=neuvector uds run test-single-package

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

UDS_PKG=neuvector uds run create-single-package

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

UDS_PKG=neuvector uds run deploy-single-package

To test a single package already deployed (e.g. Neuvector)

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

Note: The run tasks above default to targetting the upstream (oss) package flavor. In order to run any of the above commands against the registry1 flavor the command must be updated with --set FLAVOR=registry1 For example:

uds run test-uds-core --set FLAVOR=registry1