Merge pull request #5 from nginxinc/areste-changes

Improvements on CLI params and tarball creation

Author: dareste

Makefile

@@ -0,0 +1,5 @@
+build:
+	go build -o cmd/kubectl-kic-supportpkg
+
+install: build
+	sudo cp cmd/kubectl-kic-supportpkg /usr/local/bin

README.md

@@ -1 +1,51 @@
-# kubectl-kic-supportpkg
+# kubectl-kic-supportpkg
+
+A kubectl plugin designed to collect diagnostics information on the designated namespaces.
+
+## Features
+
+The plugin collects the following global and namespace-specific information:
+
+- k8s version, nodes information and CRDs
+- pods logs
+- list of pods, events, configmaps, services, deployments, statefulsets, replicasets and leases
+- k8s metrics
+- helm deployments
+
+## Installation
+
+Clone the repo and run `make install`. This will build the binary and copy it on `/usr/local/bin/`.
+
+Verify that the plugin is properly found by `kubectl`:
+
+```
+$ kubectl plugin list
+The following compatible plugins are available:
+
+/usr/local/bin/kubectl-kic-supportpkg
+```
+
+## Usage
+
+The plugin is invoked via `kubectl kic supportpkg` and has only one required flag, `-n` or `--namespace`:
+
+```
+$ kubectl kic supportpkg -n default -n nginx-ingress-0
+Running job pod-list... OK
+Running job collect-pods-logs... OK
+Running job events-list... OK
+Running job configmap-list... OK
+Running job service-list... OK
+Running job deployment-list... OK
+Running job statefulset-list... OK
+Running job replicaset-list... OK
+Running job lease-list... OK
+Running job k8s-version... OK
+Running job crd-info... OK
+Running job nodes-info... OK
+Running job metrics-information... OK
+Running job helm-info... OK
+Running job helm-deployments... OK
+Supportpkg successfully generated: kic-supportpkg-1711384966.tar.gz
+
+```

cmd/kic-supportpkg.go

@@ -28,22 +28,25 @@ func Execute() {
 				fmt.Printf("Running job %s...", job.Name)
 				err = job.Collect(collector)
 				if err != nil {
-					fmt.Printf("Error: %s", err)
+					fmt.Printf("Error: %s\n", err)
 				} else {
 					fmt.Print(" OK\n")
 				}
 			}
 
-			err = collector.WrapUp()
+			tarFile, err := collector.WrapUp()
 			if err != nil {
 				fmt.Println(fmt.Errorf("error when wrapping up: %s", err))
 				os.Exit(1)
+			} else {
+				fmt.Printf("Supportpkg successfully generated: %s\n", tarFile)
 			}
 		},
 	}
 
-	rootCmd.Flags().StringSliceVarP(&namespaces, "namespace", "n", []string{}, "comma-separated list of namespaces to collect information from")
-	rootCmd.SetUsageTemplate("Usage: \n kic-supportpkg -n namespace1 -n namespace2 ...")
+	rootCmd.Flags().StringSliceVarP(&namespaces, "namespace", "n", []string{}, "list of namespaces to collect information from")
+	rootCmd.MarkFlagRequired("namespace")
+	rootCmd.SetUsageTemplate("Usage: \n kic supportpkg [-n|--namespace] ns1 [-n|--namespace] ns2 ...\n kic supportpkg [-n|--namespace] ns1,ns2 ...\n")
 
 	if err := rootCmd.Execute(); err != nil {
 		fmt.Println(err)

pkg/data_collector/data_collector.go

@@ -35,12 +35,14 @@ func NewDataCollector(namespaces ...string) (*DataCollector, error) {
 	}
 
 	// Find config
-	home := homedir.HomeDir()
-	kubeConfig := filepath.Join(home, ".kube", "config")
+	kubeConfig := os.Getenv("KUBECONFIG")
+	if kubeConfig == "" {
+		kubeConfig = filepath.Join(homedir.HomeDir(), ".kube", "config")
+	}
 	config, err := clientcmd.BuildConfigFromFlags("", kubeConfig)
 
 	if err != nil {
-		return nil, fmt.Errorf("unable to create k8s config: %s", err)
+		return nil, fmt.Errorf("unable to connect to k8s using file %s: %s", kubeConfig, err)
 	}
 
 	dc := DataCollector{
@@ -63,17 +65,15 @@ func NewDataCollector(namespaces ...string) (*DataCollector, error) {
 	return &dc, nil
 }
 
-func (c *DataCollector) WrapUp() error {
+func (c *DataCollector) WrapUp() (string, error) {
 
-	// Create the tarball file
-	//wd, _ := os.Getwd()
 	unixTime := time.Now().Unix()
 	unixTimeString := strconv.FormatInt(unixTime, 10)
 	tarballName := fmt.Sprintf("kic-supportpkg-%s.tar.gz", unixTimeString)
 
 	file, err := os.Create(tarballName)
 	if err != nil {
-		return err
+		return "", err
 	}
 	defer file.Close()
 
@@ -92,18 +92,22 @@ func (c *DataCollector) WrapUp() error {
 		if err != nil {
 			return err
 		}
-		header.Name = path
-		//TODO: correct this to relative path
 
-		if err := tw.WriteHeader(header); err != nil {
+		relativePath, err := filepath.Rel(c.BaseDir, path)
+		if err != nil {
+			return err
+		}
+		header.Name = relativePath
+
+		if err = tw.WriteHeader(header); err != nil {
 			return err
 		}
 
 		if !info.Mode().IsRegular() {
 			return nil
 		}
 
-		file, err := os.Open(path)
+		file, err = os.Open(path)
 		if err != nil {
 			return err
 		}
@@ -116,8 +120,6 @@ func (c *DataCollector) WrapUp() error {
 
 		return nil
 	})
-
-	fmt.Println("Tarball created successfully:", tarballName)
-	os.RemoveAll(c.BaseDir)
-	return nil
+	_ = os.RemoveAll(c.BaseDir)
+	return tarballName, nil
 }

pkg/jobs/job_list.go

@@ -54,6 +54,20 @@ func JobList() []Job {
 				return results
 			},
 		},
+		{
+			Name:   "events-list",
+			Global: false,
+			Execute: func(dc *data_collector.DataCollector, ctx context.Context) map[string][]byte {
+				jobResults := make(map[string][]byte)
+				for _, namespace := range dc.Namespaces {
+					result, _ := dc.K8sCoreClientSet.CoreV1().Events(namespace).List(ctx, metav1.ListOptions{})
+					jsonResult, _ := json.MarshalIndent(result, "", "  ")
+					jobResults[path.Join(dc.BaseDir, namespace, "events.json")] = jsonResult
+				}
+
+				return jobResults
+			},
+		},
 		{
 			Name:   "configmap-list",
 			Global: false,