Skip to content

Commit 59ccbe5

Browse files
committed
fix: Correct kind filter documentation
1 parent 60a308c commit 59ccbe5

File tree

2 files changed

+28
-5
lines changed

2 files changed

+28
-5
lines changed

docs/kind_filters.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Kind filters
2+
3+
Kind can be either just the kind or prefixed with the api version separated with slash.
4+
5+
Examples:
6+
7+
--kind Deployment
8+
--kind networking.k8s.io/v1/Ingress
9+
10+
As a special case if the option end with / all the resourcces with that api version are considered:
11+
12+
--kind apps/v/
13+
14+
To choose several kinds you just repat the option. For example
15+
16+
-k Deployment -k CronJob

pkg/kyamls/filter.go

+12-5
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,18 @@ func trimQuotes(text string) string {
9595

9696
// AddFlags add CLI flags for specifying a filter
9797
func (f *Filter) AddFlags(cmd *cobra.Command) {
98-
cmd.Flags().StringArrayVarP(&f.Kinds, "kind", "k", nil, "adds Kubernetes resource kinds to filter on. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md")
99-
cmd.Flags().StringArrayVarP(&f.KindsIgnore, "kind-ignore", "", nil, "adds Kubernetes resource kinds to exclude. For kind expressions see: https://github.com/jenkins-x/jx-helpers/v3/tree/master/docs/kind_filters.md")
100-
cmd.Flags().StringToStringVarP(&f.Selector, "selector", "", nil, "adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm")
101-
cmd.Flags().StringVar(&f.SelectTarget, "selector-target", "", "sets which path in the Kubernetes resources to select on instead of metadata.labels.")
102-
cmd.Flags().BoolVarP(&f.InvertSelector, "invert-selector", "", false, "inverts the effect of selector to exclude resources matched by selector")
98+
cmd.Flags().StringArrayVarP(&f.Kinds, "kind", "k", nil,
99+
"adds Kubernetes resource kinds to filter on. For kind expressions see:"+
100+
" https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md")
101+
cmd.Flags().StringArrayVarP(&f.KindsIgnore, "kind-ignore", "", nil,
102+
"adds Kubernetes resource kinds to exclude. For kind expressions see:"+
103+
" https://github.com/jenkins-x/jx-helpers/tree/master/docs/kind_filters.md")
104+
cmd.Flags().StringToStringVarP(&f.Selector, "selector", "", nil,
105+
"adds Kubernetes label selector to filter on, e.g. -s app=pusher-wave,heritage=Helm")
106+
cmd.Flags().StringVar(&f.SelectTarget, "selector-target", "",
107+
"sets which path in the Kubernetes resources to select on instead of metadata.labels.")
108+
cmd.Flags().BoolVarP(&f.InvertSelector, "invert-selector", "", false,
109+
"inverts the effect of selector to exclude resources matched by selector")
103110
}
104111

105112
// Parse parses the filter strings

0 commit comments

Comments
 (0)