UDS K3d Environment

Important

This package should only be used for development and testing purposes. It is not intended for production use and all data is overwritten when the package is re-deployed.

This zarf package serves as a universal dev (local & remote) and test environment for testing UDS Core, individual UDS Capabilities, and UDS capabilities aggregated via the UDS CLI. If working with a remote cluster over SSH, you can use SSH port-forwarding to connect:

# Non-standard ports
ssh -N -L 8080:localhost:80 -L 8443:localhost:443 -L 6550:localhost:6550 <your-remote-host>

# Standard ports (requires sudo)
sudo ssh -N -L 80:localhost:80 -L 443:localhost:443 -L 6550:localhost:6550 <your-remote-host>

Note

UDS K3d intentionally does not address airgap concerns for K3d or the load balancer logic deployed in this package. This allows running zarf init or deploying a Zarf Init Package via a UDS Bundle after the UDS K3d environment is deployed.

Prerequisites

• UDS CLI & K3d using the versions specified in the uds-common repo
• Docker or Podman for running K3d

Deploy

uds zarf package deploy oci://defenseunicorns/uds-k3d:0.8.0

Create

This package is published via CI, but can be created locally with the following command:

uds zarf package create

Remove

k3d cluster delete uds (uds is the default cluster name).

Start and Stop

To stop and start an existing UDS K3d cluster gracefully, without disrupting the host.k3d.internal CoreDNS rewrite for *.uds.dev, use the following prior to host hibernation, suspension, restart, or shutoff:

# to stop the default UDS cluster
k3d cluster stop uds

# to start the default UDS cluster
k3d cluster start uds

Additional Info

You can set extra k3d args by setting the deploy-time ZARF_VAR_K3D_EXTRA_ARGS. See below zarf-config.yaml example k3d args:

package:
  deploy:
    set:
      k3d_extra_args: "--k3s-arg --gpus=1 --k3s-arg --<arg2>=<value>"

Configure MinIO

• Configuring Minio

DNS Assumptions

• DNS Assumptions