diff --git a/cmd/polaris/audit.go b/cmd/polaris/audit.go index 983ebb63b..c3ee684b2 100644 --- a/cmd/polaris/audit.go +++ b/cmd/polaris/audit.go @@ -57,6 +57,7 @@ var ( skipSslValidation bool uploadInsights bool clusterName string + quiet bool ) func init() { @@ -80,6 +81,7 @@ func init() { auditCmd.PersistentFlags().BoolVar(&skipSslValidation, "skip-ssl-validation", false, "Skip https certificate verification") auditCmd.PersistentFlags().BoolVar(&uploadInsights, "upload-insights", false, "Upload scan results to Fairwinds Insights") auditCmd.PersistentFlags().StringVar(&clusterName, "cluster-name", "", "Set --cluster-name to a descriptive name for the cluster you're auditing") + auditCmd.PersistentFlags().BoolVar(&quiet, "quiet", false, "Suppress the 'upload to Insights' prompt.") } var auditCmd = &cobra.Command{ @@ -181,8 +183,10 @@ var auditCmd = &cobra.Command{ os.Stderr.WriteString(fmt.Sprintf("\n\n%s/orgs/%s/clusters/%s/action-items\n\n", insightsHost, auth.Organization, clusterName)) } else { outputAudit(auditData, auditOutputFile, auditOutputURL, auditOutputFormat, useColor, onlyShowFailedTests, severityLevel) - os.Stderr.WriteString("\n\n🚀 Upload your Polaris findings to Fairwinds Insights to see remediation advice, add teammates, integrate with Slack or Jira, and more:") - os.Stderr.WriteString("\n\n❯ polaris " + strings.Join(os.Args[1:], " ") + " --upload-insights --cluster-name=my-cluster\n\n") + if !quiet { + os.Stderr.WriteString("\n\n🚀 Upload your Polaris findings to Fairwinds Insights to see remediation advice, add teammates, integrate with Slack or Jira, and more:") + os.Stderr.WriteString("\n\n❯ polaris " + strings.Join(os.Args[1:], " ") + " --upload-insights --cluster-name=my-cluster\n\n") + } } summary := auditData.GetSummary() diff --git a/docs/cli.md b/docs/cli.md index 9e10ad704..77b33ca1a 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -56,6 +56,7 @@ webhook --only-show-failed-tests If specified, audit output will only show failed tests. --output-file string Destination file for audit results. --output-url string Destination URL to send audit results. + --quiet Suppress the 'upload to Insights' prompt. --resource string Audit a specific resource, in the format namespace/kind/version/name, e.g. nginx-ingress/Deployment.apps/v1/default-backend. --set-exit-code-below-score int Set an exit code of 4 when the score is below this threshold (1-100). --set-exit-code-on-danger Set an exit code of 3 when the audit contains danger-level issues. @@ -81,3 +82,9 @@ webhook status View authentication status. token Print the auth token gh is configured to use. ``` + +#### Suppressing 'upload to Insights' output + +When running the `polaris audit` subcommand, you can suppress the following output using the `--quiet flag`: + +> 🚀 Upload your Polaris findings to Fairwinds Insights to see remediation advice, add teammates, integrate with Slack or Jira, and more: