CLI Reference

yoke

What is it?
yoke is a helm inspired infrastructure-as-code (IaC) package deployer.

What does it do?
Deploys "yoke flights" to a kubernetes cluster.

Available commands:
takeoff   (aliases: up, apply)
descent   (aliases: down, restore)
mayday    (aliases: delete)
blackbox  (aliases: inspect)
version

Global Flags
  -kubeconfig string
        path to kube config
  -verbose
        verbose output mode

yoke takeoff

Usage:
  yoke takeoff [flags] <release-name> <flight-path>

Aliases:
  apply, up

Examples:
  # deploy a local flight
  yoke takeoff my-release ./main.wasm

  # gzipped wasm files are supported
  yoke takeoff my-release ./main.wasm.gz

  # deploy a remote flight
  yoke takeoff my-release https://github.com/my_org/infra/releases/v1.2.3-release.wasm

  # deploy passing arguments to the flight
  yoke takeoff my-release ./main.wasm -- -env prod

  # deploy passing data over stdin to the flight
  yoke takeoff my-release ./main.wasm < input.file

  # omit the wasm asset and stdin is interpreted as the desired output of your flight
  yoke takeoff my-release < resources.json

  # deploy resources from a unix pipe
  generate-resources.sh | yoke takeoff my-releae

Flags:
  -force-conflicts
        force apply changes on field manager conflicts
  -kubeconfig string
        path to kube config
  -namespace string
        preferred namespace for resources if they do not define one (default "default")
  -out string
        if present outputs flight resources to directory specified, if out is - outputs to standard out
  -skip-dry-run
        disables running dry run to resources before applying them
  -test-run
        test-run executes the underlying wasm and outputs it to stdout but does not apply any resources to the cluster
  -verbose
        verbose output mode

yoke descent

Usage:
  yoke decent [flags] <release-name> <revision-id>

Aliases:
  down, restore

Examples:
  # restore state to revision history 42
  yoke descent my-release 42

Flags:
  -kubeconfig string
        path to kube config
  -verbose
        verbose output mode

yoke mayday

Usage:
  yoke mayday [flags] <release>

Aliases:
  delete

Examples:
  # delete a release and all its revision history
  yoke mayday foo

Flags:
  -kubeconfig string
        path to kube config
  -verbose
        verbose output mode

yoke blackbox

Usage:
  yoke blackbox [flags] [release] [revision-id] [revision-id-to-compare]

Aliases:
  inspect

Examples:
  # get an overview of all releases and their current revision id
  yoke blackbox

  # get an overview of all revisions for a given release
  yoke blackbox release

  # render the resources for specific revision
  yoke blackbox release 42

  # show list of resources by release
  yoke blackbox --mapping

Flags:
  -context int
        number of lines of context in diff (ignored if not comparing revisions) (default 4)
  -kubeconfig string
        path to kube config
  -mapping
        print release to resource mappings. If present ignores all other args
  -verbose
        verbose output mode