Initial commit for kubernetes scheduler simulator

Author: mental2008

.gitignore

@@ -0,0 +1,19 @@
+.idea
+.vscode
+
+.DS_Store
+*.tgz
+*.tar
+*.log
+
+__pycache__
+.ipynb_checkpoints
+bin/*
+kubeconfig
+configmap-simon.yaml
+
+data
+logs
+experiments
+example/snapshot
+config/cluster-config/

Makefile

@@ -0,0 +1,12 @@
+OUTPUT_DIR=./bin
+BINARY_NAME=simon
+LINUX_BINARY_NAME=simon_linux
+
+.PHONY: local_build
+local_build:
+	GOARCH=amd64 GOOS=darwin go build -v -o $(OUTPUT_DIR)/$(BINARY_NAME) ./cmd
+
+.PHONY: linux_build
+linux_build:
+	GOARCH=amd64 GOOS=linux go build -v -o $(OUTPUT_DIR)/$(LINUX_BINARY_NAME) ./cmd
+	chmod +x $(OUTPUT_DIR)/$(LINUX_BINARY_NAME)

README.md

@@ -0,0 +1,20 @@
+## Environment Setup
+
+Please ensure that Go is installed. `go mod vendor` will install the dependencies required for the simulator, and `make` will generate the compiled binary fils in the `bin` directory.
+
+```bash
+$ go mod vendor
+$ make local_build
+$ make linux_build
+```
+
+## QuickStart Example
+
+```bash
+$  LOGLEVEL=DEBUG bin/simon apply --extended-resources "gpu" -s example/test-scheduler-config.yaml -f example/test-cluster-config.yaml
+```
+
+## Acknowledge
+
+Our simulator is developed based on [Alibaba's open-simulator](https://github.com/alibaba/open-simulator), a simulator used for cluster capacity planning. 
+The GPU-related plugin has been incorporated into its main branch.

cmd/apply/apply.go

@@ -0,0 +1,36 @@
+package apply
+
+import (
+	"fmt"
+	"os"
+
+	applypkg "github.com/hkust-adsl/kubernetes-scheduler-simulator/pkg/apply"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+)
+
+var options = applypkg.Options{}
+
+var ApplyCmd = &cobra.Command{
+	Use:   "apply",
+	Short: "Make a reasonable cluster capacity planning based on application resource requirements",
+	Run: func(cmd *cobra.Command, args []string) {
+		applier := applypkg.NewApplier(options)
+		if err := applier.Run(); err != nil {
+			fmt.Printf("apply error: %s", err.Error())
+			os.Exit(1)
+		}
+	},
+}
+
+func init() {
+	ApplyCmd.Flags().StringVarP(&options.SimonConfig, "simon-config", "f", options.SimonConfig, "path to the cluster kube-config file used to connect cluster, one of both kube-config and cluster-config must exist.")
+	ApplyCmd.Flags().StringVarP(&options.DefaultSchedulerConfigFile, "default-scheduler-config", "s", options.DefaultSchedulerConfigFile, "path to JSON or YAML file containing scheduler configuration.")
+	ApplyCmd.Flags().BoolVar(&options.UseGreed, "use-greed", false, "use greedy algorithm when queue pods")
+	ApplyCmd.Flags().BoolVarP(&options.Interactive, "interactive", "i", false, "interactive mode")
+	ApplyCmd.Flags().StringSliceVarP(&options.ExtendedResources, "extended-resources", "e", nil, "show extended resources when reporting, e.g. open-local, gpu")
+
+	if err := ApplyCmd.MarkFlagRequired("simon-config"); err != nil {
+		log.Fatal("failed to init ApplyCmd on simon-config flag")
+	}
+}

cmd/debug/debug.go

@@ -0,0 +1,34 @@
+package debug
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var options = Options{}
+
+// DebugCmd is only for debug
+var DebugCmd = &cobra.Command{
+	Use:   "debug",
+	Short: "debug alpha feature",
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := run(&options); err != nil {
+			fmt.Printf("debug error: %s", err.Error())
+			os.Exit(1)
+		}
+	},
+}
+
+func init() {
+	options.AddFlags(DebugCmd.Flags())
+	if err := DebugCmd.MarkFlagRequired("filepath"); err != nil {
+		fmt.Printf("debug init error: %s", err.Error())
+		os.Exit(1)
+	}
+}
+
+func run(opt *Options) error {
+	return nil
+}

cmd/debug/options.go

@@ -0,0 +1,15 @@
+package debug
+
+import (
+	"github.com/spf13/pflag"
+)
+
+// Options is the combined set of options for all operating modes.
+type Options struct {
+	Kubeconfig string
+}
+
+// AddFlags will add the flag to the pflag.FlagSet
+func (options *Options) AddFlags(fs *pflag.FlagSet) {
+	fs.StringVar(&options.Kubeconfig, "kubeconfig", options.Kubeconfig, "Path to the kubeconfig file to use for the analysis.")
+}

cmd/doc/generate_markdown.go

@@ -0,0 +1,38 @@
+package doc
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/cobra/doc"
+)
+
+type GenerateDoc struct {
+	DocCmd    *cobra.Command
+	outputDir string
+}
+
+var GenDoc = &GenerateDoc{}
+
+func init() {
+	GenDoc.DocCmd = &cobra.Command{
+		Use:           "gen-doc",
+		Short:         "Generate markdown document for your project",
+		Args:          cobra.NoArgs,
+		SilenceErrors: true,
+		SilenceUsage:  true,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return GenDoc.generateDocument()
+		},
+	}
+
+	GenDoc.DocCmd.Flags().StringVarP(&GenDoc.outputDir, "output-directory", "d", "./docs/commandline", "assign a directory to store documents")
+}
+
+func (c *GenerateDoc) generateDocument() error {
+	if _, err := os.Stat(c.outputDir); err != nil {
+		return fmt.Errorf("Invalid output directory(%s) ", c.outputDir)
+	}
+	return doc.GenMarkdownTree(c.DocCmd.Parent(), c.outputDir)
+}

cmd/main.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/hkust-adsl/kubernetes-scheduler-simulator/cmd/simon"
+)
+
+func main() {
+	cmd := simon.NewSimonCommand()
+	if err := cmd.Execute(); err != nil {
+		fmt.Printf("start with error: %s", err.Error())
+		os.Exit(1)
+	}
+}

cmd/simon/simon.go

@@ -0,0 +1,64 @@
+package simon
+
+import (
+	goflag "flag"
+	log "github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+	cliflag "k8s.io/component-base/cli/flag"
+	"os"
+
+	"github.com/hkust-adsl/kubernetes-scheduler-simulator/cmd/apply"
+	"github.com/hkust-adsl/kubernetes-scheduler-simulator/cmd/doc"
+	"github.com/hkust-adsl/kubernetes-scheduler-simulator/cmd/version"
+)
+
+const (
+	EnvLogLevel = "LOGLEVEL"
+	LogPanic    = "PANIC"
+	LogFatal    = "FATAL"
+	LogError    = "ERROR"
+	LogWarn     = "WARN"
+	LogInfo     = "INFO"
+	LogDebug    = "DEBUG"
+	LogTrace    = "TRACE"
+)
+
+func NewSimonCommand() *cobra.Command {
+	simonCmd := &cobra.Command{
+		Use:   "simon",
+		Short: "Simon is a simulator, which will simulate a cluster and simulate workload scheduling.",
+	}
+
+	simonCmd.AddCommand(
+		version.VersionCmd,
+		apply.ApplyCmd,
+		doc.GenDoc.DocCmd,
+	)
+	simonCmd.SetGlobalNormalizationFunc(cliflag.WordSepNormalizeFunc)
+	simonCmd.Flags().AddGoFlagSet(goflag.CommandLine)
+	simonCmd.DisableAutoGenTag = true
+
+	return simonCmd
+}
+
+func init() {
+	logLevel := os.Getenv(EnvLogLevel)
+	switch logLevel {
+	case LogPanic:
+		log.SetLevel(log.PanicLevel)
+	case LogFatal:
+		log.SetLevel(log.FatalLevel)
+	case LogError:
+		log.SetLevel(log.ErrorLevel)
+	case LogWarn:
+		log.SetLevel(log.WarnLevel)
+	case LogInfo:
+		log.SetLevel(log.InfoLevel)
+	case LogDebug:
+		log.SetLevel(log.DebugLevel)
+	case LogTrace:
+		log.SetLevel(log.TraceLevel)
+	default:
+		log.SetLevel(log.InfoLevel)
+	}
+}

cmd/version/version.go

@@ -0,0 +1,23 @@
+package version
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+	// VERSION is version of CSI Pangu Driver
+	VERSION = ""
+	// COMMITID is commit ID of code
+	COMMITID = ""
+)
+
+var VersionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Print the version of simon",
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("Version: %s\n", VERSION)
+		fmt.Printf("Commit: %s\n", COMMITID)
+	},
+}