Rename --analytics to --enable-analytics (#314)

ops-center · Mar 21, 2018 · 5c1e71e · 5c1e71e
1 parent 6612934
commit 5c1e71e
Show file tree

Hide file tree

Showing 33 changed files with 34 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ Want to help improve Searchlight? Please start [here](https://appscode.com/produ
 ---
 
 **Searchlight binaries collects anonymous usage statistics to help us learn how the software is being used and
-how we can improve it. To disable stats collection, run the operator with the flag** `--analytics=false`.
+how we can improve it. To disable stats collection, run the operator with the flag** `--enable-analytics=false`.
 
 ---
 

diff --git a/chart/stable/searchlight/templates/deployment.yaml b/chart/stable/searchlight/templates/deployment.yaml
@@ -38,7 +38,7 @@ spec:
         - --audit-log-path=-
         - --tls-cert-file=/var/serving-cert/tls.crt
         - --tls-private-key-file=/var/serving-cert/tls.key
-        - --analytics={{ .Values.enableAnalytics }}
+        - --enable-analytics={{ .Values.enableAnalytics }}
         ports:
         - containerPort: 8443
         - containerPort: 56790

diff --git a/docs/README.md b/docs/README.md
@@ -40,6 +40,6 @@ make our docs better.
 ---
 
 **Searchlight binaries collects anonymous usage statistics to help us learn how the software is being used and how we can improve it.
-To disable stats collection, run the operator with the flag** `--analytics=false`.
+To disable stats collection, run the operator with the flag** `--enable-analytics=false`.
 
 ---
diff --git a/docs/reference/hostfacts/hostfacts.md b/docs/reference/hostfacts/hostfacts.md
@@ -27,7 +27,7 @@ Hostfacts by AppsCode - Expose node metrics
 
 ```
       --alsologtostderr                  log to standard error as well as files
-      --analytics                        Send analytical events to Google Analytics (default true)
+      --enable-analytics                 send usage events to Google Analytics (default true)
   -h, --help                             help for hostfacts
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory

diff --git a/docs/reference/hostfacts/hostfacts_run.md b/docs/reference/hostfacts/hostfacts_run.md
@@ -38,7 +38,7 @@ hostfacts run [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
-      --analytics                        Send analytical events to Google Analytics (default true)
+      --enable-analytics                 send usage events to Google Analytics (default true)
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hostfacts/hostfacts_version.md b/docs/reference/hostfacts/hostfacts_version.md
@@ -32,7 +32,7 @@ hostfacts version [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
-      --analytics                        Send analytical events to Google Analytics (default true)
+      --enable-analytics                 send usage events to Google Analytics (default true)
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert.md b/docs/reference/hyperalert/hyperalert.md
@@ -31,6 +31,7 @@ hyperalert [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
   -h, --help                             help for hyperalert
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory

diff --git a/docs/reference/hyperalert/hyperalert_analytics_id.md b/docs/reference/hyperalert/hyperalert_analytics_id.md
@@ -31,6 +31,7 @@ hyperalert analytics_id [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_ca_cert.md b/docs/reference/hyperalert/hyperalert_check_ca_cert.md
@@ -33,6 +33,7 @@ hyperalert check_ca_cert [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_cert.md b/docs/reference/hyperalert/hyperalert_check_cert.md
@@ -39,6 +39,7 @@ hyperalert check_cert [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_component_status.md b/docs/reference/hyperalert/hyperalert_check_component_status.md
@@ -35,6 +35,7 @@ hyperalert check_component_status [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_env.md b/docs/reference/hyperalert/hyperalert_check_env.md
@@ -31,6 +31,7 @@ hyperalert check_env [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_event.md b/docs/reference/hyperalert/hyperalert_check_event.md
@@ -40,6 +40,7 @@ hyperalert check_event [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_influx_query.md b/docs/reference/hyperalert/hyperalert_check_influx_query.md
@@ -44,6 +44,7 @@ hyperalert check_influx_query [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_json_path.md b/docs/reference/hyperalert/hyperalert_check_json_path.md
@@ -38,6 +38,7 @@ hyperalert check_json_path [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_node_exists.md b/docs/reference/hyperalert/hyperalert_check_node_exists.md
@@ -36,6 +36,7 @@ hyperalert check_node_exists [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_node_status.md b/docs/reference/hyperalert/hyperalert_check_node_status.md
@@ -34,6 +34,7 @@ hyperalert check_node_status [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_pod_exec.md b/docs/reference/hyperalert/hyperalert_check_pod_exec.md
@@ -37,6 +37,7 @@ hyperalert check_pod_exec [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_pod_exists.md b/docs/reference/hyperalert/hyperalert_check_pod_exists.md
@@ -37,6 +37,7 @@ hyperalert check_pod_exists [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_pod_status.md b/docs/reference/hyperalert/hyperalert_check_pod_status.md
@@ -34,6 +34,7 @@ hyperalert check_pod_status [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_check_volume.md b/docs/reference/hyperalert/hyperalert_check_volume.md
@@ -39,6 +39,7 @@ hyperalert check_volume [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_notifier.md b/docs/reference/hyperalert/hyperalert_notifier.md
@@ -41,6 +41,7 @@ hyperalert notifier [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/hyperalert/hyperalert_version.md b/docs/reference/hyperalert/hyperalert_version.md
@@ -32,6 +32,7 @@ hyperalert version [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
+      --enable-analytics                 send usage events to Google Analytics
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/searchlight/searchlight.md b/docs/reference/searchlight/searchlight.md
@@ -27,7 +27,7 @@ Searchlight by AppsCode - Alerts for Kubernetes
 
 ```
       --alsologtostderr                  log to standard error as well as files
-      --analytics                        Send analytical events to Google Analytics (default true)
+      --enable-analytics                 send usage events to Google Analytics (default true)
   -h, --help                             help for searchlight
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory

diff --git a/docs/reference/searchlight/searchlight_configure.md b/docs/reference/searchlight/searchlight_configure.md
@@ -32,7 +32,7 @@ searchlight configure [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
-      --analytics                        Send analytical events to Google Analytics (default true)
+      --enable-analytics                 send usage events to Google Analytics (default true)
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/searchlight/searchlight_run.md b/docs/reference/searchlight/searchlight_run.md
@@ -72,7 +72,7 @@ searchlight run [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
-      --analytics                        Send analytical events to Google Analytics (default true)
+      --enable-analytics                 send usage events to Google Analytics (default true)
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/reference/searchlight/searchlight_version.md b/docs/reference/searchlight/searchlight_version.md
@@ -32,7 +32,7 @@ searchlight version [flags]
 
 ```
       --alsologtostderr                  log to standard error as well as files
-      --analytics                        Send analytical events to Google Analytics (default true)
+      --enable-analytics                 send usage events to Google Analytics (default true)
       --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
       --log_dir string                   If non-empty, write log files in this directory
       --logtostderr                      log to standard error instead of files

diff --git a/docs/setup/install.md b/docs/setup/install.md
@@ -52,7 +52,7 @@ options:
     --image-pull-secret            name of secret used to pull searchlight operator images
     --run-on-master                run searchlight operator on master
     --enable-admission-webhook     configure admission webhook for searchlight CRDs
-    --analytics                    send usage events to Google Analytics (default: true)
+    --enable-analytics             send usage events to Google Analytics (default: true)
     --uninstall                    uninstall searchlight
     --purge                        purges searchlight crd objects and crds
 ```

diff --git a/hack/deploy/operator.yaml b/hack/deploy/operator.yaml
@@ -40,7 +40,7 @@ spec:
         - --audit-log-path=-
         - --tls-cert-file=/var/serving-cert/tls.crt
         - --tls-private-key-file=/var/serving-cert/tls.key
-        - --analytics="${SEARCHLIGHT_ENABLE_ANALYTICS}"
+        - --enable-analytics="${SEARCHLIGHT_ENABLE_ANALYTICS}"
         ports:
         - containerPort: 8443
         - containerPort: 56790

diff --git a/hack/deploy/searchlight.sh b/hack/deploy/searchlight.sh
@@ -78,7 +78,7 @@ show_help() {
     echo "    --image-pull-secret            name of secret used to pull searchlight operator images"
     echo "    --run-on-master                run searchlight operator on master"
     echo "    --enable-admission-webhook     configure admission webhook for searchlight CRDs"
-    echo "    --analytics                    send usage events to Google Analytics (default: true)"
+    echo "    --enable-analytics             send usage events to Google Analytics (default: true)"
     echo "    --uninstall                    uninstall searchlight"
     echo "    --purge                        purges searchlight crd objects and crds"
 }
@@ -119,7 +119,7 @@ while test $# -gt 0; do
             fi
             shift
             ;;
-        --analytics*)
+        --enable-analytics*)
             val=`echo $1 | sed -e 's/^[^=]*=//g'`
             if [ "$val" = "false" ]; then
                 export SEARCHLIGHT_ENABLE_ANALYTICS=false

diff --git a/pkg/cmds/hostfacts.go b/pkg/cmds/hostfacts.go
@@ -40,7 +40,7 @@ func NewCmdHostfacts() *cobra.Command {
 	cmd.PersistentFlags().AddGoFlagSet(flag.CommandLine)
 	// ref: https://github.com/kubernetes/kubernetes/issues/17162#issuecomment-225596212
 	flag.CommandLine.Parse([]string{})
-	cmd.PersistentFlags().BoolVar(&enableAnalytics, "analytics", enableAnalytics, "Send analytical events to Google Analytics")
+	cmd.PersistentFlags().BoolVar(&enableAnalytics, "enable-analytics", enableAnalytics, "send usage events to Google Analytics")
 
 	cmd.AddCommand(NewCmdServer())
 	cmd.AddCommand(v.NewCmdVersion())

diff --git a/pkg/cmds/searchlight.go b/pkg/cmds/searchlight.go
@@ -47,7 +47,7 @@ func NewCmdSearchlight() *cobra.Command {
 	rootCmd.PersistentFlags().AddGoFlagSet(flag.CommandLine)
 	// ref: https://github.com/kubernetes/kubernetes/issues/17162#issuecomment-225596212
 	flag.CommandLine.Parse([]string{})
-	rootCmd.PersistentFlags().BoolVar(&enableAnalytics, "analytics", enableAnalytics, "Send analytical events to Google Analytics")
+	rootCmd.PersistentFlags().BoolVar(&enableAnalytics, "enable-analytics", enableAnalytics, "send usage events to Google Analytics")
 
 	stopCh := genericapiserver.SetupSignalHandler()
 	rootCmd.AddCommand(NewCmdRun(os.Stdout, os.Stderr, stopCh))

diff --git a/plugins/hyperalert/lib.go b/plugins/hyperalert/lib.go
@@ -56,6 +56,7 @@ func NewCmd() *cobra.Command {
 	cmd.PersistentFlags().AddGoFlagSet(flag.CommandLine)
 	// ref: https://github.com/kubernetes/kubernetes/issues/17162#issuecomment-225596212
 	flag.CommandLine.Parse([]string{})
+	cmd.PersistentFlags().BoolVar(&enableAnalytics, "enable-analytics", enableAnalytics, "send usage events to Google Analytics")
 
 	// CheckCluster
 	cmd.AddCommand(check_component_status.NewCmd())
-Original file line number
+Diff line change
@@ Expand Up @@
     ---
     **Searchlight binaries collects anonymous usage statistics to help us learn how the software is being used and
-    how we can improve it. To disable stats collection, run the operator with the flag** `--analytics=false`.
+    how we can improve it. To disable stats collection, run the operator with the flag** `--enable-analytics=false`.
     ---
@@ Expand Down @@