ks prototype preview

Preview a prototype’s output without creating a component (stdout)

Synopsis

This preview command expands a prototype with CLI flag parameters, and
emits the resulting manifest to stdout. This allows you to see the potential
output of a ks generate command without actually creating a new component file.

The output is formatted in Jsonnet. To see YAML or JSON equivalents, first create
a component with ks generate and then use ks show.

  • ks generate — Use the specified prototype to generate a component manifest

Syntax

  1. ks prototype preview <prototype-name> [parameter-flags] [flags]

Examples

  2. # Preview prototype 'io.ksonnet.pkg.single-port-deployment', using the
  3. # 'nginx' image, and port 80 exposed.
  4. ks prototype preview single-port-deployment \
  5.   --name=nginx                              \
  6.   --image=nginx                             \
  7.   --port=80
  9. # Preview prototype 'io.ksonnet.pkg.single-port-deployment', using the
  10. # 'nginx' image, and port 80 exposed with a values file.
  11. ks prototype preview simple-port-deployment \
  12.   --name=nginx                              \
  13.   --values-file=ks-values
  15. Where 'ks-values' is a jsonnet file with the contents:
  17. {
  18.     image: "nginx",
  19.     port: 80,
  20. }

Options

  1.   -h, --help   help for preview

Options inherited from parent commands

  1.       --dir string        Ksonnet application root to use; Defaults to CWD
  2.       --tls-skip-verify   Skip verification of TLS server certificates
  3.   -v, --verbose count     Increase verbosity. May be given multiple times.

SEE ALSO

  • ks prototype - Instantiate, inspect, and get examples for ksonnet prototypes