Adjust For Release

Makefile

@@ -1,6 +1,6 @@
 
 build:
-	go build -o bin/kubectl-tks
+	go build -o bin/kubectl-check
 
 install: build
-	mv bin/kubectl-tks /usr/local/bin/kubectl-tks
+	mv bin/kubectl-check /usr/local/bin/kubectl-check

cmd/check_endoflife.go

@@ -16,15 +16,12 @@ import (
 var (
 	getEKS        bool
 	getKubernetes bool
-
-// getVersionNext bool
 )
 
 func init() {
-	checkCmd.AddCommand(endOfLifeCmd)
+	rootCmd.AddCommand(endOfLifeCmd)
 	endOfLifeCmd.PersistentFlags().BoolVarP(&getEKS, "eks", "e", false, "retrieve EKS endoflife data")
 	endOfLifeCmd.PersistentFlags().BoolVarP(&getKubernetes, "kubernetes", "k", true, "retrieve Kubernetes endoflife data")
-	// getVersionsCmd.PersistentFlags().BoolVarP(&getVersionNext, "next", "n", false, "get next version information")
 }
 
 // AmazonEKSRelease represents the data found at

cmd/check_versions.go

@@ -24,23 +24,10 @@ var (
 )
 
 func init() {
-	checkCmd.AddCommand(getVersionsCmd)
+	rootCmd.AddCommand(getVersionsCmd)
 	getVersionsCmd.PersistentFlags().StringVarP(&kubeVersion, "kube-version", "k", "v1.19", "the version of dependencies to check against")
 }
 
-// need to retrieve these components as well as current version, required version for upgrade
-// 		aws-cni
-//		aws-alb-controller
-//		cert-manager
-//		coredns
-//		kube-proxy
-//		kube-state-metrics
-//		metrics-server
-//		node-problem-detector
-//		nvidia-device-plugin
-//		cluster-autoscaler
-//
-
 type Service struct {
 	Name    string
 	Version string
@@ -73,11 +60,14 @@ var getVersionsCmd = &cobra.Command{
 		}
 
 		// get all the current versions of deployments running in kube-system
+		// 	TODO(redman): make namespaces configurable through flags
 		svcs, err := getAllServices(clientset, []string{"kube-system", "platform", "cert-manager"})
 		if err != nil {
 			return err
 		}
 
+		// load the data from the embedded config
+		//	TODO(redman): allow override of embedded config for custom configuration
 		versions, err := loadKubernetesVersions()
 		if err != nil {
 			return err
@@ -95,13 +85,15 @@ var getVersionsCmd = &cobra.Command{
 				continue
 			}
 
+			// if is latest, depend and set to false
 			if s.Version == "latest" {
 				t.Rows = append(t.Rows, metav1.TableRow{
 					Cells: []interface{}{s.Name, false, s.Version, req},
 				})
 				continue
 			}
 
+			// determine if component is out of date
 			o, err := isOutOfDate(req, s.Version)
 			if err != nil {
 				return fmt.Errorf("failed to calculate out of date for %s: %s", s.Name, err)
@@ -119,6 +111,9 @@ var getVersionsCmd = &cobra.Command{
 	},
 }
 
+// isOutOfDate takes two semantic version numbers and compares
+// them to determine whether the current version is above or
+// equal to the required version.
 func isOutOfDate(required, current string) (bool, error) {
 	r, err := semver.Make(strings.ReplaceAll(required, "v", ""))
 	if err != nil {
@@ -186,6 +181,8 @@ func getAllServices(clientset *kubernetes.Clientset, namespaces []string) (Servi
 	return svcs, nil
 }
 
+// loadKubernetesVersions take the config that is embedded and unmarshals
+// it into a a struct that can be worked with
 func loadKubernetesVersions() (KubernetesVersions, error) {
 	var versions KubernetesVersions
 	if err := json.Unmarshal(componentsConfig, &versions); err != nil {