Skip to content

Latest commit

 

History

History
41 lines (34 loc) · 1.89 KB

README.md

File metadata and controls

41 lines (34 loc) · 1.89 KB
Raw

UDS-CLI

Latest Release Go version Build Status OpenSSF Scorecard

Install

Recommended installation method is with Brew:

brew tap defenseunicorns/tap && brew install uds

UDS CLI binaries are also included with each Github Release

Official Documentation

Official documentation is located at uds.defenseunicorns.com/reference/cli/overview/

Quickstart

UDS-CLI provides a mechanism to bundle and deploy multiple, independent Zarf packages. To create a UDSBundle of Zarf packages, create a uds-bundle.yaml file like so:

kind: UDSBundle
metadata:
  name: example
  description: an example UDS bundle
  version: 0.0.1

packages:
  - name: init
    repository: ghcr.io/defenseunicorns/packages/init
    ref: v0.33.0
    optionalComponents:
      - git-server
  - name: podinfo
    repository: ghcr.io/defenseunicorns/uds-cli/podinfo
    ref: 0.0.1

Running uds create in the same directory as the above uds-bundle.yaml will create a bundle tarball containing both the Zarf init package and podinfo. The bundle can be deployed with uds deploy.

Contributing

Build instructions and contributing docs are located in CONTRIBUTING.md.