Merge remote-tracking branch 'origin/master' into laverya/allow-analyzing-all-files-in-dir

Author: laverya

.github/workflows/build-test-deploy.yaml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - uses: actions/setup-go@v1
         with:
-          go-version: "1.12.14"
+          go-version: "1.14"
 
       - name: setup env
         run: |
@@ -32,7 +32,7 @@ jobs:
     steps:
       - uses: actions/setup-go@v1
         with:
-          go-version: '1.12.14'
+          go-version: '1.14'
       - name: setup env
         run: |
           echo "::set-env name=GOPATH::$(go env GOPATH)"
@@ -56,7 +56,42 @@ jobs:
           path: bin/
       - uses: engineerd/[email protected]
       - run: chmod +x bin/preflight
-      - run: bin/preflight --interactive=false --format=json https://preflight.replicated.com
+      - run: ./bin/preflight --interactive=false --format=json https://preflight.replicated.com
+
+  compile-supportbundle:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/setup-go@v1
+        with:
+          go-version: '1.14'
+      - name: setup env
+        run: |
+          echo "::set-env name=GOPATH::$(go env GOPATH)"
+          echo "::add-path::$(go env GOPATH)/bin"
+        shell: bash
+      - uses: actions/checkout@master
+      - run: make support-bundle
+      - uses: actions/upload-artifact@v1
+        with:
+          name: support-bundle
+          path: bin/support-bundle
+
+  validate-supportbundle:
+    runs-on: ubuntu-latest
+    needs: compile-supportbundle
+    steps:
+      - uses: actions/checkout@v1
+      - name: Download support-bundle binary
+        uses: actions/download-artifact@v1
+        with:
+          name: support-bundle
+          path: bin/
+      - uses: engineerd/[email protected]
+      - run: chmod +x bin/support-bundle
+      - run: ./bin/support-bundle ./examples/support-bundle/sample-collectors.yaml
+      - run: ./bin/support-bundle ./examples/support-bundle/sample-supportbundle.yaml
+      - run: ./bin/support-bundle https://kots.io
 
   goreleaser:
     runs-on: ubuntu-latest
@@ -77,12 +112,22 @@ jobs:
 
       - uses: actions/setup-go@v1
         with:
-          go-version: "1.12.14"
+          go-version: "1.14"
 
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v1
+        uses: goreleaser/goreleaser-action@v2
         with:
           version: latest
           args: release --rm-dist --config deploy/.goreleaser.yaml
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}        
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+
+      - name: Update new preflight version in krew-index
+        uses: rajatjindal/[email protected]
+        with:
+          krew_template_file: deploy/krew/preflight.yaml
+      - name: Update new support-bundle version in krew-index
+        uses: rajatjindal/[email protected]
+        with:
+          krew_template_file: deploy/krew/support-bundle.yaml

Makefile

@@ -67,37 +67,39 @@ vet:
 
 .PHONY: generate
 generate: controller-gen client-gen
-	$(shell go env GOPATH)/bin/controller-gen object:headerFile=./hack/boilerplate.go.txt paths=./pkg/apis/...
-	$(shell go env GOPATH)/bin/client-gen \
+	$(CONTROLLER_GEN) \
+		object:headerFile=./hack/boilerplate.go.txt paths=./pkg/apis/...
+	$(CLIENT_GEN) \
 		--output-package=github.com/replicatedhq/troubleshoot/pkg/client \
 		--clientset-name troubleshootclientset \
 		--input-base github.com/replicatedhq/troubleshoot/pkg/apis \
 		--input troubleshoot/v1beta1 \
+		--input troubleshoot/v1beta2 \
 		-h ./hack/boilerplate.go.txt
 
 .PHONY: openapischema
 openapischema: controller-gen
 	controller-gen crd +output:dir=./config/crds  paths=./pkg/apis/troubleshoot/v1beta1
+	controller-gen crd +output:dir=./config/crds  paths=./pkg/apis/troubleshoot/v1beta2
 
 .PHONY: schemas
 schemas: fmt vet openapischema
 	go build ${LDFLAGS} -o bin/schemagen github.com/replicatedhq/troubleshoot/cmd/schemagen
 	./bin/schemagen --output-dir ./schemas
 
-# find or download controller-gen
-# download controller-gen if necessary
+.PHONY: contoller-gen
 controller-gen:
 ifeq (, $(shell which controller-gen))
-	go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.2.8
+	go get sigs.k8s.io/controller-tools/cmd/controller-gen@v0.3.0
 CONTROLLER_GEN=$(shell go env GOPATH)/bin/controller-gen
 else
 CONTROLLER_GEN=$(shell which controller-gen)
 endif
 
-# find or download client-gen
+.PHONY: client-gen
 client-gen:
 ifeq (, $(shell which client-gen))
-	go get k8s.io/code-generator/cmd/client-gen@kubernetes-1.16.4
+	go get k8s.io/code-generator/cmd/client-gen@kubernetes-1.18.0
 CLIENT_GEN=$(shell go env GOPATH)/bin/client-gen
 else
 CLIENT_GEN=$(shell which client-gen)
@@ -128,8 +130,8 @@ run-preflight: preflight
 
 .PHONY: run-troubleshoot
 run-troubleshoot: support-bundle
-	./bin/support-bundle ./examples/troubleshoot/sample-troubleshoot.yaml
+	./bin/support-bundle ./examples/support-bundle/sample-supportbundle.yaml
 
 .PHONY: run-analyze
 run-analyze: analyze
-	./bin/analyze --analyzers ./examples/troubleshoot/sample-analyzers.yaml ./support-bundle.tar.gz
+	./bin/analyze --analyzers ./examples/support-bundle/sample-analyzers.yaml ./support-bundle.tar.gz

README.md

@@ -1,8 +1,8 @@
 # Replicated Troubleshoot
 
-Replicated Troubleshoot is a framework for collecting, redacting and analyzing highly customizable diagnostic information about a Kubernetes cluster. Troubleshoot specs are created by 3rd-party application developers/maintainers and run by cluster operators in the initial and ongoing operation of those applications.
+Replicated Troubleshoot is a framework for collecting, redacting, and analyzing highly customizable diagnostic information about a Kubernetes cluster. Troubleshoot specs are created by 3rd-party application developers/maintainers and run by cluster operators in the initial and ongoing operation of those applications.
 
-Troubleshoot provides two CLI tools as kubectl plugins (using [Krew](https://krew.dev)) `kubectl preflight` and `kubectl support-bundle`. Preflight provides pre-installation cluster conformance testing and validation (preflight checks) and support-bundle provides post-installation troubleshooting and diagnostics (support bundles).
+Troubleshoot provides two CLI tools as kubectl plugins (using [Krew](https://krew.dev)): `kubectl preflight` and `kubectl support-bundle`. Preflight provides pre-installation cluster conformance testing and validation (preflight checks) and support-bundle provides post-installation troubleshooting and diagnostics (support bundles).
 
 ## Preflight Checks
 Preflight checks are an easy-to-run set of conformance tests that can be written to verify that specific requirements in a cluster are met.
@@ -18,11 +18,11 @@ curl https://krew.sh/preflight | bash
 kubectl preflight https://preflight.replicated.com
 ```
 
-For a details on creating the custom resource files that drive preflight checks, visit [creating preflight checks](https://troubleshoot.sh/docs/preflight/creating/).
+For a details on creating the custom resource files that drive preflight checks, visit [creating preflight checks](https://troubleshoot.sh/docs/preflight/introduction/).
 
 
 ## Support Bundle
-A support bundle is an archive that's created in-cluster, by collecting logs, cluster information and executing specified commands (including redaction of sensitive information). After creating a support bundle, the cluster operator will normally deliver it to the 3rd-party application vendor for analysis and disconnected debugging. Another Replicated project, [Kotsadm](https://github.com/replicatedhq/kotsadm), provides cluster operators with in-cluster UI for processing support bundles and viewing analyzers (as well as support bundle collection).
+A support bundle is an archive that's created in-cluster, by collecting logs and cluster information, and executing specified commands (including redaction of sensitive information). After creating a support bundle, the cluster operator will normally deliver it to the 3rd-party application vendor for analysis and disconnected debugging. Another Replicated project, [Kotsadm](https://github.com/replicatedhq/kotsadm), provides cluster operators with an in-cluster UI for processing support bundles and viewing analyzers (as well as support bundle collection).
 
 To collect a sample support bundle, install the troubleshoot kubectl plugin:
 
@@ -32,9 +32,9 @@ curl https://krew.sh/support-bundle | bash
  and run:
 
 ```shell
-kubectl support-bundle https://troubleshoot.replicated.com
+kubectl support-bundle https://support-bundle.replicated.com
 ```
-For details on creating the custom resource files that drive support-bundle collection [creating collectors](https://troubleshoot.sh/reference/collectors/overview/) and for analyzers [creating analyzers](https://troubleshoot.sh/reference/analyzers/overview/).
+For details on creating the custom resource files that drive support-bundle collection, visit [creating collectors](https://troubleshoot.sh/docs/collect/) and [creating analyzers](https://troubleshoot.sh/docs/analyze/).
 
 # Community
 

cmd/preflight/cli/interactive_results.go

@@ -5,18 +5,18 @@ import (
 	"io/ioutil"
 	"os"
 	"path"
-	"strings"
 	"time"
 
-	ui "github.com/gizak/termui/v3"
-	"github.com/gizak/termui/v3/widgets"
 	"github.com/pkg/errors"
+	ui "github.com/replicatedhq/termui/v3"
+	"github.com/replicatedhq/termui/v3/widgets"
 	"github.com/replicatedhq/troubleshoot/cmd/util"
 	analyzerunner "github.com/replicatedhq/troubleshoot/pkg/analyze"
 )
 
 var (
 	selectedResult = 0
+	table          = widgets.NewTable()
 	isShowingSaved = false
 )
 
@@ -64,15 +64,19 @@ func showInteractiveResults(preflightName string, analyzeResults []*analyzerunne
 					selectedResult++
 				} else {
 					selectedResult = 0
+					table.SelectedRow = 0
 				}
+				table.ScrollDown()
 				ui.Clear()
 				drawUI(preflightName, analyzeResults)
 			case "<Up>":
 				if selectedResult > 0 {
 					selectedResult--
 				} else {
 					selectedResult = len(analyzeResults) - 1
+					table.SelectedRow = len(analyzeResults)
 				}
+				table.ScrollUp()
 				ui.Clear()
 				drawUI(preflightName, analyzeResults)
 			}
@@ -95,7 +99,7 @@ func drawHeader(preflightName string) {
 	termWidth, _ := ui.TerminalDimensions()
 
 	title := widgets.NewParagraph()
-	title.Text = fmt.Sprintf("%s Preflight Checks", appName(preflightName))
+	title.Text = fmt.Sprintf("%s Preflight Checks", util.AppName(preflightName))
 	title.TextStyle.Fg = ui.ColorWhite
 	title.TextStyle.Bg = ui.ColorClear
 	title.TextStyle.Modifier = ui.ModifierBold
@@ -127,7 +131,6 @@ func drawFooter() {
 func drawPreflightTable(analyzeResults []*analyzerunner.AnalyzeResult) {
 	termWidth, termHeight := ui.TerminalDimensions()
 
-	table := widgets.NewTable()
 	table.SetRect(0, 3, termWidth/2, termHeight-6)
 	table.FillRow = true
 	table.Border = true
@@ -221,7 +224,7 @@ func save(preflightName string, analyzeResults []*analyzerunner.AnalyzeResult) (
 		os.Remove(filename)
 	}
 
-	results := fmt.Sprintf("%s Preflight Checks\n\n", appName(preflightName))
+	results := fmt.Sprintf("%s Preflight Checks\n\n", util.AppName(preflightName))
 	for _, analyzeResult := range analyzeResults {
 		result := ""
 
@@ -270,19 +273,3 @@ func showSaved(filename string) {
 
 	isShowingSaved = true
 }
-
-func appName(preflightName string) string {
-	words := strings.Split(strings.Title(strings.Replace(preflightName, "-", " ", -1)), " ")
-	casedWords := []string{}
-	for i, word := range words {
-		if strings.ToLower(word) == "ai" {
-			casedWords = append(casedWords, "AI")
-		} else if strings.ToLower(word) == "io" && i > 0 {
-			casedWords[i-1] += ".io"
-		} else {
-			casedWords = append(casedWords, word)
-		}
-	}
-
-	return strings.Join(casedWords, " ")
-}

cmd/preflight/cli/root.go

@@ -36,15 +36,10 @@ that a cluster meets the requirements to run an application.`,
 
 	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("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().Bool("collect-without-permissions", false, "always run preflight checks even if some require permissions that preflight does not have")
 
-	cmd.Flags().String("serviceaccount", "", "name of the service account to use. if not provided, one will be created")
-
 	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
 
 	KubernetesConfigFlags = genericclioptions.NewConfigFlags(false)

cmd/preflight/cli/run.go

@@ -11,8 +11,9 @@ import (
 	"github.com/fatih/color"
 	"github.com/pkg/errors"
 	"github.com/replicatedhq/troubleshoot/cmd/util"
-	troubleshootv1beta1 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta1"
+	troubleshootv1beta2 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta2"
 	troubleshootclientsetscheme "github.com/replicatedhq/troubleshoot/pkg/client/troubleshootclientset/scheme"
+	"github.com/replicatedhq/troubleshoot/pkg/docrewrite"
 	"github.com/replicatedhq/troubleshoot/pkg/preflight"
 	"github.com/spf13/viper"
 	spin "github.com/tj/go-spin"
@@ -23,15 +24,15 @@ func runPreflights(v *viper.Viper, arg string) error {
 	fmt.Print(cursor.Hide())
 	defer fmt.Print(cursor.Show())
 
-	preflightContent := ""
+	var preflightContent []byte
 	var err error
 	if _, err = os.Stat(arg); err == nil {
 		b, err := ioutil.ReadFile(arg)
 		if err != nil {
 			return err
 		}
 
-		preflightContent = string(b)
+		preflightContent = b
 	} else {
 		if !util.IsURL(arg) {
 			return fmt.Errorf("%s is not a URL and was not found (err %s)", arg, err)
@@ -41,7 +42,7 @@ func runPreflights(v *viper.Viper, arg string) error {
 		if err != nil {
 			return err
 		}
-		req.Header.Set("User-Agent", "Replicated_Preflight/v1beta1")
+		req.Header.Set("User-Agent", "Replicated_Preflight/v1beta2")
 		resp, err := http.DefaultClient.Do(req)
 		if err != nil {
 			return err
@@ -53,7 +54,12 @@ func runPreflights(v *viper.Viper, arg string) error {
 			return err
 		}
 
-		preflightContent = string(body)
+		preflightContent = body
+	}
+
+	preflightContent, err = docrewrite.ConvertToV1Beta2(preflightContent)
+	if err != nil {
+		return errors.Wrap(err, "failed to convert to v1beta2")
 	}
 
 	troubleshootclientsetscheme.AddToScheme(scheme.Scheme)
@@ -63,7 +69,7 @@ func runPreflights(v *viper.Viper, arg string) error {
 		return errors.Wrapf(err, "failed to parse %s", arg)
 	}
 
-	preflightSpec := obj.(*troubleshootv1beta1.Preflight)
+	preflightSpec := obj.(*troubleshootv1beta2.Preflight)
 
 	s := spin.New()
 	finishedCh := make(chan bool, 1)