This is the documentation for version 0.39. For documentation on the latest version of kpt, please see kpt.dev.

Grep

Filter resources by their field values

Grep reads resources from a package or stdin and filters them by their field values.

Grep may have sources such as kubectl get -o yaml piped to it, or may be piped to other commands such as kpt cfg tree for display.

Examples

# find Deployment Resources
kpt cfg grep "kind=Deployment" my-dir/

# find Resources named nginx
kpt cfg grep "metadata.name=nginx" my-dir/

# use tree to display matching Resources
kpt cfg grep "metadata.name=nginx" my-dir/ | kpt cfg tree

# look for Resources matching a specific container image
kpt cfg grep "spec.template.spec.containers[name=nginx].image=nginx:1\.7\.9" \
    my-dir/ | kpt cfg tree

Synopsis

kpt cfg grep QUERY DIR

Args

    QUERY:
      Query to match expressed as 'path.to.field=value'.
      Maps and fields are matched as '.field-name' or '.map-key'
      List elements are matched as '[list-elem-field=field-value]'
      The value to match is expressed as '=value'
      '.' as part of a key or value can be escaped as '\.'

    DIR:
      Path to a package directory

Flags

--annotate
  annotate resources with their file origins. (default true)

--invert-match, -v
  keep resources NOT matching the specified pattern

--recurse-subpackages, -R
  Grep recursively in all the nested subpackages

Last modified September 10, 2020: docs: Guides For Composite Packages (7716e112)