Install and Deploy UDS (15m)

Getting Started with UDS Bundles

UDS Core provides published bundles that serve multiple purposes: you can utilize them for experimenting with UDS Core or for UDS Package development when you only require specific components of UDS Core. These bundles leverage UDS K3d to establish a local k3d cluster.

UDS Bundles deployed for development and testing purposes are comprised of a shared configuration that equips users with essential tools, emulating a development environment for convenience. If deploying to a production environment, users have the ability to modify variables and configurations to best fit specific mission needs by creating their own bundle.

Danger

These UDS Bundles are designed specifically for development and testing environments and are not intended for production use. Additionally, they serve as examples for creating customized bundles.

For additional information on UDS Bundles, please see the UDS Bundles reference.

Deploy UDS Core

In this section, you will deploy UDS Core for the first time.

Step 1: Install the UDS CLI

The very first step is installation of the UDS CLI. Having installed Homebrew previously, you can do so with the following command:

brew tap defenseunicorns/tap && brew install uds

Tip

You can see all releases of the UDS CLI on the UDS CLI GitHub repository

Step 2: Deploy the UDS Bundle

The UDS Bundle being deployed in this example is the k3d-core-demo bundle, which creates a local k3d cluster with UDS Core installed.

To deploy this bundle, run the uds deploy k3d-core-demo:latest command in the terminal:

uds deploy k3d-core-demo:latest

# deploy this bundle?
y

Note

You can also deploy a specific version of the bundle, see all versions of the bundle here.

If you deploy a specific version and want to update UDS Core on top of your existing cluster, you can use the --packages flag to deploy just core (rather than redeploying the full cluster as well): uds deploy k3d-core-demo:<new-version> --packages core.

Optional:

Use the following command to visualize resources in the cluster via k9s:

uds zarf tools monitor

Step 3: Clean Up

Use the following command to tear down the k3d cluster:

k3d cluster delete uds

If you opted to use Colima, use the following command to tear down the virtual machine that the cluster was running on:

colima delete -f