Unicorn Delivery Service

https://uds.defenseunicorns.com/
Admin
Unicorn Delivery Service (UDS) is a secure software delivery product designed for National Security...
Tokens:135,233
Snippets:629
Trust Score:8.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### UDS Core Deployment Steps

Source: https://uds.defenseunicorns.com/getting-started/install-and-deploy-uds

A step-by-step guide to deploying UDS Core, including installing the UDS CLI, deploying the UDS bundle, and instructions for cleaning up resources after deployment.

```APIDOC
Deploy UDS Core:
  Step 1: Install the UDS CLI
    - Instructions for installing the command-line interface for UDS.
  Step 2: Deploy the UDS Bundle
    - Steps to deploy the main UDS bundle.
  Step 3: Clean Up
    - Procedures for removing deployed UDS resources.
```

--------------------------------

### UDS CLI Quickstart and Usage

Source: https://uds.defenseunicorns.com/reference/uds-core/functional-layers

Quickstart guide and usage examples for the UDS command-line interface.

```APIDOC
UDS CLI:
  Quickstart and Usage:
    - Provides initial steps and examples for using the UDS CLI.
```

--------------------------------

### Install UDS CLI with Brew

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Installs the UDS CLI by tapping the defenseunicorns/tap repository and then performing a brew install. This is the recommended installation method.

```bash
brewtapdefenseunicorns/tap && brewinstalluds
```

--------------------------------

### Example Package List Output

Source: https://uds.defenseunicorns.com/tutorials/deploy-with-ambient

This output shows the result of `zarf package list`, detailing installed packages like `core-base` with its version and components, `init`, and `podinfo`. It helps confirm the `core-base` package version.

```bash
Package|Version|Components

core|0.42.0| [uds-operator-config prometheus-operator-crds pepr-uds-core istio-controlplane gateway-api-crds istio-admin-gateway istio-tenant-gateway keycloak neuvector loki kube-prometheus-stack vector grafana authservice velero]

init|v0.42.2| [zarf-injector zarf-seed-registry zarf-registry zarf-agent]

uds-k3d|0.14.0| [destroy-cluster create-cluster uds-dev-stack]

podinfo|| [podinfo]
```

--------------------------------

### UDS Tutorials - Deploy with UDS Core

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/truststore-customization

A tutorial guiding users through the process of deploying with UDS Core.

```markdown
## Deploy with UDS Core

This tutorial covers the steps required to deploy applications using UDS Core.
```

--------------------------------

### UDS Bundle Definition Example

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Defines a UDS Bundle named 'example' with a description and version. It specifies two Zarf packages to be deployed: 'init' and 'podinfo', including optional components for the 'init' package.

```yaml
kind: UDSBundle\nmetadata:\n  name: example\n  description: an example UDS bundle\n  version: 0.0.1\npackages:\n  - name: init\n    repository: ghcr.io/defenseunicorns/packages/init\n    ref: v0.33.0\n    optionalComponents:\n      - git-server\n  - name: podinfo\n    repository: ghcr.io/defenseunicorns/uds-cli/podinfo\n    ref: 0.0.1
```

--------------------------------

### UDS Tutorials

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/integration

Guides and tutorials for using UDS, including deployment, integration, and specific features like Istio Ambient Mesh.

```APIDOC
Tutorials:
  Deploy with UDS Core: Step-by-step guide to deployment.
  Integrating an Application with UDS Core: How to integrate applications.
  Adding UDS Configuration to a Zarf Package: Adding UDS config to Zarf packages.
  Use Istio Ambient Mesh: Guide to using Istio Ambient Mesh.
```

--------------------------------

### Install WSL (Windows)

Source: https://uds.defenseunicorns.com/getting-started/basic-requirements

Installs the Windows Subsystem for Linux (WSL) using the `wsl --install` command, which enables WSL, sets WSL 2 as default, and installs the Ubuntu distribution.

```shell
wsl --install
```

--------------------------------

### Install k3d using Homebrew

Source: https://uds.defenseunicorns.com/getting-started/basic-requirements

Installs k3d, a lightweight wrapper for k3s (Rancher Lab's minimal Kubernetes distribution), using the Homebrew package manager.

```shell
brew install k3d
```

--------------------------------

### Install UDS CLI

Source: https://uds.defenseunicorns.com/getting-started/install-and-deploy-uds

Installs the UDS CLI using Homebrew. Ensure Homebrew is installed prior to running this command.

```bash
brew tap defenseunicorns/tap && brew install uds
```

--------------------------------

### UDS CLI Multi-Arch Deployment Example

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Illustrates deploying a specific architecture version of a multi-arch bundle from a remote OCI repository using the `--architecture` flag.

```bash
uds deploy -a amd64 <remote-multi-arch-bundle.tar.zst> --confirm
```

--------------------------------

### UDS Tutorials

Source: https://uds.defenseunicorns.com/reference/uds-core/functional-layers

Guides and tutorials for various UDS functionalities, including deployment, integration, and Istio usage.

```APIDOC
UDS Tutorials:
  Deploy with UDS Core:
    - Step-by-step guide to deploying UDS Core.
  Integrating an Application with UDS Core:
    - How to integrate external applications with UDS Core.
  Adding UDS Configuration to a Zarf Package:
    - Instructions for incorporating UDS configurations into Zarf packages.
  Use Istio Ambient Mesh:
    - Tutorial on utilizing Istio's ambient mesh mode with UDS.
```

--------------------------------

### Example Port-Forward Command

Source: https://uds.defenseunicorns.com/tutorials/deploy-with-uds-core

An example of the port-forward command using a specific service name and local port, based on the previously listed pods and services.

```bash
kubectl port-forward service/podinfo 9898:9898 -n podinfo
```

--------------------------------

### UDS Core Deployment Tutorial

Source: https://uds.defenseunicorns.com/tutorials/deploy-with-uds-core

This tutorial guides users through deploying the UDS Core with a sample application, 'podinfo', as a UDS Bundle. It details the prerequisites and provides steps for creating a Zarf Package for the application.

```Markdown
# Deploy with UDS Core
## Sample Application with UDS Core
This tutorial uses UDS CLI to deploy an example application, podinfo, alongside UDS Core as a UDS Bundle.
### Prerequisites
  * Zarf
  * UDS CLI
  * Docker
  * k3d
### Quickstart
To begin, a Zarf Package needs to be created for `podinfo`. See the Zarf documentation for in-depth information on how to create a Zarf Package, or simply use the information provided below.
```

--------------------------------

### UDS Bundle Deployment Example

Source: https://uds.defenseunicorns.com/reference/uds-core/functional-layers

An example UDS bundle configuration demonstrating the deployment of core functional layers. This YAML defines the bundle's metadata and lists the packages with their respective repositories and references, illustrating the structure for combining layers.

```yaml
kind: UDSBundle

metadata:
  name: functional-layer-core-bundle
  description: An example bundle for deploying all of core using functional layers
  version: "0.1.0"

packages:
  - name: core-base
    repository: ghcr.io/defenseunicorns/packages/uds/core-base
    ref: 0.29.0-upstream
  - name: core-identity-authorization
    repository: ghcr.io/defenseunicorns/packages/uds/core-identity-authorization
    ref: 0.29.0-upstream
  - name: core-metrics-server
    repository: ghcr.io/defenseunicorns/packages/uds/core-metrics-server
    ref: 0.29.0-upstream
  - name: core-runtime-security
    repository: ghcr.io/defenseunicorns/packages/uds/core-runtime-security
    ref: 0.29.0-upstream
  - name: core-logging
    repository: ghcr.io/defenseunicorns/packages/uds/core-logging
    ref: 0.29.0-upstream
  - name: core-monitoring
    repository: ghcr.io/defenseunicorns/packages/uds/core-monitoring
    ref: 0.29.0-upstream
  - name: core-backup-restore
    repository: ghcr.io/defenseunicorns/packages/uds/core-backup-restore
    ref: 0.29.0-upstream
```

--------------------------------

### Configure Homebrew PATH and Install GCC (Linux)

Source: https://uds.defenseunicorns.com/getting-started/basic-requirements

Configures the Homebrew PATH for Linux environments and installs the GCC compiler, which may be a dependency for some tools.

```shell
(echo; echo 'eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"') >>/home/[USERNAME]/.bashrc
```

```shell
sudo apt-get install build-essential
```

```shell
brew install gcc
```

--------------------------------

### UDS CLI Tasks Configuration

Source: https://uds.defenseunicorns.com/tutorials/create-uds-package

This snippet shows the configuration for the `tasks.yaml` file, which includes common setup tasks for UDS Core integration. It references a setup file from the `uds-common` repository.

```yaml
includes:


- common-setup: https://raw.githubusercontent.com/defenseunicorns/uds-common/refs/tags/v0.13.1/tasks/setup.yaml

```

--------------------------------

### UDS CLI Deploy Specific Packages

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Illustrates how to deploy only specific packages within a UDS Bundle by using the `--packages` flag, providing an example of deploying 'init' and 'nginx' packages.

```bash
uds deploy uds-bundle-<name>.tar.zst --packages init,nginx
```

--------------------------------

### Using Zarf Commands via UDS CLI

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Illustrates how to execute Zarf commands through the UDS CLI. This includes examples for creating Zarf packages and using Zarf's airgap tooling.

```bash
uds zarf create <dir>\uds zarf tools <cmd>
```

--------------------------------

### UDS CLI Commands

Source: https://uds.defenseunicorns.com/getting-started/install-and-deploy-uds

This section details the various commands available in the UDS CLI tool. It covers installation, deployment, inspection, logging, monitoring, publishing, pulling, removing, and version checking, along with shell completion commands.

```APIDOC
uds
  - Main UDS CLI command.

uds completion
  - Generates shell completion scripts.
  - Subcommands: bash, fish, zsh

uds create
  - Creates UDS resources.

uds deploy
  - Deploys UDS components or bundles.

uds dev
  - Development-related commands for UDS.
  - Subcommand: deploy

uds inspect
  - Inspects UDS resources.

uds logs
  - Retrieves logs from UDS components.

uds monitor
  - Monitors UDS components.
  - Subcommand: pepr

uds publish
  - Publishes UDS components or bundles.

uds pull
  - Pulls UDS components or bundles.

uds remove
  - Removes UDS components or bundles.

uds run
  - Runs UDS commands or tasks.

uds version
  - Displays the UDS CLI version.
```

--------------------------------

### Deploy k3d-core-demo Bundle

Source: https://uds.defenseunicorns.com/getting-started/install-and-deploy-uds

Deploys the 'k3d-core-demo' bundle to create a local k3d cluster with UDS Core installed. Users can choose to deploy the latest version or a specific version. The `--packages` flag can be used to update only core components.

```bash
uds deploy k3d-core-demo:latest

# deploy this bundle?
y
```

```bash
uds deploy k3d-core-demo:<new-version> --packages core
```

--------------------------------

### Test UDS Core

Source: https://uds.defenseunicorns.com/getting-started/install-and-deploy-uds

Executes a comprehensive test of UDS Core, including cluster creation, UDS Core installation, and CI-equivalent tests. Supports testing specific packages and using Iron Bank images.

```bash
uds run test-uds-core
```

```bash
UDS_PKG=metrics-server uds run test-single-package
```

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

--------------------------------

### Velero CSI Plugin for vSphere

Source: https://uds.defenseunicorns.com/reference/configuration/backup-and-restore/vsphere-rke2-csi

As of Velero v1.14, the velero-plugin-for-csi is included in Velero, eliminating the need for separate installations of velero-plugin-for-csi or velero-plugin-for-vsphere. This section details the setup for using a vSphere CSI driver for volume snapshots within a UDS Core deployment.

```APIDOC
Velero CSI Plugin:
  Included in Velero v1.14+
  No separate installation required for velero-plugin-for-csi or velero-plugin-for-vsphere.

Purpose:
  Enable Velero to use a vSphere CSI driver for volume snapshots of a UDS Core deployment.

Prerequisites:
  - RKE2 Kubernetes cluster (or other distributions with potential additional configuration)
  - Access to vSphere infrastructure
  - UDS Core deployment with Velero configured for S3-compatible object storage
```

--------------------------------

### Install Homebrew (macOS/Linux)

Source: https://uds.defenseunicorns.com/getting-started/basic-requirements

Installs Homebrew, a package manager for macOS and Linux, using a curl script. This is a prerequisite for installing other tools like k3d.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### UDS Core Development Workflow

Source: https://uds.defenseunicorns.com/getting-started/install-and-deploy-uds

Commands for setting up and deploying UDS Core during development, including specific package development with Pepr and metrics-server.

```bash
# Create the dev environment
uds run dev-setup

# If developing the Pepr module:
npx pepr dev

# If not developing the Pepr module (can be run multiple times):
npx pepr deploy

# Deploy the package (can be run multiple times)
uds run dev-deploy --set PKG=metrics-server
```

--------------------------------

### UDS CLI Bundle Deploy Commands

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Shows two ways to deploy a UDS Bundle: from an OCI registry using its path and tag, or from a local filesystem using its tar.zst file.

```bash
uds deploy ghcr.io/defenseunicorns/dev/<name>:<tag>\uds deploy uds-bundle-<name>.tar.zst
```

--------------------------------

### Example Secret Configuration for Pod Reload

Source: https://uds.defenseunicorns.com/reference/deployment/secret-pod-reload

An example of a Kubernetes Secret configured for automatic pod reloading, including labels and annotations for targeting.

```yaml
apiVersion: v1
kind: Secret
metadata:
  name: my-database-credentials
  namespace: my-app
  labels:
    uds.dev/pod-reload: "true"
  annotations:
    uds.dev/pod-reload-selector: 'app=my-app,component=database'
type: Opaque
data:
  username: YWRtaW4=# base64 encoded "admin"
  password: cGFzc3dvcmQxMjM=# base64 encoded "password123"
```

--------------------------------

### UDS Tutorials - Use Istio Ambient Mesh

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/truststore-customization

A tutorial demonstrating how to utilize Istio Ambient Mesh with UDS.

```markdown
## Use Istio Ambient Mesh

Instructions on leveraging Istio's Ambient Mesh capabilities within the UDS framework.
```

--------------------------------

### UDS Tutorials - Integrating an Application with UDS Core

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/truststore-customization

A tutorial on how to integrate external applications with UDS Core.

```markdown
## Integrating an Application with UDS Core

Learn how to connect and manage your applications within the UDS Core environment.
```

--------------------------------

### UDS Core Troubleshooting - Istiod and Pepr Startup Failures

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/truststore-customization

Troubleshooting steps for startup failures related to Istiod and Pepr in UDS Core, often due to webhook dependencies.

```APIDOC
Troubleshooting Istiod and Pepr Startup Failures in UDS Core:
  # Addresses startup issues caused by webhook dependencies.
  # Provides diagnostic steps and solutions for Istiod and Pepr.
```

--------------------------------

### UDS Exemption CR Example

Source: https://uds.defenseunicorns.com/reference/configuration/uds-operator/exemption

An example of a Kubernetes Custom Resource (CR) for UDS policy exemptions. This CR defines policies to be exempted for specific pods within namespaces.

```yaml
apiVersion: uds.dev/v1alpha1
kind: Exemption
metadata:
  name: neuvector
  namespace: uds-policy-exemptions
spec:
  exemptions:
  - policies:
    - DisallowHostNamespaces
    - DisallowPrivileged
    - RequireNonRootUser
    - DropAllCapabilities
    - RestrictHostPathWrite
    - RestrictVolumeTypes
    matcher:
      namespace: neuvector
      name: "^neuvector-enforcer-pod.*"
  - policies:
    - DisallowPrivileged
    - RequireNonRootUser
    - DropAllCapabilities
    - RestrictHostPathWrite
    - RestrictVolumeTypes
    matcher:
      namespace: neuvector
      name: "^neuvector-controller-pod.*"
  - policies:
    - DropAllCapabilities
    matcher:
      namespace: neuvector
      name: "^neuvector-prometheus-exporter-pod.*"
```

--------------------------------

### UDS Package Custom Resource Example

Source: https://uds.defenseunicorns.com/tutorials/add-package-to-bundle

This snippet shows an example of a UDS Package Custom Resource (CR) in YAML format, which is used to define and manage packages within the UDS Operator.

```yaml
apiVersion: uds.dev/v1alpha1
kind: Package
metadata:
  name: podinfo
spec:
  # Package specific configuration details would go here
```

--------------------------------

### Deploy k3d-core-slim-dev Bundle

Source: https://uds.defenseunicorns.com/getting-started/install-and-deploy-uds

Deploys the 'k3d-slim-dev' bundle for working with UDS Core, Istio, Keycloak, and Pepr. Similar to the demo bundle, specific versions can be deployed and updated.

```bash
uds deploy k3d-core-slim-dev:latest
```

```bash
uds deploy k3d-core-slim-dev:<new-version> --packages core-base,core-identity-authorization
```

--------------------------------

### UDS Troubleshooting: Istiod and Pepr Startup Failures

Source: https://uds.defenseunicorns.com/reference/uds-core/functional-layers

Troubleshooting steps for startup failures of Istiod and Pepr due to webhook dependencies in UDS.

```APIDOC
Troubleshooting Istiod and Pepr Startup Failures:
  - Diagnosing and resolving startup issues related to webhook dependencies for Istiod and Pepr.
```

--------------------------------

### UDS Package Secret Templating Example

Source: https://uds.defenseunicorns.com/reference/configuration/single-sign-on/sso-templating

Demonstrates how to customize the rendering of SSO client secrets in UDS packages using the `secretTemplate` property. This example shows raw text templating for client ID and secret.

```YAML
apiVersion: uds.dev/v1alpha1

kind: Package

metadata:
  name: grafana
  namespace: grafana

spec:
  sso:
  - name: My Keycloak Client
    clientId: demo-client
    redirectUris:
    - "https://demo.uds.dev/login"

  # Customize the name of the generated secret
  secretName: my-cool-auth-client

  secretTemplate:
  # Raw text examples
  rawTextClientId: "clientField(clientId)"
  rawTextClientSecret: "clientField(secret)"
```

--------------------------------

### Create VolumeSnapshotClass

Source: https://uds.defenseunicorns.com/reference/configuration/backup-and-restore/vsphere-rke2-csi

Provides an example of a `VolumeSnapshotClass` manifest that needs to be defined to enable Velero to create snapshots using a CSI driver. The example specifies the driver as `csi.vsphere.vmware.com` and sets the `deletionPolicy` to `Retain`.

```yaml
apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: vsphere-csi-snapshot-class
  labels:
    velero.io.csi-volumesnapshot-class: "true"
driver: csi.vsphere.vmware.com
deletionPolicy: Retain
```

--------------------------------

### Check UDS Core Version and Package Details

Source: https://uds.defenseunicorns.com/tutorials/deploy-with-ambient

Verify that your UDS Core installation meets the minimum version requirement (v0.40.0 or higher) for Istio Ambient Mode. This command lists installed packages and their versions.

```bash
zarf package list
```

--------------------------------

### UDS Package CR Example

Source: https://uds.defenseunicorns.com/reference/configuration/uds-operator/package

An example of a UDS Package Custom Resource (CR) manifest. This CR configures network settings, expose rules for Istio VirtualServices, allow rules for NetworkPolicies, and SSO settings including group authentication and protocol mappers.

```YAML
apiVersion: uds.dev/v1alpha1
kind: Package
metadata:
  name: grafana
  namespace: grafana
spec:
  network:
    # Configure Istio Mode: sidecar or ambient
    serviceMesh:
      mode: ambient
  # Expose rules generate Istio VirtualServices and related network policies
  expose:
    - service: grafana
      selector:
        app.kubernetes.io/name: grafana
      host: grafana
      gateway: admin
      port: 80
      targetPort: 3000
  # Allow rules generate NetworkPolicies
  allow:
    - direction: Egress
      selector:
        app.kubernetes.io/name: grafana
      remoteGenerated: Anywhere
    - direction: Egress
      remoteNamespace: monitoring
      remoteSelector:
        app.kubernetes.io/name: alertmanager
      port: 9093
      description: "Alertmanager Datasource"
  # SSO allows for the creation of Keycloak clients and with automatic secret generation and protocolMappers
  sso:
    - name: Grafana Dashboard
      clientId: uds-core-admin-grafana
      redirectUris:
        - "https://grafana.admin.{{ .Values.domain }}/login/generic_oauth"
      groups:
        anyOf:
          - "/UDS Core/Admin"
  # Define protocolMappers to be created as dedicated scopes for the client
  protocolMappers:
    - name: username
      protocol: "openid-connect"
      protocolMapper: "oidc-usermodel-property-mapper"
      config:
        user.attribute: "username"
        claim.name: "username"
        userinfo.token.claim: "true"
    - name: email
      protocol: "openid-connect"
      protocolMapper: "oidc-usermodel-property-mapper"
      config:
        user.attribute: "email"
        claim.name: "email"
        userinfo.token.claim: "true"
```

--------------------------------

### UDS CLI Resume Bundle Deploys

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Explains how to use the `--resume` flag during a bundle deployment to ensure only packages that have not yet been deployed are processed.

```bash
uds deploy uds-bundle-<name>.tar.zst --resume
```

--------------------------------

### UDS CLI Commands

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

This section details the various commands available in the UDS CLI tool. It covers common operations such as creating, deploying, inspecting, logging, monitoring, publishing, pulling, removing, and running UDS components, as well as managing completions for different shells.

```bash
uds
uds completion
uds completion bash
uds completion fish
uds completion zsh
uds create
uds deploy
uds dev
uds dev deploy
uds inspect
uds logs
uds monitor
uds monitor pepr
uds publish
uds pull
uds remove
uds run
uds version
```

--------------------------------

### TLS Certificate Configuration Example

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/integration

This snippet shows an example of how the extracted CA certificate might be configured within a YAML file, specifically for tls_cacert.yaml, which is used by uds-core's gateways. It highlights the importance of correct file placement and potential linting requirements.

```yaml
# Example content for tls_cacert.yaml
# This file should contain the CA certificate content
# Ensure license headers are added if required by linting rules.

```

--------------------------------

### UDS Deployment: Upgrading UDS Core

Source: https://uds.defenseunicorns.com/reference/uds-core/functional-layers

Guidance on upgrading UDS Core installations.

```APIDOC
Deployment:
  Upgrading UDS Core:
    - Step-by-step instructions for upgrading UDS Core.
```

--------------------------------

### SSH Connection Example

Source: https://uds.defenseunicorns.com/reference/configuration/service-mesh/non-http-ingress

Demonstrates how to connect to the exposed service using SSH with the configured external port.

```bash
ssh -p 2022 user@example.uds.dev
```

--------------------------------

### UDS CLI Bundle Create Commands

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Demonstrates two methods for creating UDS Bundles: bundling packages from a directory into an OCI artifact within a registry, or locally onto the filesystem. The `--insecure` flag is mentioned for local registries.

```bash
uds create <dir> -o ghcr.io/defenseunicorns/dev\uds create <dir>
```

--------------------------------

### UDS Tutorials - Adding UDS Configuration to a Zarf Package

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/truststore-customization

A tutorial explaining how to incorporate UDS configuration settings into a Zarf package.

```markdown
## Adding UDS Configuration to a Zarf Package

This guide details the process of embedding UDS configurations into Zarf packages for streamlined deployments.
```

--------------------------------

### Verify Package Status

Source: https://uds.defenseunicorns.com/tutorials/create-uds-package

Command to get the status of the podinfo package, showing SSO clients, endpoints, monitors, and network policies.

```bash
kubectl get package -n podinfo
```

--------------------------------

### UDS CLI Commands

Source: https://uds.defenseunicorns.com/reference/deployment/upgrades

This section details the various commands available in the UDS CLI, including their usage and purpose for managing UDS installations and deployments.

```APIDOC
uds
  - Main UDS CLI command.

uds completion
  - Generate shell completion scripts for the UDS CLI.
  - Subcommands:
    - bash: Generate completion script for Bash.
    - fish: Generate completion script for Fish shell.
    - zsh: Generate completion script for Zsh.

uds create
  - Create UDS resources.

uds deploy
  - Deploy UDS components or configurations.

uds dev
  - Development-related commands for UDS.
  - Subcommands:
    - deploy: Deploy UDS in a development environment.

uds inspect
  - Inspect UDS resources or configurations.

uds logs
  - Retrieve logs from UDS components.

uds monitor
  - Monitor UDS components.
  - Subcommands:
    - pepr: Monitor Pepr-related metrics.

uds publish
  - Publish UDS components or packages.

uds pull
  - Pull UDS components or packages.

uds remove
  - Remove UDS components or configurations.

uds run
  - Run UDS commands or tasks.

uds version
  - Display the UDS CLI version.
```

--------------------------------

### UDS CLI Pre-Deploy View

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Details how to view bundle metadata, packages, overrides, and Zarf variables before deployment by running `uds deploy` without the `--confirm` flag. This aids in troubleshooting and understanding deployment configurations.

```bash
uds deploy <bundle> --confirm
```

--------------------------------

### UDS Registry Overview

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/truststore-customization

An overview of the UDS Registry service.

```markdown
## Registry Overview

Introduction to the UDS Registry service and its functionalities.
```

--------------------------------

### Update and Upgrade Ubuntu Packages (WSL)

Source: https://uds.defenseunicorns.com/getting-started/basic-requirements

Updates the package list and upgrades installed packages within the Ubuntu distribution running on WSL.

```shell
sudo apt update && sudo apt upgrade
```

--------------------------------

### Keycloak Realm Templated Value Example

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/customization

Demonstrates the syntax for using environment variables within Keycloak realm configurations, with a default value provided.

```yaml
${REALM_GOOGLE_IDP_ENABLED:false}
```

--------------------------------

### Manual Recovery Procedure for Istiod and Pepr Startup Failures

Source: https://uds.defenseunicorns.com/reference/troubleshooting/pepr-istiod-webhooks

This section details the steps to manually resolve startup failures for Istiod and Pepr pods caused by webhook dependencies. It involves patching webhooks, restarting pods, and restoring policies.

```APIDOC
Manual Recovery Procedure:
  1. Patch the Pepr Webhooks to Exclude Itself and Istio
    - Description: Modifies Pepr webhook configurations to prevent it from admitting Istio or itself.
  2. Restart the Pepr and Istiod Pods
    - Description: Restarts the affected pods to apply the webhook changes and allow them to start correctly.
  3. Restore the Webhook Policies
    - Description: Ensures that the necessary webhook policies are in place after the pods have restarted.
```

--------------------------------

### Zarf Bundle Variable Override Example

Source: https://uds.defenseunicorns.com/reference/bundles/overrides

Demonstrates how to override variables defined in a Zarf bundle at deploy time using a `uds-config.yaml` file.

```yaml
variables:
  helm-overrides-package:
    UI_COLOR: green
```

--------------------------------

### UDS CLI Version Command

Source: https://uds.defenseunicorns.com/reference/cli/commands/uds_version

Displays the version of the UDS-CLI release that the current binary was built from. This command is useful for verifying the installed CLI version.

```APIDOC
uds version
  Synopsis:
    uds version [flags]
  Description:
    Shows the version of the running UDS-CLI binary.
    Displays the version of the UDS-CLI release that the current binary was built from.
  Options:
    -h, --help   help for version
  SEE ALSO:
    uds - The main UDS CLI command
```

--------------------------------

### Generate and Install Fish Shell Autocompletion for UDS

Source: https://uds.defenseunicorns.com/reference/cli/commands/uds_completion_fish

This snippet shows how to generate the autocompletion script for the fish shell and how to load it for the current session or for all new sessions.

```bash
uds completion fish | source
```

```bash
uds completion fish > ~/.config/fish/completions/uds.fish
```

--------------------------------

### Create UDS Bundle

Source: https://uds.defenseunicorns.com/tutorials/deploy-with-uds-core

Defines a UDS bundle configuration in `uds-bundle.yaml`. This bundle includes a k3d cluster, Zarf init package, UDS Core, and the 'podinfo' application. It also demonstrates how to override variables for specific components like Minio and Keycloak, and how to substitute applications within the bundle.

```yaml
kind: UDSBundle

metadata:
  name: podinfo-bundle
  description: Bundle with k3d, Zarf init, UDS Core, and podinfo.
  version: 0.0.1

packages:
  - name: uds-k3d
    repository: ghcr.io/defenseunicorns/packages/uds-k3d
    ref: 0.14.0
    overrides:
      uds-dev-stack:
        minio:
          variables:
            - name: buckets
              description: "Set Minio Buckets"
              path: buckets
            - name: svcaccts
              description: "Minio Service Accounts"
              path: svcaccts
            - name: users
              description: "Minio Users"
              path: users
            - name: policies
              description: "Minio policies"
              path: policies
  - name: init
    repository: oci://ghcr.io/zarf-dev/packages/init
    ref: v0.42.2
  - name: core
    repository: oci://ghcr.io/defenseunicorns/packages/uds/core
    ref: 0.42.0-upstream

# Set overrides for Keycloak SSO tutorial
overrides:
  keycloak:
    keycloak:
      variables:
        - name: INSECURE_ADMIN_PASSWORD_GENERATION
          description: "Generate an insecure admin password for dev/test"
          path: insecureAdminPasswordGeneration.enabled
          default: "true"
  - name: podinfo
    path: "./"
    ref: 0.0.1
```

```yaml
# Example of substituting 'podinfo' with 'dos-games'
# - name: dos-games
#   repository: oci://defenseunicorns/dos-games
#   ref: 1.0.0
```

--------------------------------

### Deploy UDS Bundle

Source: https://uds.defenseunicorns.com/tutorials/deploy-with-uds-core

Deploys the created UDS bundle to set up the k3d cluster and deploy UDS Core and the 'podinfo' application. The deployment process may take several minutes to complete.

```bash
uds deploy uds-bundle-podinfo-bundle-*-0.0.1.tar.zst --confirm
```

--------------------------------

### Enable Passthrough Gateway in UDS Bundle

Source: https://uds.defenseunicorns.com/reference/configuration/ingress

Example UDS Bundle configuration to enable the Istio Passthrough Gateway. This involves specifying 'istio-passthrough-gateway' under 'optionalComponents'.

```yaml
kind: UDSBundle

metadata:
  name: core-with-passthrough
  description: A UDS example bundle for packaging UDS core with the passthrough gateway enabled
  version: "0.0.1"

packages:
  - name: core
    repository: oci://ghcr.io/defenseunicorns/packages/uds/core
    ref: 0.23.0-upstream

# You must specify the istio-passthrough-gateway as an optionalComponent or else it will not be deployed

optionalComponents:
  - istio-passthrough-gateway

```

--------------------------------

### UDS CLI Zsh Autocompletion Setup

Source: https://uds.defenseunicorns.com/reference/cli/commands/uds_completion_zsh

Instructions for setting up Zsh autocompletion for the UDS CLI. This includes enabling completion in your shell and loading the completion script.

```zsh
echo "autoload -U compinit; compinit" >> ~/.zshrc
```

```zsh
source <(uds completion zsh)
```

```zsh
uds completion zsh > "${fpath[1]}/_uds"
```

```zsh
uds completion zsh > $(brew --prefix)/share/zsh/site-functions/_uds
```

--------------------------------

### UDS CLI Configuration File Structure

Source: https://uds.defenseunicorns.com/reference/cli/quickstart-and-usage

Shows the basic structure of the `uds-config.yaml` file, including global options, package-specific variables, and shared variables.

```yaml
options:
  log_level: debug
  architecture: arm64
  no_log_file: false
  no_progress: false
  uds_cache: /tmp/uds-cache
  tmp_dir: /tmp/tmp_dir
  insecure: false
  oci_concurrency: 3
shared:
  domain: uds.dev
variables:
  my-zarf-package:
    ui_color: green
    UI_MSG: "Hello Unicorn"
  hosts:
  - host: burning.boats
    paths:
    - path: "/"
      pathType: "Prefix"
```

--------------------------------

### Monitor Secret Reload Events

Source: https://uds.defenseunicorns.com/reference/deployment/secret-pod-reload

Use kubectl to get Kubernetes events filtered by the reason 'SecretChanged' to monitor secret update triggers.

```bash
kubectl get events -n<namespace> --field-selectorreason=SecretChanged
```

--------------------------------

### UDS Troubleshooting Common Issues

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/integration

Guidance on troubleshooting common problems encountered with UDS, such as exemption and package updates, and startup failures.

```APIDOC
Troubleshooting:
  Exemption and Package Updates: Issues related to updating exemptions and packages.
  Istiod and Pepr Startup Failures Due to Webhook Dependencies: Resolving startup failures caused by webhook dependencies.
```

--------------------------------

### ServiceMonitor and PodMonitor Configuration

Source: https://uds.defenseunicorns.com/reference/configuration/uds-monitoring-metrics

Examples of ServiceMonitor and PodMonitor custom resources for capturing metrics. These resources are used by the Prometheus operator to discover and scrape metrics endpoints.

```yaml
spec:
  monitor:
    # Example Service Monitor
    - selector: # Selector for the service to monitor
        app: foobar
      portName: metrics # Name of the port to monitor
      targetPort: 1234 # Corresponding target port on the pod/container (for network policy)
      # Optional properties depending on your application
      description: "Metrics" # Add to customize the service monitor name
      kind: ServiceMonitor # optional, kind defaults to service monitor if not specified. PodMonitor is the other valid option.
      podSelector: # Add if pod labels are different than `selector` (for network policy)
        app: barfoo
      path: "/mymetrics" # Add if metrics are exposed on a different path than "/metrics"
      authorization: # Add if authorization is required for the metrics endpoint
        credentials:
          key: "example-key"
          name: "example-secret"
        optional: false
        type: "Bearer"
    # Example Pod Monitor
    - portName: metrics # Name of the port on the pod to monitor
      targetPort: 1234 # Corresponding target port on the pod/container (for network policy)
      selector: # Selector for pod(s) to monitor; note: pod monitors support `podSelector` as well, both options behave the same
        app: barfoo
      kind: PodMonitor
      # Optional properties depending on your application
      description: "Metrics" # Add to customize the pod monitor name
      path: "/mymetrics" # Add if metrics are exposed on a different path than "/metrics"
      authorization: # Add if authorization is required for the metrics endpoint
        credentials:
          key: "example-key"
          name: "example-secret"
        optional: false
        type: "Bearer"
```

--------------------------------

### Apply Podinfo Package and View Resources

Source: https://uds.defenseunicorns.com/tutorials/create-uds-package

Commands to apply the Podinfo `Package` resource and view the resulting Kubernetes resources. This includes checking the package status, pods, Istio VirtualService, and generated NetworkPolicies.

```bash
kubectl apply -f podinfo-package.yaml

kubectl get package -n podinfo

kubectl get pods -n podinfo

kubectl get virtualservice -n podinfo

kubectl get networkpolicy -n podinfo

```

--------------------------------

### UDS Configuration - Single Sign-On Overview

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/truststore-customization

An overview of Single Sign-On (SSO) configuration options within UDS.

```APIDOC
Single Sign-On (SSO) Configuration in UDS:
  # Provides an overview of SSO setup and integration.
  # Covers identity providers and authentication methods.
```

--------------------------------

### UDS CLI Commands Reference

Source: https://uds.defenseunicorns.com/tutorials/deploy-with-uds-core

This section provides a comprehensive list of commands available in the UDS CLI, including their usage and purpose. It covers general commands, completion, creation, deployment, development, inspection, logging, monitoring, publishing, pulling, removal, and version checking.

```APIDOC
uds
  - Main UDS CLI command.

uds completion
  - Generate shell completion scripts.
  uds completion bash
  uds completion fish
  uds completion zsh

uds create
  - Create UDS resources.

uds deploy
  - Deploy UDS resources.

uds dev
  - Development commands for UDS.
  uds dev deploy

uds inspect
  - Inspect UDS resources.

uds logs
  - View logs for UDS components.

uds monitor
  - Monitor UDS components.
  uds monitor pepr

uds publish
  - Publish UDS resources.

uds pull
  - Pull UDS resources.

uds remove
  - Remove UDS resources.

uds run
  - Run UDS commands.

uds version
  - Display UDS CLI version.
```

--------------------------------

### Helm Values Override Example

Source: https://uds.defenseunicorns.com/reference/bundles/overrides

Illustrates overriding specific Helm chart values using a `values.yaml` file within a Zarf bundle override configuration.

```yaml
values.yaml
podAnnotations:
  customAnnotation: "customValue"
```

--------------------------------

### Build UDS Core Image

Source: https://uds.defenseunicorns.com/reference/uds-core/idam/truststore-customization

Command to build the UDS Core development image.

```bash
# build image
udsrundev-build
```

--------------------------------

### Keycloak Azure Entra Identity Provider Setup - Admin Credentials

Source: https://uds.defenseunicorns.com/reference/configuration/single-sign-on/identity-providers/azure-idp

Details on accessing the Keycloak Admin UI and retrieving admin credentials based on deployment configuration.

```APIDOC
Keycloak Admin UI:
  URL: keycloak.<admin_domain>

Admin Credentials:
  If INSECURE_ADMIN_PASSWORD_GENERATION is set:
    Username: admin
    Password: Kubernetes secret 'keycloak-admin-password'
  If INSECURE_ADMIN_PASSWORD_GENERATION is NOT set:
    Use 'zarf connect keycloak' to register a temporary admin user.
```

--------------------------------

### UDS Create Command Options

Source: https://uds.defenseunicorns.com/reference/cli/commands/uds_create

This section details the various options available for the 'uds create' command, including flags for confirmation, specifying bundle name, output location, signing keys, and version.

```bash
-c, --confirm                       Confirm bundle creation without prompting

-h, --help                          help for create

-n, --name string                   Specify the name of the bundle

-o, --output string                 Specify the output (an oci:// URL) for the created bundle

-k, --signing-key string            Path to private key file for signing bundles

-p, --signing-key-password string   Password to the private key file used for signing bundles

-v, --version string                Specify the version of the bundle
```
Tokens:
Raw