fix: KIC to NIC rebranding

Author: dareste

Makefile

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

README.md

@@ -1,6 +1,6 @@
-# kubectl-kic-supportpkg
+# nginx-k8s-supportpkg
 
-A kubectl plugin designed to collect diagnostics information on the designated namespaces.
+A kubectl plugin designed to collect NIC diagnostics information on the designated namespaces.
 
 ## Features
 
@@ -11,7 +11,7 @@ The plugin collects the following global and namespace-specific information:
 - list of pods, events, configmaps, services, deployments, statefulsets, replicasets and leases
 - k8s metrics
 - helm deployments
-- `nginx -T` output from the KIC pods
+- `nginx -T` output from the NIC pods
 
 ## Installation
 
@@ -23,15 +23,15 @@ Verify that the plugin is properly found by `kubectl`:
 $ kubectl plugin list
 The following compatible plugins are available:
 
-/usr/local/bin/kubectl-kic-supportpkg
+/usr/local/bin/kubectl-nic-supportpkg
 ```
 
 ## Usage
 
-The plugin is invoked via `kubectl kic supportpkg` and has only one required flag, `-n` or `--namespace`:
+The plugin is invoked via `kubectl nic supportpkg` and has only one required flag, `-n` or `--namespace`:
 
 ```
-$ kubectl kic supportpkg -n default -n nginx-ingress-0
+$ kubectl nic supportpkg -n default -n nginx-ingress-0
 Running job pod-list... OK
 Running job collect-pods-logs... OK
 Running job events-list... OK
@@ -47,6 +47,6 @@ 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
+Supportpkg successfully generated: nic-supportpkg-1711384966.tar.gz
 
 ```

cmd/kic-supportpkg.go renamed to cmd/nic-supportpkg.go

@@ -2,8 +2,8 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/nginxinc/kubectl-kic-supportpkg/pkg/data_collector"
-	"github.com/nginxinc/kubectl-kic-supportpkg/pkg/jobs"
+	"github.com/nginxinc/nginx-k8s-supportpkg/pkg/data_collector"
+	"github.com/nginxinc/nginx-k8s-supportpkg/pkg/jobs"
 	"github.com/spf13/cobra"
 	"os"
 )
@@ -13,9 +13,9 @@ func Execute() {
 	var namespaces []string
 
 	var rootCmd = &cobra.Command{
-		Use:   "kic-supportpkg",
-		Short: "kic-supportpkg - a tool to create Ingress Controller diagnostics package",
-		Long:  `kic-supportpkg - a tool to create Ingress Controller diagnostics package`,
+		Use:   "nic-supportpkg",
+		Short: "nic-supportpkg - a tool to create Ingress Controller diagnostics package",
+		Long:  `nic-supportpkg - a tool to create Ingress Controller diagnostics package`,
 		Run: func(cmd *cobra.Command, args []string) {
 
 			collector, err := data_collector.NewDataCollector(namespaces...)
@@ -46,7 +46,7 @@ func Execute() {
 
 	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")
+	rootCmd.SetUsageTemplate("Usage: \n nic supportpkg [-n|--namespace] ns1 [-n|--namespace] ns2 ...\n nic supportpkg [-n|--namespace] ns1,ns2 ...\n")
 
 	if err := rootCmd.Execute(); err != nil {
 		fmt.Println(err)

go.mod

@@ -1,4 +1,4 @@
-module github.com/nginxinc/kubectl-kic-supportpkg
+module github.com/nginxinc/nginx-k8s-supportpkg
 
 go 1.21.5
 

main.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/nginxinc/kubectl-kic-supportpkg/cmd"
+	"github.com/nginxinc/nginx-k8s-supportpkg/cmd"
 )
 
 func main() {

pkg/data_collector/data_collector.go

@@ -38,12 +38,12 @@ type DataCollector struct {
 
 func NewDataCollector(namespaces ...string) (*DataCollector, error) {
 
-	tmpDir, err := os.MkdirTemp("", "kic-diag")
+	tmpDir, err := os.MkdirTemp("", "nic-diag")
 	if err != nil {
 		return nil, fmt.Errorf("unable to create temp directory: %s", err)
 	}
 
-	logFile, err := os.OpenFile(filepath.Join(tmpDir, "kic-supportpkg.log"), os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
+	logFile, err := os.OpenFile(filepath.Join(tmpDir, "nic-supportpkg.log"), os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
 	if err != nil {
 		return nil, fmt.Errorf("unable to create log file: %s", err)
 	}
@@ -86,8 +86,8 @@ func (c *DataCollector) WrapUp() (string, error) {
 
 	unixTime := time.Now().Unix()
 	unixTimeString := strconv.FormatInt(unixTime, 10)
-	tarballName := fmt.Sprintf("kic-supportpkg-%s.tar.gz", unixTimeString)
-	tarballRootDirName := fmt.Sprintf("kic-supportpkg-%s", unixTimeString)
+	tarballName := fmt.Sprintf("nic-supportpkg-%s.tar.gz", unixTimeString)
+	tarballRootDirName := fmt.Sprintf("nic-supportpkg-%s", unixTimeString)
 
 	c.LogFile.Close()
 

pkg/jobs/job.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/nginxinc/kubectl-kic-supportpkg/pkg/data_collector"
+	"github.com/nginxinc/nginx-k8s-supportpkg/pkg/data_collector"
 	"os"
 	"path"
 	"time"

pkg/jobs/job_list.go

@@ -5,7 +5,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"github.com/nginxinc/kubectl-kic-supportpkg/pkg/data_collector"
+	"github.com/nginxinc/nginx-k8s-supportpkg/pkg/data_collector"
 	"io"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"