UDS Reference Package

This repository serves as a practical, working example of a well-structured UDS Package.

Inside the .github directory, you will find a fully runnable Go-based web application that reads and writes to a Postgres database. This repository can be referenced alongside the UDS Documentation, as a reference guide for building, configuring, and testing own UDS packages.

Note

The primary purpose of this repository is to demonstrate UDS Package architecture, layout, and best practices. The application's specific features are secondary.

What This Demonstrates

This repository should aim to provide functional examples of the following:

• Bundle Integration: Pulling dependencies into a UDS Bundle.
• Authentication: Keycloak SSO configuration.
• Observability: Prometheus service monitoring integration.
• Configuration: Helm overrides and UDS Config chart templates.
• Networking & Security: Istio Virtual Service and Network Policy creation.
• Testing: Playwright UI testing.

Prerequisites

This reference package is designed to be deployed on top of UDS Core. Please ensure the following dependencies are configured prior to deployment:

• Postgres Database: The Go application requires a Postgres instance. We recommend bringing this into your bundle/uds-bundle by using the postgres-operator UDS package.
• Monitoring: To successfully demonstrate the monitoring features, you will need to install the k3d-core-demo bundle rather than the k3d-core-slim-dev bundle.

Tip

k3d-core-demo is set as the default k3d bundle if you run uds run default in the root directory.

Quick Start

UDS Tasks (for local dev and CI)

*For local dev, this requires you install uds-cli

The UDS Tasks can be found in the tasks.yaml

Tip

To get a list of tasks to run you can use uds run --list!

Deployment

If you already have UDS Core installed

This will create the package, create the test-bundle, then deploy in the k3d cluster.

uds run dev

If you do not have UDS Core installed

This will stand up the k3d cluster, create the package, create the test-bundle, then deploy in the k3d cluster.

uds run default

Access the WebUI

Once the app is deployed, it can be accessed in the web browser at https://reference-package.uds.dev

Releases

The released packages can be found in ghcr.

Contributing

Please see the CONTRIBUTING.md