kustomize/cmd/config/docs/commands/tree.md

tree

[Alpha] Display Resource structure from a directory or stdin.

Synopsis

[Alpha] Display Resource structure from a directory or stdin.

kustomize config tree may be used to print Resources in a directory or cluster, preserving structure

Args:

DIR: Path to local directory directory.

Resource fields may be printed as part of the Resources by specifying the fields as flags.

kustomize config tree has build-in support for printing common fields, such as replicas, container images, container names, etc.

kustomize config tree supports printing arbitrary fields using the '--field' flag.

By default, kustomize config tree uses Resource graph structure if any relationships between resources (ownerReferences) are detected, as is typically the case when printing from a cluster. Otherwise, directory graph structure is used. The graph structure can also be selected explicitly using the '--graph-structure' flag.

Examples

# print Resources using directory structure
kustomize config tree my-dir/

# print replicas, container name, and container image and fields for Resources
kustomize config tree my-dir --replicas --image --name

# print all common Resource fields
kustomize config tree my-dir/ --all

# print the "foo"" annotation
kustomize config tree my-dir/ --field "metadata.annotations.foo"

# print the "foo"" annotation
kubectl get all -o yaml | kustomize config tree \
  --field="status.conditions[type=Completed].status"

# print live Resources from a cluster using owners for graph structure
kubectl get all -o yaml | kustomize config tree --replicas --name --image

# print live Resources with status condition fields
kubectl get all -o yaml | kustomize config tree \
  --name --image --replicas \
  --field="status.conditions[type=Completed].status" \
  --field="status.conditions[type=Complete].status" \
  --field="status.conditions[type=Ready].status" \
  --field="status.conditions[type=ContainersReady].status"