fndocs

Documentation

Overview

Code generated by "mdtogo"; DO NOT EDIT.

Index

• Variables

Variables

var FnExamples = `` /* 342-byte string literal not displayed */

var FnLong = `` /* 389-byte string literal not displayed */

var FnShort = `Generate, transform, and validate configuration files.`

var RunExamples = `
  # read the Resources from DIR, provide them to a container my-fun as input,
  # write my-fn output back to DIR
  kpt fn run DIR/ --image gcr.io/example.com/my-fn

  # provide the my-fn with an input ConfigMap containing ` + "`" + `data: {foo: bar}` + "`" + `
  kpt fn run DIR/ --image gcr.io/example.com/my-fn:v1.0.0 -- foo=bar

  # run the functions in FUNCTIONS_DIR against the Resources in DIR
  kpt fn run DIR/ --fn-path FUNCTIONS_DIR/

  # discover functions in DIR and run them against Resource in DIR.
  # functions may be scoped to a subset of Resources -- see ` + "`" + `kpt help fn run` + "`" + `
  kpt fn run DIR/
`

var RunLong = `
  kpt fn run DIR [flags]

If the container exits with non-zero status code, run will fail and print the
container ` + "`" + `STDERR` + "`" + `.

  DIR:
    Path to a package directory.  Defaults to stdin if unspecified.
`

var RunShort = `Locally execute one or more functions in containers`

var SinkExamples = `` /* 136-byte string literal not displayed */

var SinkLong = `
  kpt fn sink [DIR]
  
  DIR:
    Path to a package directory.  Defaults to stdout if unspecified.
`

var SinkShort = `Explicitly specify an output sink for a function`

var SourceExamples = `` /* 221-byte string literal not displayed */

var SourceLong = `
  kpt fn source [DIR...]
  
  DIR:
    Path to a package directory.  Defaults to stdin if unspecified.
`

var SourceShort = `Explicitly specify an output source for a function`