feat: create skeleton of k3s plugin

plugins/scheduler-k3s/.gitignore

@@ -0,0 +1,8 @@
+/commands
+/subcommands/*
+/triggers/*
+/triggers
+/scheduler-*
+/install
+/post-*
+/report

plugins/scheduler-k3s/Makefile

@@ -0,0 +1,6 @@
+SUBCOMMANDS = subcommands/report subcommands/set
+TRIGGERS = triggers/install triggers/post-app-clone-setup triggers/post-app-rename-setup triggers/post-delete triggers/report
+BUILD = commands subcommands triggers
+PLUGIN_NAME = scheduler
+
+include ../../common.mk

plugins/scheduler-k3s/go.mod

@@ -0,0 +1,20 @@
+module github.com/dokku/dokku/plugins/scheduler
+
+go 1.21
+
+require (
+	github.com/dokku/dokku/plugins/common v0.0.0-00010101000000-000000000000
+	github.com/spf13/pflag v1.0.5
+)
+
+require (
+	github.com/codegangsta/inject v0.0.0-20150114235600-33e0aa1cb7c0 // indirect
+	github.com/codeskyblue/go-sh v0.0.0-20190412065543-76bd3d59ff27 // indirect
+	github.com/joho/godotenv v1.2.0 // indirect
+	github.com/otiai10/copy v1.14.0 // indirect
+	github.com/ryanuber/columnize v2.1.2+incompatible // indirect
+	golang.org/x/sync v0.5.0 // indirect
+	golang.org/x/sys v0.13.0 // indirect
+)
+
+replace github.com/dokku/dokku/plugins/common => ../common

plugins/scheduler-k3s/plugin.toml

@@ -0,0 +1,4 @@
+[plugin]
+description = "dokku core scheduler-k3s plugin"
+version = "0.32.3"
+[plugin.config]

plugins/scheduler-k3s/report.go

@@ -0,0 +1,24 @@
+package scheduler_k3s
+
+import (
+	"github.com/dokku/dokku/plugins/common"
+)
+
+// ReportSingleApp is an internal function that displays the scheduler-k3s report for one or more apps
+func ReportSingleApp(appName string, format string, infoFlag string) error {
+	if err := common.VerifyAppName(appName); err != nil {
+		return err
+	}
+
+	flags := map[string]common.ReportFunc{}
+
+	flagKeys := []string{}
+	for flagKey := range flags {
+		flagKeys = append(flagKeys, flagKey)
+	}
+
+	trimPrefix := false
+	uppercaseFirstCharacter := true
+	infoFlags := common.CollectReport(appName, infoFlag, flags)
+	return common.ReportSingleApp("scheduler-k3s", appName, infoFlag, infoFlags, flagKeys, format, trimPrefix, uppercaseFirstCharacter)
+}

plugins/scheduler-k3s/scheduler_k3s.go

@@ -0,0 +1,12 @@
+package scheduler_k3s
+
+var (
+	// DefaultProperties is a map of all valid network properties with corresponding default property values
+	DefaultProperties = map[string]string{}
+
+	// GlobalProperties is a map of all valid global network properties
+	GlobalProperties = map[string]bool{
+		"network-interface": true,
+		"token":             true,
+	}
+)

plugins/scheduler-k3s/src/commands/commands.go

@@ -0,0 +1,56 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"strconv"
+	"strings"
+
+	"github.com/dokku/dokku/plugins/common"
+)
+
+const (
+	helpHeader = `Usage: dokku scheduler-k3s[:COMMAND]
+
+Manage scheduler-k3s settings for an app
+
+Additional commands:`
+
+	helpContent = `
+    scheduler-k3s:report [<app>] [<flag>], Displays a scheduler-k3s report for one or more apps
+    scheduler-k3s:set <app> <property> (<value>), Set or clear a scheduler-k3s property for an app
+`
+)
+
+func main() {
+	flag.Usage = usage
+	flag.Parse()
+
+	cmd := flag.Arg(0)
+	switch cmd {
+	case "scheduler-k3s", "scheduler-k3s:help":
+		usage()
+	case "help":
+		command := common.NewShellCmd(fmt.Sprintf("ps -o command= %d", os.Getppid()))
+		command.ShowOutput = false
+		output, err := command.Output()
+
+		if err == nil && strings.Contains(string(output), "--all") {
+			fmt.Println(helpContent)
+		} else {
+			fmt.Print("\n    scheduler-k3s, Manage scheduler-k3s settings for an app\n")
+		}
+	default:
+		dokkuNotImplementExitCode, err := strconv.Atoi(os.Getenv("DOKKU_NOT_IMPLEMENTED_EXIT"))
+		if err != nil {
+			fmt.Println("failed to retrieve DOKKU_NOT_IMPLEMENTED_EXIT environment variable")
+			dokkuNotImplementExitCode = 10
+		}
+		os.Exit(dokkuNotImplementExitCode)
+	}
+}
+
+func usage() {
+	common.CommandUsage(helpHeader, helpContent)
+}

plugins/scheduler-k3s/src/subcommands/subcommands.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/dokku/dokku/plugins/common"
+	scheduler_k3s "github.com/dokku/dokku/plugins/scheduler-k3s"
+
+	flag "github.com/spf13/pflag"
+)
+
+// main entrypoint to all subcommands
+func main() {
+	parts := strings.Split(os.Args[0], "/")
+	subcommand := parts[len(parts)-1]
+
+	var err error
+	switch subcommand {
+	case "report":
+		args := flag.NewFlagSet("scheduler-k3s:report", flag.ExitOnError)
+		format := args.String("format", "stdout", "format: [ stdout | json ]")
+		osArgs, infoFlag, flagErr := common.ParseReportArgs("scheduler-k3s", os.Args[2:])
+		if flagErr == nil {
+			args.Parse(osArgs)
+			appName := args.Arg(0)
+			err = scheduler_k3s.CommandReport(appName, *format, infoFlag)
+		}
+	case "set":
+		args := flag.NewFlagSet("scheduler-k3s:set", flag.ExitOnError)
+		global := args.Bool("global", false, "--global: set a global property")
+		args.Parse(os.Args[2:])
+		appName := args.Arg(0)
+		property := args.Arg(1)
+		value := args.Arg(2)
+		if *global {
+			appName = "--global"
+			property = args.Arg(0)
+			value = args.Arg(1)
+		}
+		err = scheduler_k3s.CommandSet(appName, property, value)
+	default:
+		err = fmt.Errorf("Invalid plugin subcommand call: %s", subcommand)
+	}
+
+	if err != nil {
+		common.LogFailWithError(err)
+	}
+}

plugins/scheduler-k3s/src/triggers/triggers.go

@@ -0,0 +1,45 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	flag "github.com/spf13/pflag"
+
+	"github.com/dokku/dokku/plugins/common"
+	scheduler_k3s "github.com/dokku/dokku/plugins/scheduler-k3s"
+)
+
+// main entrypoint to all triggers
+func main() {
+	parts := strings.Split(os.Args[0], "/")
+	trigger := parts[len(parts)-1]
+	flag.Parse()
+
+	var err error
+	switch trigger {
+	case "install":
+		err = scheduler_k3s.TriggerInstall()
+	case "post-app-clone-setup":
+		oldAppName := flag.Arg(0)
+		newAppName := flag.Arg(1)
+		err = scheduler_k3s.TriggerPostAppCloneSetup(oldAppName, newAppName)
+	case "post-app-rename-setup":
+		oldAppName := flag.Arg(0)
+		newAppName := flag.Arg(1)
+		err = scheduler_k3s.TriggerPostAppRenameSetup(oldAppName, newAppName)
+	case "post-delete":
+		appName := flag.Arg(0)
+		err = scheduler_k3s.TriggerPostDelete(appName)
+	case "report":
+		appName := flag.Arg(0)
+		err = scheduler_k3s.ReportSingleApp(appName, "", "")
+	default:
+		err = fmt.Errorf("Invalid plugin trigger call: %s", trigger)
+	}
+
+	if err != nil {
+		common.LogFailWithError(err)
+	}
+}

plugins/scheduler-k3s/subcommands.go

@@ -0,0 +1,29 @@
+package scheduler_k3s
+
+import (
+	"github.com/dokku/dokku/plugins/common"
+)
+
+// CommandReport displays a scheduler-k3s report for one or more apps
+func CommandReport(appName string, format string, infoFlag string) error {
+	if len(appName) == 0 {
+		apps, err := common.DokkuApps()
+		if err != nil {
+			return err
+		}
+		for _, appName := range apps {
+			if err := ReportSingleApp(appName, format, infoFlag); err != nil {
+				return err
+			}
+		}
+		return nil
+	}
+
+	return ReportSingleApp(appName, format, infoFlag)
+}
+
+// CommandSet set or clear a scheduler-k3s property for an app
+func CommandSet(appName string, property string, value string) error {
+	common.CommandPropertySet("scheduler-k3s", appName, property, value, DefaultProperties, GlobalProperties)
+	return nil
+}

plugins/scheduler-k3s/triggers.go

@@ -0,0 +1,51 @@
+package scheduler_k3s
+
+import (
+	"fmt"
+
+	"github.com/dokku/dokku/plugins/common"
+)
+
+// TriggerInstall runs the install step for the scheduler-k3s plugin
+func TriggerInstall() error {
+	if err := common.PropertySetup("scheduler-k3s"); err != nil {
+		return fmt.Errorf("Unable to install the scheduler-k3s plugin: %s", err.Error())
+	}
+
+	return nil
+}
+
+// TriggerPostAppCloneSetup creates new scheduler-k3s files
+func TriggerPostAppCloneSetup(oldAppName string, newAppName string) error {
+	err := common.PropertyClone("scheduler-k3s", oldAppName, newAppName)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// TriggerPostAppRenameSetup renames scheduler-k3s files
+func TriggerPostAppRenameSetup(oldAppName string, newAppName string) error {
+	if err := common.PropertyClone("scheduler-k3s", oldAppName, newAppName); err != nil {
+		return err
+	}
+
+	if err := common.PropertyDestroy("scheduler-k3s", oldAppName); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// TriggerPostDelete destroys the scheduler-k3s data for a given app container
+func TriggerPostDelete(appName string) error {
+	dataErr := common.RemoveAppDataDirectory("scheduler-k3s", appName)
+	propertyErr := common.PropertyDestroy("scheduler-k3s", appName)
+
+	if dataErr != nil {
+		return dataErr
+	}
+
+	return propertyErr
+}