Create CLI using github.com/alecthomas/kong

api, filesystem, and kubernetes are now sub commands

Author: metalmatze

.github/workflows/go.yaml

@@ -22,4 +22,4 @@ jobs:
           go-version: ${{ env.golang-version }}
       - run: mkdir -p cmd/api/ui/build && touch cmd/api/ui/build/empty
       - run: make test
-      - run: make api kubernetes filesystem
+      - run: make api

Makefile

@@ -1,6 +1,5 @@
 # Image URL to use all building/pushing image targets
 IMG_API ?= api:latest
-IMG_KUBERNETES ?= kubernetes:latest
 
 # Produce CRDs that work back to Kubernetes 1.11 (no version conversion)
 CRD_OPTIONS ?= "crd:trivialVersions=true"
@@ -26,19 +25,11 @@ clean:
 test: generate fmt vet manifests
 	go test -race ./... -coverprofile cover.out
 
-build: kubernetes filesystem api
-
-# Build kubernetes binary
-kubernetes: generate fmt vet
-	CGO_ENABLED=0 go build -v -ldflags '-w -extldflags '-static'' -o bin/kubernetes ./cmd/kubernetes/main.go
-
-# Build kubernetes binary
-filesystem: generate fmt vet
-	CGO_ENABLED=0 go build -v -ldflags '-w -extldflags '-static'' -o bin/filesystem ./cmd/filesystem/main.go
+build: api
 
 # Build api binary
 api: fmt vet
-	CGO_ENABLED=0 go build -v -ldflags '-w -extldflags '-static'' -o bin/api ./cmd/api/main.go
+	CGO_ENABLED=0 go build -v -ldflags '-w -extldflags '-static'' -o bin/api ./cmd/api
 
 # Deploy controller in the configured Kubernetes cluster in ~/.kube/config
 deploy: manifests config/api.yaml config/kubernetes.yaml
@@ -74,23 +65,17 @@ generate: controller-gen manifests
 	$(CONTROLLER_GEN) object:headerFile="kubernetes/hack/boilerplate.go.txt" paths="./..."
 
 # Build the docker image
-docker-build: docker-build-api docker-build-kubernetes
+docker-build: docker-build-api
 
 docker-build-api:
 	docker build . -t ${IMG_API} -f ./cmd/api/Dockerfile
 
-docker-build-kubernetes:
-	docker build . -t ${IMG_KUBERNETES} -f ./cmd/kubernetes/Dockerfile
-
 # Push the docker image
-docker-push: docker-push-api docker-push-kubernetes
+docker-push: docker-push-api
 
 docker-push-api:
 	docker push ${IMG_API}
 
-docker-push-kubernetes:
-	docker push ${IMG_KUBERNETES}
-
 # find or download controller-gen
 # download controller-gen if necessary
 controller-gen:

cmd/api/Dockerfile

@@ -20,7 +20,6 @@ COPY cmd/api/ cmd/api/
 COPY kubernetes/ kubernetes/
 COPY openapi/ openapi/
 COPY slo/ slo/
-COPY slo/ slo/
 COPY go.mod go.mod
 COPY go.sum go.sum
 COPY Makefile Makefile

cmd/filesystem/main.go renamed to cmd/api/filesystem.go

@@ -20,7 +20,7 @@ import (
 
 var objectives = map[string]slo.Objective{}
 
-func main() {
+func cmdFilesystem(configFiles, prometheusFolder string) {
 	var gr run.Group
 
 	ctx, cancel := context.WithCancel(context.Background())
@@ -29,7 +29,7 @@ func main() {
 	{
 		gr.Add(func() error {
 			// Initially read all files and send them to be processed and added to the in memory store.
-			filenames, err := filepath.Glob("/etc/pyrra/*.yaml")
+			filenames, err := filepath.Glob(configFiles)
 			if err != nil {
 				return err
 			}
@@ -43,12 +43,15 @@ func main() {
 		})
 	}
 	{
+		dir := filepath.Dir(configFiles)
+		log.Println("watching directory for changes", dir)
+
 		watcher, err := fsnotify.NewWatcher()
 		if err != nil {
 			log.Fatal(err)
 		}
 
-		err = watcher.Add("/etc/pyrra")
+		err = watcher.Add(dir)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -110,7 +113,7 @@ func main() {
 					}
 
 					_, file := filepath.Split(f)
-					if err := ioutil.WriteFile(filepath.Join("/etc/prometheus/pyrra/", file), bytes, 0644); err != nil {
+					if err := ioutil.WriteFile(filepath.Join(prometheusFolder, file), bytes, 0644); err != nil {
 						return err
 					}
 

cmd/kubernetes/main.go renamed to cmd/api/kubernetes.go

@@ -18,7 +18,6 @@ package main
 
 import (
 	"context"
-	"flag"
 	"fmt"
 	"net/http"
 	"os"
@@ -49,23 +48,15 @@ func init() {
 	// +kubebuilder:scaffold:scheme
 }
 
-func main() {
-	var metricsAddr string
-	var enableLeaderElection bool
-	flag.StringVar(&metricsAddr, "metrics-addr", ":8080", "The address the metric endpoint binds to.")
-	flag.BoolVar(&enableLeaderElection, "enable-leader-election", false,
-		"Enable leader election for controller manager. "+
-			"Enabling this will ensure there is only one active controller manager.")
-	flag.Parse()
-
+func cmdKubernetes(metricsAddr string) {
 	setupLog := ctrl.Log.WithName("setup")
 	ctrl.SetLogger(zap.New(zap.UseDevMode(true)))
 
 	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
 		Scheme:             scheme,
 		MetricsBindAddress: metricsAddr,
 		Port:               9443,
-		LeaderElection:     enableLeaderElection,
+		LeaderElection:     false,
 		LeaderElectionID:   "9d76195a.metalmatze.de",
 	})
 	if err != nil {

cmd/api/main.go

@@ -3,7 +3,6 @@ package main
 import (
 	"context"
 	"embed"
-	"flag"
 	"fmt"
 	"html/template"
 	"io/fs"
@@ -17,6 +16,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/alecthomas/kong"
 	"github.com/cespare/xxhash/v2"
 	"github.com/dgraph-io/ristretto"
 	"github.com/go-chi/chi/v5"
@@ -32,26 +32,50 @@ import (
 //go:embed ui/build
 var ui embed.FS
 
+var CLI struct {
+	API struct {
+		PrometheusURL         *url.URL `default:"http://localhost:9090" help:"The URL to the Prometheus to query."`
+		PrometheusExternalURL *url.URL `help:"The URL for the UI to redirect users to when opening Prometheus. If empty the same as prometheus.url"`
+		ApiURL                *url.URL `default:"http://localhost:9444" help:"The URL to the API service like a Kubernetes Operator."`
+	} `cmd:"" help:"Runs Pyrra's API and UI."`
+	Filesystem struct {
+		ConfigFiles      string `default:"/etc/pyrra/*.yaml" help:"The folder where Pyrra finds the config files to use."`
+		PrometheusFolder string `default:"/etc/prometheus/pyrra/" help:"The folder where Pyrra writes the generates Prometheus rules and alerts."`
+	} `cmd:"" help:"Runs Pyrra's filesystem operator and backend for the API."`
+	Kubernetes struct {
+		MetricsAddr string `default:":8080" help:"The address the metric endpoint binds to."`
+	} `cmd:"" help:"Runs Pyrra's Kubernetes operator and backend for the API."`
+}
+
 func main() {
+	ctx := kong.Parse(&CLI)
+	switch ctx.Command() {
+	case "api":
+		cmdAPI(CLI.API.PrometheusURL, CLI.API.PrometheusExternalURL, CLI.API.ApiURL)
+	case "filesystem":
+		cmdFilesystem(CLI.Filesystem.ConfigFiles, CLI.Filesystem.PrometheusFolder)
+	case "kubernetes":
+		cmdKubernetes(CLI.Kubernetes.MetricsAddr)
+	}
+
+	return
+}
+
+func cmdAPI(prometheusURL, prometheusExternal, apiURL *url.URL) {
 	build, err := fs.Sub(ui, "ui/build")
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	prometheusURL := flag.String("prometheus.url", "http://localhost:9090", "The URL to the Prometheus to query.")
-	prometheusExternal := flag.String("prometheus.external", "", "The URL for the UI to redirect users to when opening Prometheus. If empty the same as prometheus.url")
-	apiURL := flag.String("api.url", "http://localhost:9444", "The URL to the API service like a Kubernetes Operator.")
-	flag.Parse()
-
-	if *prometheusExternal == "" {
+	if prometheusExternal == nil {
 		prometheusExternal = prometheusURL
 	}
 
-	log.Println("Using Prometheus at", *prometheusURL)
-	log.Println("Using external Prometheus at", *prometheusExternal)
-	log.Println("Using API at", *apiURL)
+	log.Println("Using Prometheus at", prometheusURL.String())
+	log.Println("Using external Prometheus at", prometheusExternal.String())
+	log.Println("Using API at", apiURL.String())
 
-	client, err := api.NewClient(api.Config{Address: *prometheusURL})
+	client, err := api.NewClient(api.Config{Address: prometheusURL.String()})
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -71,15 +95,9 @@ func main() {
 		cache: cache,
 	}
 
-	parsedAPIURL, err := url.Parse(*apiURL)
-	if err != nil {
-		log.Fatal(err)
-		return
-	}
-
 	apiConfig := openapiclient.NewConfiguration()
-	apiConfig.Scheme = parsedAPIURL.Scheme
-	apiConfig.Host = parsedAPIURL.Host
+	apiConfig.Scheme = apiURL.Scheme
+	apiConfig.Host = apiURL.Host
 	apiClient := openapiclient.NewAPIClient(apiConfig)
 
 	router := openapiserver.NewRouter(
@@ -101,7 +119,7 @@ func main() {
 		if err := tmpl.Execute(w, struct {
 			PrometheusURL string
 		}{
-			PrometheusURL: *prometheusExternal,
+			PrometheusURL: prometheusExternal.String(),
 		}); err != nil {
 			log.Println(err)
 			return
@@ -112,7 +130,7 @@ func main() {
 			if err := tmpl.Execute(w, struct {
 				PrometheusURL string
 			}{
-				PrometheusURL: *prometheusExternal,
+				PrometheusURL: prometheusExternal.String(),
 			}); err != nil {
 				log.Println(err)
 			}

cmd/kubernetes/Dockerfile

@@ -3,22 +3,23 @@ module github.com/pyrra-dev/pyrra
 go 1.16
 
 require (
+	github.com/alecthomas/kong v0.2.17
 	github.com/cespare/xxhash/v2 v2.1.1
 	github.com/dgraph-io/ristretto v0.0.3
-	github.com/fsnotify/fsnotify v1.4.9 // indirect
+	github.com/fsnotify/fsnotify v1.4.9
 	github.com/go-chi/chi/v5 v5.0.3
 	github.com/go-chi/cors v1.2.0
 	github.com/go-logr/logr v0.4.0
-	github.com/gorilla/mux v1.8.0 // indirect
+	github.com/gorilla/mux v1.8.0
 	github.com/oklog/run v1.1.0
 	github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring v0.47.0
 	github.com/prometheus/client_golang v1.10.0
 	github.com/prometheus/common v0.21.0
 	github.com/prometheus/prometheus v1.8.2-0.20210421143221-52df5ef7a3be
 	github.com/stretchr/testify v1.7.0
-	golang.org/x/oauth2 v0.0.0-20210615190721-d04028783cf1 // indirect
+	golang.org/x/oauth2 v0.0.0-20210615190721-d04028783cf1
 	k8s.io/apimachinery v0.21.0
 	k8s.io/client-go v0.21.0
 	sigs.k8s.io/controller-runtime v0.9.0-beta.1.0.20210505224715-55a329c15d6b
-	sigs.k8s.io/yaml v1.2.0 // indirect
+	sigs.k8s.io/yaml v1.2.0
 )

go.mod

@@ -84,6 +84,8 @@ github.com/VividCortex/gohistogram v1.0.0/go.mod h1:Pf5mBqqDxYaXu3hDrrU+w6nw50o/
 github.com/afex/hystrix-go v0.0.0-20180502004556-fa1af6a1f4f5/go.mod h1:SkGFH1ia65gfNATL8TAiHDNxPzPdmEL5uirI2Uyuz6c=
 github.com/agnivade/levenshtein v1.0.1/go.mod h1:CURSv5d9Uaml+FovSIICkLbAUZ9S4RqaHDIsdSBg7lM=
 github.com/ajstarks/svgo v0.0.0-20180226025133-644b8db467af/go.mod h1:K08gAheRH3/J6wwsYMMT4xOr94bZjxIelGM0+d/wbFw=
+github.com/alecthomas/kong v0.2.17 h1:URDISCI96MIgcIlQyoCAlhOmrSw6pZScBNkctg8r0W0=
+github.com/alecthomas/kong v0.2.17/go.mod h1:ka3VZ8GZNPXv9Ov+j4YNLkI8mTuhXyr/0ktSlqIydQQ=
 github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
 github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
 github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=
@@ -997,7 +999,6 @@ golang.org/x/oauth2 v0.0.0-20201208152858-08078c50e5b5/go.mod h1:KelEdhl1UZF7XfJ
 golang.org/x/oauth2 v0.0.0-20210218202405-ba52d332ba99/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
 golang.org/x/oauth2 v0.0.0-20210220000619-9bb904979d93/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
 golang.org/x/oauth2 v0.0.0-20210313182246-cd4f82c27b84/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
-golang.org/x/oauth2 v0.0.0-20210323180902-22b0adad7558 h1:D7nTwh4J0i+5mW4Zjzn5omvlr6YBcWywE6KOcatyNxY=
 golang.org/x/oauth2 v0.0.0-20210323180902-22b0adad7558/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=
 golang.org/x/oauth2 v0.0.0-20210615190721-d04028783cf1 h1:x622Z2o4hgCr/4CiKWc51jHVKaWdtVpBNmEI8wI9Qns=
 golang.org/x/oauth2 v0.0.0-20210615190721-d04028783cf1/go.mod h1:KelEdhl1UZF7XfJ4dDtk6s++YSgaE7mD/BuKKDLBl4A=