From e6da0c11f1e2e21b7c23e37e70a154508d3710af Mon Sep 17 00:00:00 2001 From: evalsocket Date: Wed, 16 Sep 2020 00:49:55 -0700 Subject: [PATCH] documentation added for report command --- pkg/kyverno/report/allreports.go | 2 +- pkg/kyverno/report/cluster.go | 4 ++-- pkg/kyverno/report/helm.go | 2 +- pkg/kyverno/report/namespace.go | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pkg/kyverno/report/allreports.go b/pkg/kyverno/report/allreports.go index dd36259d58..31e8e50a5e 100644 --- a/pkg/kyverno/report/allreports.go +++ b/pkg/kyverno/report/allreports.go @@ -18,7 +18,7 @@ func AllReportsCommand() *cobra.Command { var mode,namespace, policy string cmd := &cobra.Command{ Use: "all", - Short: "generate report", + Short: "generate report for all scope", Example: fmt.Sprintf("To create a namespace report from background scan:\nkyverno report namespace --namespace=defaults \n kyverno report namespace"), RunE: func(cmd *cobra.Command, args []string) (err error) { os.Setenv("POLICY-TYPE", common.PolicyReport) diff --git a/pkg/kyverno/report/cluster.go b/pkg/kyverno/report/cluster.go index 5da08abafa..ff75a444fb 100644 --- a/pkg/kyverno/report/cluster.go +++ b/pkg/kyverno/report/cluster.go @@ -15,8 +15,8 @@ func ClusterCommand() *cobra.Command { var mode, policy string cmd := &cobra.Command{ Use: "cluster", - Short: "generate report", - Example: fmt.Sprintf("To create a cluster report from background scan:\nkyverno report cluster --namespace=defaults \n kyverno report cluster"), + Short: "generate report for cluster scope", + Example: fmt.Sprintf("To create a cluster report from background scan: kyverno report cluster"), RunE: func(cmd *cobra.Command, args []string) (err error) { os.Setenv("POLICY-TYPE", common.PolicyReport) logger := log.Log.WithName("Report") diff --git a/pkg/kyverno/report/helm.go b/pkg/kyverno/report/helm.go index af3a7e178f..541c6b3fe1 100644 --- a/pkg/kyverno/report/helm.go +++ b/pkg/kyverno/report/helm.go @@ -19,7 +19,7 @@ func HelmCommand() *cobra.Command { var mode, policy, namespace string cmd := &cobra.Command{ Use: "helm", - Short: "generate report", + Short: "generate report for scope app", Example: fmt.Sprintf("To create a helm report from background scan:\nkyverno report helm --namespace=defaults \n kyverno report helm"), RunE: func(cmd *cobra.Command, args []string) (err error) { os.Setenv("POLICY-TYPE", common.PolicyReport) diff --git a/pkg/kyverno/report/namespace.go b/pkg/kyverno/report/namespace.go index 90b36dc87a..8975130dfb 100644 --- a/pkg/kyverno/report/namespace.go +++ b/pkg/kyverno/report/namespace.go @@ -18,7 +18,7 @@ func NamespaceCommand() *cobra.Command { var mode, namespace, policy string cmd := &cobra.Command{ Use: "namespace", - Short: "generate report", + Short: "generate report for scope namespace", Example: fmt.Sprintf("To create a namespace report from background scan:\nkyverno report namespace --namespace=defaults \n kyverno report namespace"), RunE: func(cmd *cobra.Command, args []string) (err error) { os.Setenv("POLICY-TYPE", common.PolicyReport)