cmd/eks-utils: initial commit

Signed-off-by: Gyuho Lee <leegyuho@amazon.com>

Author: gyuho

CHANGELOG-1.0.md

@@ -22,7 +22,8 @@ See [code changes](https://github.com/aws/aws-k8s-tester/compare/v1.0.1...v1.0.2
 
 - Rename [`eksconfig.Parameters.ControlPlaneSecurityGroupID` to `eksconfig.Status.ClusterControlPlaneSecurityGroupID`](https://github.com/aws/aws-k8s-tester/commit/14565868ed452f6d9ffa8335935192bcb0d42e86).
   - Does not break anything, since `ControlPlaneSecurityGroupID` was a read-only field.
-- Add [`eksconfig.Status.(k8s.io/apimachinery/pkg/version).Info`](https://github.com/aws/aws-k8s-tester/commit/ba7231019be4637e0bbbd91220b260e903ecb5b6).
+- Add [`eksconfig.Status.(k8s.io/apimachinery/pkg/version).Info` as `Status.ServerVersionInfo`](https://github.com/aws/aws-k8s-tester/commit/ba7231019be4637e0bbbd91220b260e903ecb5b6).
+- Include [`float64` version value in `ServerVersionInfo`](https://github.com/aws/aws-k8s-tester/commit/).
 
 ### `eks`
 
@@ -42,7 +43,8 @@ See [code changes](https://github.com/aws/aws-k8s-tester/compare/v1.0.1...v1.0.2
 
 - Add [`k8sclient.NewEKS` and `k8sclient.EKSConfig` for `*kubernetes.Clientset`; use `pkg/k8s-client.EKS` interface](https://github.com/aws/aws-k8s-tester/commit/e673d3388ee44889e6572dcdcee530ea06984a86).
 - Move [`healthz` checks to `k8sclient.EKS` interface](https://github.com/aws/aws-k8s-tester/commit/3dac533adcf2fb0aa51f19d4f56bbc9dd2b59eb5).
-- Add [`k8sclient.EKS.FetchVersion`](https://github.com/aws/aws-k8s-tester/commit/56cd2d0f26e88f8c806a74a503def91769a3e8e3).
+- Add [`k8sclient.EKS.FetchServerVersion`](https://github.com/aws/aws-k8s-tester/commit/56cd2d0f26e88f8c806a74a503def91769a3e8e3).
+- Include [`float64` version value in `ServerVersionInfo`](https://github.com/aws/aws-k8s-tester/commit/).
 
 ### Dependency
 

README.md

@@ -195,6 +195,35 @@ less +FG /tmp/config.yaml
 ```
 
 
-## `eks-utils api-resources`
+## `eks-utils`
 
-TODO
+Install `eks-utils` from https://github.com/aws/aws-k8s-tester/releases.
+
+**WARNING**
+
+`kubectl` internally converts API versions in the response (see [`kubernetes/issues#58131`](https://github.com/kubernetes/kubernetes/issues/58131#issuecomment-403829566)). Which means `kubectl get` output may have different API versions than the one persisted in `etcd`.
+
+Upstream recommends upgrading deprecated API with *get and put*:
+
+> the simplest approach is to get/put every object after upgrades. objects that don't need migration will no-op (they won't even increment resourceVersion in etcd). objects that do need migration will persist in the new preferred storage version
+
+```bash
+# to check supported API groups from current kube-apiserver
+eks-utils apis \
+  --kubeconfig /tmp/kubeconfig.yaml \
+  supported
+
+# to write API upgrade/rollback scripts and YAML files in "/tmp/eks-utils"
+#
+# make sure to set proper "--list-batch" and "--list-interval"
+# to not overload EKS master; if it's set too high, it can affect
+# production workloads slowing down kube-apiserver
+rm -rf /tmp/eks-utils
+eks-utils apis \
+  --kubeconfig /tmp/kubeconfig.yaml \
+  --enable-prompt \
+  deprecate \
+  --dir /tmp/eks-utils \
+  --list-batch 10 \
+  --list-interval 2s
+```

cmd/aws-k8s-tester/eks/check.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 
 	k8sclient "github.com/aws/aws-k8s-tester/pkg/k8s-client"
-	"github.com/mitchellh/colorstring"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 	"k8s.io/utils/exec"
@@ -75,14 +74,14 @@ func checkFunc(cmd *cobra.Command, args []string) {
 		panic(fmt.Errorf("failed to create client %v", err))
 	}
 
-	colorstring.Printf("\n\n\n[green]fetching version...\n\n")
-	ver, err := cli.FetchVersion()
+	fmt.Printf("\n\n************************\nfetching version\n\n")
+	ver, err := cli.FetchServerVersion()
 	if err != nil {
 		panic(fmt.Errorf("failed to check version %v", err))
 	}
 	fmt.Printf("\n\nVersion:\n%+v\n\n", ver)
 
-	colorstring.Printf("\n\n\n[green]checking health...\n\n")
+	fmt.Printf("\n\n************************\nchecking health...\n\n")
 	if err = cli.CheckHealth(); err != nil {
 		panic(fmt.Errorf("failed to check health %v", err))
 	}

cmd/eks-utils/apis/command.go

@@ -0,0 +1,59 @@
+// Package apis implements EKS API related commands.
+package apis
+
+import (
+	"io/ioutil"
+	"os"
+	"time"
+
+	"github.com/spf13/cobra"
+	"k8s.io/utils/exec"
+)
+
+var (
+	enablePrompt      bool
+	clientQPS         float32
+	clientBurst       int
+	kubeConfigPath    string
+	kubeConfigContext string
+	kubectlPath       string
+
+	listBatch    int64
+	listInterval time.Duration
+	dir          string
+)
+
+var (
+	defaultKubectlPath string
+	defaultDir         string
+)
+
+func init() {
+	cobra.EnablePrefixMatching = true
+	defaultKubectlPath, _ = exec.New().LookPath("kubectl")
+
+	var err error
+	defaultDir, err = ioutil.TempDir(os.TempDir(), "eks-upgrade-dir")
+	if err != nil {
+		panic(err)
+	}
+}
+
+// NewCommand implements "eks-utils apis" command.
+func NewCommand() *cobra.Command {
+	ac := &cobra.Command{
+		Use:   "apis",
+		Short: "EKS API commands",
+	}
+	ac.PersistentFlags().BoolVar(&enablePrompt, "enable-prompt", true, "'true' to enable prompt mode")
+	ac.PersistentFlags().Float32Var(&clientQPS, "client-qps", 5.0, "EKS client qps")
+	ac.PersistentFlags().IntVar(&clientBurst, "client-burst", 10, "EKS client burst")
+	ac.PersistentFlags().StringVar(&kubeConfigPath, "kubeconfig", "", "EKS KUBECONFIG")
+	ac.PersistentFlags().StringVar(&kubeConfigContext, "kubeconfig-context", "", "EKS KUBECONFIG context")
+	ac.PersistentFlags().StringVar(&kubectlPath, "kubectl", defaultKubectlPath, "kubectl path")
+	ac.AddCommand(
+		newSupportedCommand(),
+		newDeprecateCommand(),
+	)
+	return ac
+}

cmd/eks-utils/apis/deprecate.go

@@ -0,0 +1,66 @@
+package apis
+
+import (
+	"errors"
+	"fmt"
+	"time"
+
+	k8sclient "github.com/aws/aws-k8s-tester/pkg/k8s-client"
+	"github.com/spf13/cobra"
+	"go.uber.org/zap"
+)
+
+func newDeprecateCommand() *cobra.Command {
+	ac := &cobra.Command{
+		Use:   "deprecate",
+		Run:   deprecatedFunc,
+		Short: "Check deprecated APIs",
+		Long: `
+eks-utils apis \
+  --kubeconfig /tmp/kubeconfig.yaml \
+  deprecate
+
+eks-utils apis \
+  --kubeconfig ~/.kube/config \
+  --kubeconfig-context prow-hkg \
+  deprecate
+`,
+	}
+	ac.PersistentFlags().Int64Var(&listBatch, "list-batch", 30, "List batch limit (e.g. 30 items at a time)")
+	ac.PersistentFlags().DurationVar(&listInterval, "list-interval", 5*time.Second, "List interval")
+	ac.PersistentFlags().StringVar(&dir, "dir", defaultDir, "Directory to save all resource specs for upgrades and rollbacks")
+	return ac
+}
+
+func deprecatedFunc(cmd *cobra.Command, args []string) {
+	if kubectlPath == "" {
+		panic(errors.New("'kubectl' not found"))
+	}
+
+	fmt.Printf("\n\n************************\nstarting 'eks-utils apis upgrade'\n\n")
+
+	lg := zap.NewExample()
+	kcfg := &k8sclient.EKSConfig{
+		Logger:            lg,
+		ClientQPS:         clientQPS,
+		ClientBurst:       clientBurst,
+		KubeConfigPath:    kubeConfigPath,
+		KubeConfigContext: kubeConfigContext,
+		KubectlPath:       kubectlPath,
+		ListBatch:         listBatch,
+		ListInterval:      listInterval,
+		EnablePrompt:      enablePrompt,
+		Dir:               dir,
+	}
+	cli, err := k8sclient.NewEKS(kcfg)
+	if err != nil {
+		lg.Fatal("failed to create client", zap.Error(err))
+	}
+
+	if err = cli.Deprecate(); err != nil {
+		lg.Fatal("failed to upgrade", zap.Error(err))
+	}
+
+	println()
+	fmt.Println("'eks-utils apis upgrade' success")
+}

cmd/eks-utils/apis/supported.go

@@ -0,0 +1,76 @@
+package apis
+
+import (
+	"errors"
+	"fmt"
+	"sort"
+
+	k8sclient "github.com/aws/aws-k8s-tester/pkg/k8s-client"
+	"github.com/spf13/cobra"
+	"go.uber.org/zap"
+)
+
+func newSupportedCommand() *cobra.Command {
+	ac := &cobra.Command{
+		Use:        "supported",
+		SuggestFor: []string{"support", "getsupportedapis", "getsupportedapi", "apiresources", "apiresource", "api-resource"},
+		Run:        supportedFunc,
+		Short:      "List all supported APIs",
+		Long: `
+eks-utils apis \
+  --kubeconfig /tmp/kubeconfig.yaml \
+  supported
+
+eks-utils apis \
+  --kubeconfig ~/.kube/config \
+  --kubeconfig-context prow-hkg \
+  supported
+`,
+	}
+	ac.PersistentFlags().Float32Var(&clientQPS, "client-qps", 5.0, "EKS client qps")
+	ac.PersistentFlags().IntVar(&clientBurst, "client-burst", 10, "EKS client burst")
+	ac.PersistentFlags().StringVar(&kubeConfigPath, "kubeconfig", "", "EKS KUBECONFIG")
+	ac.PersistentFlags().StringVar(&kubeConfigContext, "kubeconfig-context", "", "EKS KUBECONFIG context")
+	ac.PersistentFlags().StringVar(&kubectlPath, "kubectl", defaultKubectlPath, "kubectl path")
+	return ac
+}
+
+func supportedFunc(cmd *cobra.Command, args []string) {
+	if kubectlPath == "" {
+		panic(errors.New("'kubectl' not found"))
+	}
+	fmt.Printf("\n\n************************\nstarting 'eks-utils apis supported'\n\n")
+
+	lg := zap.NewExample()
+
+	kcfg := &k8sclient.EKSConfig{
+		Logger:            lg,
+		ClientQPS:         clientQPS,
+		ClientBurst:       clientBurst,
+		KubeConfigPath:    kubeConfigPath,
+		KubeConfigContext: kubeConfigContext,
+		KubectlPath:       kubectlPath,
+	}
+	cli, err := k8sclient.NewEKS(kcfg)
+	if err != nil {
+		lg.Fatal("failed to create client", zap.Error(err))
+	}
+
+	vv, apiVersions, err := cli.FetchSupportedAPIGroupVersions()
+	if err != nil {
+		panic(fmt.Errorf("failed to check health %v", err))
+	}
+	ss := make([]string, 0, len(apiVersions))
+
+	fmt.Printf("\n\n************************\nchecking supported API group veresion for %.2f\n\n", vv)
+	for k := range apiVersions {
+		ss = append(ss, k)
+	}
+	sort.Strings(ss)
+	for _, v := range ss {
+		fmt.Println(v)
+	}
+
+	println()
+	fmt.Println("'eks-utils apis supported' success")
+}

cmd/eks-utils/main.go

@@ -0,0 +1,36 @@
+// eks-utils is a set of EKS utilities commands.
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/aws/aws-k8s-tester/cmd/eks-utils/apis"
+	"github.com/aws/aws-k8s-tester/cmd/eks-utils/version"
+	"github.com/spf13/cobra"
+)
+
+var rootCmd = &cobra.Command{
+	Use:        "eks-utils",
+	Short:      "AWS EKS utils CLI",
+	SuggestFor: []string{"eksutils"},
+}
+
+func init() {
+	cobra.EnablePrefixMatching = true
+}
+
+func init() {
+	rootCmd.AddCommand(
+		apis.NewCommand(),
+		version.NewCommand(),
+	)
+}
+
+func main() {
+	if err := rootCmd.Execute(); err != nil {
+		fmt.Fprintf(os.Stderr, "eks-utils failed %v\n", err)
+		os.Exit(1)
+	}
+	os.Exit(0)
+}

cmd/eks-utils/version/command.go

@@ -0,0 +1,27 @@
+// Package version implements version command.
+package version
+
+import (
+	"fmt"
+
+	"github.com/aws/aws-k8s-tester/version"
+
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	cobra.EnablePrefixMatching = true
+}
+
+// NewCommand implements "aws-k8s-tester eks" command.
+func NewCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:   "version",
+		Short: "Prints out eks-utils version",
+		Run:   versionFunc,
+	}
+}
+
+func versionFunc(cmd *cobra.Command, args []string) {
+	fmt.Print(version.Version())
+}