commands

Documentation

Overview

Code generated by "mdtogo"; DO NOT EDIT.

Index

• Variables

Variables

var AnnotateExamples = `` /* 184-byte string literal not displayed */

var AnnotateLong = `
[Alpha]  Set an annotation on Resources.

  DIR:
    Path to local directory.
`

var AnnotateShort = `[Alpha] Set an annotation on Resources.`

var CatExamples = `` /* 359-byte string literal not displayed */

var CatLong = `
[Alpha]  Print Resource Config from a local directory.

  DIR:
    Path to local directory.
`

var CatShort = `[Alpha] Print Resource Config from a local directory.`

var CompletionExamples = `` /* 478-byte string literal not displayed */

var CompletionLong = `
Generate shell completion for ` + "`" + `kustomize` + "`" + ` -- supports bash, zsh, fish and powershell.
`

var CompletionShort = `Generate shell completion.`

var CountExamples = `
    # print Resource counts from a directory
    kustomize cfg count my-dir/`

var CountLong = `
[Alpha] Count Resources Config from a local directory.

  DIR:
    Path to local directory.
`

var CountShort = `[Alpha] Count Resources Config from a local directory.`

var CreateSetterExamples = `` /* 450-byte string literal not displayed */

var CreateSetterLong = `` /* 263-byte string literal not displayed */

var CreateSetterShort = `[Alpha] Create a custom setter for a Resource field`

var DeleteSetterExamples = `
    # delete a setter for port
    kustomize cfg create-setter DIR/ port`

var DeleteSetterLong = `` /* 152-byte string literal not displayed */

var DeleteSetterShort = `[Alpha] Delete a custom setter for a Resource field`

var FmtExamples = `` /* 313-byte string literal not displayed */

var FmtLong = `` /* 979-byte string literal not displayed */

var FmtShort = `[Alpha] Format yaml configuration files.`

var GrepExamples = `` /* 466-byte string literal not displayed */

var GrepLong = `` /* 404-byte string literal not displayed */

var GrepShort = `[Alpha] Search for matching Resources in a directory or from stdin`

var InitExamples = `` /* 135-byte string literal not displayed */

var InitLong = `
[Alpha]  Initialize a directory with a Krmfile.

  DIR:
    Path to local directory.
`

var InitShort = `[Alpha] Initialize a directory with a Krmfile.`

var ListSettersExamples = `` /* 175-byte string literal not displayed */

var ListSettersLong = `` /* 147-byte string literal not displayed */

var ListSettersShort = `[Alpha] List setters for Resources.`

var Merge3Examples = `
    kustomize cfg merge3 --ancestor a/ --from b/ --to c/`

var Merge3Long = `` /* 625-byte string literal not displayed */

var Merge3Short = `[Alpha] Merge diff of Resource configuration files into a destination (3-way)`

var MergeExamples = `
    cat resources_and_patches.yaml | kustomize cfg merge > merged_resources.yaml`

var MergeLong = `` /* 554-byte string literal not displayed */

var MergeShort = `[Alpha] Merge Resource configuration files`

var RunFnsExamples = `
kustomize fn run example/`

var RunFnsLong = `
[Alpha] Reconcile config functions to Resources.

run sequentially invokes all config functions in the directory, providing Resources
in the directory as input to the first function, and writing the output of the last
function back to the directory.

The ordering of functions is determined by the order they are encountered when walking the
directory.  To clearly specify an ordering of functions, multiple functions may be
declared in the same file, separated by '---' (the functions will be invoked in the
order they appear in the file).

#### Arguments:

  DIR:
    Path to local directory.

#### Config Functions:

  Config functions are specified as Kubernetes types containing a metadata.annotations.[config.kubernetes.io/function]
  field specifying an image for the container to run.  This image tells run how to invoke the container.

  Example config function:

	# in file example/fn.yaml
	apiVersion: fn.example.com/v1beta1
	kind: ExampleFunctionKind
	metadata:
	  annotations:
	    config.kubernetes.io/function: |
	      container:
	        # function is invoked as a container running this image
	        image: gcr.io/example/examplefunction:v1.0.1
	    config.kubernetes.io/local-config: "true" # tools should ignore this
	spec:
	  configField: configValue

  In the preceding example, 'kustomize fn run example/' would identify the function by
  the metadata.annotations.[config.kubernetes.io/function] field.  It would then write all Resources in the directory to
  a container stdin (running the gcr.io/example/examplefunction:v1.0.1 image).  It
  would then write the container stdout back to example/, replacing the directory
  file contents.

  See ` + "`" + `kustomize help cfg docs-fn` + "`" + ` for more details on writing functions.
`

var RunFnsShort = `[Alpha] Reoncile config functions to Resources.`

var SetExamples = `` /* 1363-byte string literal not displayed */

var SetLong = `
Set values on Resources fields.  May set either the complete or partial field value.

` + "`" + `set` + "`" + ` identifies setters using field metadata published as OpenAPI extensions.
` + "`" + `set` + "`" + ` parses both the Kubernetes OpenAPI, as well OpenAPI published inline in
the configuration as comments.

` + "`" + `set` + "`" + ` maybe be used to:

- edit configuration programmatically from the cli
- create reusable bundles of configuration with custom setters

  DIR

    A directory containing Resource configuration.

  NAME

    Optional.  The name of the setter to perform or display.

  VALUE

    Optional.  The value to set on the field.


To print the possible setters for the Resources in a directory, run
` + "`" + `list-setters` + "`" + ` on a directory -- e.g. ` + "`" + `kustomize cfg list-setters DIR/` + "`" + `.

#### Tips

- A description of the value may be specified with ` + "`" + `--description` + "`" + `.
- The last setter for the field's value may be defined with ` + "`" + `--set-by` + "`" + `.
- Create custom setters on Resources, Kustomization.yaml's, patches, etc

The description and setBy fields are left unmodified unless specified with flags.

To create a custom setter for a field see: ` + "`" + `kustomize help cfg create-setter` + "`" + `
`

var SetShort = `[Alpha] Set values on Resources fields values.`

var SinkExamples = `
    kustomize fn source DIR/ | your-function | kustomize fn sink DIR/`

var SinkLong = `
[Alpha] Implement a Sink by writing input to a local directory.

    kustomize fn sink [DIR]

  DIR:
    Path to local directory.  If unspecified, sink will write to stdout as if it were a single file.

` + "`" + `sink` + "`" + ` writes its input to a directory
`

var SinkShort = `[Alpha] Implement a Sink by writing input to a local directory.`

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

var SourceLong = `
[Alpha] Implement a Source by reading a local directory.

    kustomize fn source DIR...

  DIR:
    One or more paths to local directories.  Contents from directories will be concatenated.
    If no directories are provided, source will read from stdin as if it were a single file.

` + "`" + `source` + "`" + ` emits configuration to act as input to a function
`

var SourceShort = `[Alpha] Implement a Source by reading a local directory.`

var TreeExamples = `` /* 1068-byte string literal not displayed */

var TreeLong = `` /* 838-byte string literal not displayed */

var TreeShort = `[Alpha] Display Resource structure from a directory or stdin.`