uds-cli

command module

v0.11.1 Latest Latest Go to latest Published: Jun 10, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/defenseunicorns/uds-cli

Links

Open Source Insights

README ¶

UDS-CLI

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/cli

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.

Documentation ¶

Overview ¶

Package main is the entrypoint for the uds binary.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
src
cmd Package cmd contains the CLI commands for UDS.	Package cmd contains the CLI commands for UDS.
config Package config contains configuration strings for UDS-CLI	Package config contains configuration strings for UDS-CLI
config/lang Package lang contains the language strings in english used by UDS	Package lang contains the language strings in english used by UDS
pkg/bundle Package bundle contains functions for interacting with, managing and deploying UDS packages	Package bundle contains functions for interacting with, managing and deploying UDS packages
pkg/bundler Package bundler defines behavior for bundling packages	Package bundler defines behavior for bundling packages
pkg/bundler/fetcher Package fetcher contains functionality to fetch local and remote Zarf pkgs for local bundling	Package fetcher contains functionality to fetch local and remote Zarf pkgs for local bundling
pkg/bundler/pusher Package pusher contains functionality to push Zarf pkgs to remote bundles	Package pusher contains functionality to push Zarf pkgs to remote bundles
pkg/cache Package cache provides a primitive cache mechanism for bundle layers	Package cache provides a primitive cache mechanism for bundle layers
pkg/sources Package sources contains Zarf packager sources	Package sources contains Zarf packager sources
pkg/utils Package utils provides utility fns for UDS-CLI	Package utils provides utility fns for UDS-CLI
pkg/utils/boci Package boci (bundle OCI) provides OCI utility functions for bundles	Package boci (bundle OCI) provides OCI utility functions for bundles
test Package test contains e2e tests for UDS	Package test contains e2e tests for UDS
types Package types contains all the types used by UDS.	Package types contains all the types used by UDS.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL