Merge pull request #30 from replicatedhq/run

Remove run subcommand

Author: marccampbell

Makefile

@@ -98,14 +98,14 @@ local-release:
 
 .PHONY: run-preflight
 run-preflight: preflight
-	./bin/preflight run \
+	./bin/preflight \
 		--image=localhost:32000/troubleshoot:alpha \
 		--pullpolicy=Always \
 		./config/samples/troubleshoot_v1beta1_preflight.yaml
 
 .PHONY: run-troubleshoot
 run-troubleshoot: troubleshoot
-	./bin/troubleshoot run \
+	./bin/troubleshoot \
 		--image=localhost:32000/troubleshoot:alpha \
 		--pullpolicy=Always \
 		./config/samples/troubleshoot_v1beta1_collector.yaml

README.md

@@ -8,7 +8,7 @@ Preflight checks are an easy-to-run set of conformance tests that can be written
 To run a sample preflight check from a sample application, [install the preflight kubectl plugin](https://help.replicated.com/docs/troubleshoot/kubernetes/preflight/running-as-kubectl-plugin/) and run:
 
 ```shell
-kubectl preflight https://git.io/preflight-checks
+kubectl preflight https://preflight.replicated.com
 ```
 
 For a full description of the supported preflight checks, visit the [docs](https://help.replicated.com/docs/troubleshoot/kubernetes/analysis/analysis-phase/).
@@ -19,5 +19,5 @@ A support bundle is an archive that's created in-cluster, by collecting logs, cl
 To collect a sample support bundle, [install the troubleshoot kubectl plugin](/docs/troubleshoot/kubernetes/troubleshoot/running-as-kubectl-plugin/) and run:
 
 ```shell
-kubectl troubleshoot https://git.io/support-bundle
+kubectl troubleshoot https://troubleshoot.replicated.com
 ```

cmd/preflight/cli/root.go

@@ -3,25 +3,50 @@ package cli
 import (
 	"fmt"
 	"os"
+	"path/filepath"
 	"strings"
 
+	troubleshootv1beta1 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta1"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
 func RootCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "preflight",
+		Use:   "preflight [url]",
 		Short: "Run and retrieve preflight checks in a cluster",
 		Long: `A preflight check is a set of validations that can and should be run to ensure
 that a cluster meets the requirements to run an application.`,
-		SilenceUsage: true,
+		PreRun: func(cmd *cobra.Command, args []string) {
+			viper.BindPFlags(cmd.Flags())
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			v := viper.GetViper()
+
+			if len(args) == 0 {
+				return runPreflightsCRD(v)
+			}
+
+			return runPreflightsNoCRD(v, args[0])
+		},
 	}
 
 	cobra.OnInitialize(initConfig)
 
-	cmd.AddCommand(Run())
-	cmd.AddCommand(Server())
+	cmd.Flags().Bool("interactive", true, "interactive preflights")
+	cmd.Flags().String("format", "human", "output format, one of human, json, yaml. only used when interactive is set to false")
+
+	cmd.Flags().String("preflight", "", "name of the preflight to use")
+	cmd.Flags().String("namespace", "default", "namespace the preflight can be found in")
+
+	cmd.Flags().String("kubecontext", filepath.Join(homeDir(), ".kube", "config"), "the kubecontext to use when connecting")
+
+	cmd.Flags().String("image", "", "the full name of the preflight image to use")
+	cmd.Flags().String("pullpolicy", "", "the pull policy of the preflight image")
+	cmd.Flags().String("collector-image", "", "the full name of the collector image to use")
+	cmd.Flags().String("collector-pullpolicy", "", "the pull policy of the collector image")
+
+	cmd.Flags().String("serviceaccount", "", "name of the service account to use. if not provided, one will be created")
 
 	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
 	return cmd
@@ -38,3 +63,16 @@ func initConfig() {
 	viper.SetEnvPrefix("PREFLIGHT")
 	viper.AutomaticEnv()
 }
+
+func ensureCollectorInList(list []*troubleshootv1beta1.Collect, collector troubleshootv1beta1.Collect) []*troubleshootv1beta1.Collect {
+	for _, inList := range list {
+		if collector.ClusterResources != nil && inList.ClusterResources != nil {
+			return list
+		}
+		if collector.ClusterInfo != nil && inList.ClusterInfo != nil {
+			return list
+		}
+	}
+
+	return append(list, &collector)
+}

cmd/preflight/cli/run.go

@@ -3,25 +3,47 @@ package cli
 import (
 	"fmt"
 	"os"
+	"path/filepath"
 	"strings"
 
+	troubleshootv1beta1 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta1"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
 func RootCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "troubleshoot",
+		Use:   "troubleshoot [url]",
 		Short: "Generate and manage support bundles",
 		Long: `A support bundle is an archive of files, output, metrics and state
 from a server that can be used to assist when troubleshooting a server.`,
-		SilenceUsage: true,
+		PreRun: func(cmd *cobra.Command, args []string) {
+			viper.BindPFlags(cmd.Flags())
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			v := viper.GetViper()
+
+			if len(args) == 0 {
+				return runTroubleshootCRD(v)
+			}
+
+			return runTroubleshootNoCRD(v, args[0])
+		},
 	}
 
 	cobra.OnInitialize(initConfig)
 
-	cmd.AddCommand(Run())
-	cmd.AddCommand(Retrieve())
+	cmd.Flags().String("collectors", "", "name of the collectors to use")
+	cmd.Flags().String("namespace", "default", "namespace the collectors can be found in")
+
+	cmd.Flags().String("kubecontext", filepath.Join(homeDir(), ".kube", "config"), "the kubecontext to use when connecting")
+
+	cmd.Flags().String("image", "", "the full name of the collector image to use")
+	cmd.Flags().String("pullpolicy", "", "the pull policy of the collector image")
+	cmd.Flags().Bool("redact", true, "enable/disable default redactions")
+
+	cmd.Flags().String("serviceaccount", "", "name of the service account to use. if not provided, one will be created")
+	viper.BindPFlags(cmd.Flags())
 
 	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
 	return cmd
@@ -38,3 +60,16 @@ func initConfig() {
 	viper.SetEnvPrefix("TROUBLESHOOT")
 	viper.AutomaticEnv()
 }
+
+func ensureCollectorInList(list []*troubleshootv1beta1.Collect, collector troubleshootv1beta1.Collect) []*troubleshootv1beta1.Collect {
+	for _, inList := range list {
+		if collector.ClusterResources != nil && inList.ClusterResources != nil {
+			return list
+		}
+		if collector.ClusterInfo != nil && inList.ClusterInfo != nil {
+			return list
+		}
+	}
+
+	return append(list, &collector)
+}

cmd/preflight/cli/server.go

@@ -23,51 +23,9 @@ spec:
       command: ["ping"]
       args: ["www.google.com"]
       timeout: 5s
-  - exec:
-      collectorName: mysql-vars
-      selector:
-        - app=mysql
-      namespace: default
-      command: ["mysql"]
-      args: ["-ureplicated", "-ppassword", "-e", "show processlist"]
-      timeout: 60m
-  - exec:
-      collectorName: hosts
-      selector:
-        - app=graphql-api
-      namespace: default
-      command: ["cat"]
-      args: ["/etc/hosts"]
-      timeout: 60m
-  - exec:
-      collectorName: broken
-      selector:
-        - app=graphql-api
-      namespace: default
-      command: ["cat"]
-      args: ["/etc/hostdasddsda"]
-      timeout: 60m
   - http:
       collectorName: test-get
       get:
         url: https://api.staging.replicated.com/market/v1/echo/ip
         insecureSkipVerify: false
         headers: {}
-  - http:
-      collectorName: test-post
-      post:
-        url: http://httpbin.org/headers
-        insecureSkipVerify: false
-        headers:
-          X-Custom-Header: "post-request"
-  - http:
-      collectorName: test-put
-      put:
-        url: http://httpbin.org/anything
-        insecureSkipVerify: false
-        headers:
-          X-Custom-Header: "put-request"
-  - http:
-      collectorName: test-broken
-      put:
-        url: ""