Command line reference

Ksonnet provides a CLI (invoked with ks) that allows you to generate Kubernetes resource manifests locally (in jsonnet) and synchronize them with your remote cluster(s).

The files in this directory enumerate each of the possible ks commands and their flags. Note that you can also find this info with the CLI itself, using the --help flag.

Suggested command usage is described below:

Getting started

• Set up a ksonnet application

  • ks init

• Generate components for your app (e.g. Redis)

  • ks generate (alias of ks prototype use)

• Deploy to a cluster

  • ks apply

• Delete resources running on a cluster

  • ks delete

Fancier components

• Learn about existing prototypes (ks prototype)

  • ks prototype list
  • ks prototype search
  • ks prototype describe
  • ks prototype preview
  • ks prototype use

• Learn about and download currently available packages (ks pkg)

  • ks pkg list
  • ks pkg describe
  • ks pkg install

• Learn about existing registries (ks registry)

  • ks registry list
  • ks registry describe
  • ks registry add

• List and remove existing components

  • ks component list
  • ks component rm

Environments

• Managing environments (ks env)

  • ks env add
  • ks env current
  • ks env describe
  • ks env list
  • ks env rm
  • ks env set
  • ks env targets
  • ks env update

• Customizing environments with parameters (ks param)

  • ks param list
  • ks param set

• Comparing environments

  • ks diff
  • ks param diff

Miscellaneous

• View expanded manifests

  • ks show

• Import a manifest

  • ks import

• Validate manifests against the Kubernetes API

  • ks validate

• View metadata about the ksonnet binary

  • ks version