Rename to backend

internal/kubernetes/copy.go → internal/backend/copy.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"fmt"

internal/kubernetes/delete.go → internal/backend/delete.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"context"

internal/kubernetes/delete_test.go → internal/backend/delete_test.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"context"

internal/kubernetes/deploy.go → internal/backend/deploy.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"context"

internal/kubernetes/deploy_test.go → internal/backend/deploy_test.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"testing"

internal/kubernetes/exec.go → internal/backend/exec.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"fmt"

internal/kubernetes/logs.go → internal/backend/logs.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"context"

internal/kubernetes/logs_test.go → internal/backend/logs_test.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"io"

internal/kubernetes/main.go → internal/backend/main.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"io"
@@ -10,8 +10,8 @@ import (
 	"github.com/joyrex2001/kubedock/internal/model/types"
 )
 
-// Kubernetes is the interface to orchestrate and manage kubernetes objects.
-type Kubernetes interface {
+// Backend is the interface to orchestrate and manage kubernetes objects.
+type Backend interface {
 	StartContainer(*types.Container) error
 	DeleteContainer(*types.Container) error
 	DeleteContainersOlderThan(time.Duration) error
@@ -22,15 +22,15 @@ type Kubernetes interface {
 	GetLogs(*types.Container, bool, io.Writer) error
 }
 
-// instance is the internal representation of the Kubernetes object.
+// instance is the internal representation of the Backend object.
 type instance struct {
 	cli       kubernetes.Interface
 	cfg       *rest.Config
 	initImage string
 	namespace string
 }
 
-// Config is the structure to instantiate a Kubernetes object
+// Config is the structure to instantiate a Backend object
 type Config struct {
 	// Client is the kubernetes clientset
 	Client kubernetes.Interface
@@ -43,7 +43,7 @@ type Config struct {
 }
 
 // New will return an ContainerFactory instance.
-func New(cfg Config) Kubernetes {
+func New(cfg Config) Backend {
 	return &instance{
 		cli:       cfg.Client,
 		cfg:       cfg.RestConfig,

internal/kubernetes/status.go → internal/backend/status.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"context"

internal/kubernetes/status_test.go → internal/backend/status_test.go

@@ -1,4 +1,4 @@
-package kubernetes
+package backend
 
 import (
 	"testing"

internal/main.go

@@ -3,26 +3,26 @@ package internal
 import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
-	clientset "k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/kubernetes"
 	"k8s.io/klog"
 
+	"github.com/joyrex2001/kubedock/internal/backend"
 	"github.com/joyrex2001/kubedock/internal/config"
-	"github.com/joyrex2001/kubedock/internal/kubernetes"
 	"github.com/joyrex2001/kubedock/internal/reaper"
 	"github.com/joyrex2001/kubedock/internal/server"
 )
 
 // Main is the main entry point for starting this service, based the settings
 // initiated by cmd.
 func Main(cmd *cobra.Command, args []string) {
-	kub, err := getKubernetes()
+	kub, err := getBackend()
 	if err != nil {
 		klog.Fatalf("error instantiating kubernetes: %s", err)
 	}
 
 	rpr, err := reaper.New(reaper.Config{
-		KeepMax:    viper.GetDuration("reaper.keepmax"),
-		Kubernetes: kub,
+		KeepMax: viper.GetDuration("reaper.keepmax"),
+		Backend: kub,
 	})
 	if err != nil {
 		klog.Fatalf("error instantiating reaper: %s", err)
@@ -35,17 +35,17 @@ func Main(cmd *cobra.Command, args []string) {
 	}
 }
 
-// getKubernetes will instantiate a the kubedock kubernetes object.
-func getKubernetes() (kubernetes.Kubernetes, error) {
+// getBackend will instantiate a the kubedock kubernetes object.
+func getBackend() (backend.Backend, error) {
 	cfg, err := config.GetKubernetes()
 	if err != nil {
 		return nil, err
 	}
-	cli, err := clientset.NewForConfig(cfg)
+	cli, err := kubernetes.NewForConfig(cfg)
 	if err != nil {
 		return nil, err
 	}
-	kub := kubernetes.New(kubernetes.Config{
+	kub := backend.New(backend.Config{
 		Client:     cli,
 		RestConfig: cfg,
 		Namespace:  viper.GetString("kubernetes.namespace"),

internal/reaper/container_test.go

@@ -6,20 +6,20 @@ import (
 
 	"k8s.io/client-go/kubernetes/fake"
 
-	"github.com/joyrex2001/kubedock/internal/kubernetes"
+	"github.com/joyrex2001/kubedock/internal/backend"
 	"github.com/joyrex2001/kubedock/internal/model/types"
 	"github.com/spf13/viper"
 )
 
 func TestCleanContainers(t *testing.T) {
-	kub := kubernetes.New(kubernetes.Config{
+	kub := backend.New(backend.Config{
 		Client:    fake.NewSimpleClientset(),
 		Namespace: viper.GetString("kubernetes.namespace"),
 		InitImage: viper.GetString("kubernetes.initimage"),
 	})
 	rp, _ := New(Config{
-		KeepMax:    20 * time.Millisecond,
-		Kubernetes: kub,
+		KeepMax: 20 * time.Millisecond,
+		Backend: kub,
 	})
 	rp.db.SaveContainer(&types.Container{})
 	if err := rp.CleanContainers(); err != nil {

internal/reaper/main.go

@@ -4,7 +4,7 @@ import (
 	"sync"
 	"time"
 
-	"github.com/joyrex2001/kubedock/internal/kubernetes"
+	"github.com/joyrex2001/kubedock/internal/backend"
 	"github.com/joyrex2001/kubedock/internal/model"
 	"k8s.io/klog"
 )
@@ -13,7 +13,7 @@ import (
 type Reaper struct {
 	db      *model.Database
 	keepMax time.Duration
-	kub     kubernetes.Kubernetes
+	kub     backend.Backend
 	quit    chan struct{}
 }
 
@@ -22,10 +22,10 @@ var once sync.Once
 
 // Config is the configuration to be used for the Reaper proces.
 type Config struct {
-	// KeepMax is the maximum age of resources, older resources are deleted
+	// KeepMax is the maximum age of resources, older resources are deleted.
 	KeepMax time.Duration
-	// Kubernetes is the kubedock kubernetes helper object
-	Kubernetes kubernetes.Kubernetes
+	// Backend is the kubedock backend object.
+	Backend backend.Backend
 }
 
 // New will create return the singleton Reaper instance.
@@ -36,7 +36,7 @@ func New(cfg Config) (*Reaper, error) {
 		instance = &Reaper{}
 		db, err = model.New()
 		instance.db = db
-		instance.kub = cfg.Kubernetes
+		instance.kub = cfg.Backend
 		instance.keepMax = cfg.KeepMax
 	})
 	return instance, err
@@ -53,7 +53,7 @@ func (in *Reaper) Stop() {
 	in.quit <- struct{}{}
 }
 
-// Reaper will reap all lingering resources at a steady interval.
+// runloop will reap all lingering resources at a steady interval.
 func (in *Reaper) runloop() {
 	go func() {
 		for {

internal/server/main.go

@@ -6,18 +6,18 @@ import (
 
 	"k8s.io/klog"
 
-	"github.com/joyrex2001/kubedock/internal/kubernetes"
+	"github.com/joyrex2001/kubedock/internal/backend"
 	"github.com/joyrex2001/kubedock/internal/server/httputil"
 	"github.com/joyrex2001/kubedock/internal/server/routes"
 )
 
 // Server is the API server.
 type Server struct {
-	kub kubernetes.Kubernetes
+	kub backend.Backend
 }
 
 // New will instantiate a Server object.
-func New(kub kubernetes.Kubernetes) *Server {
+func New(kub backend.Backend) *Server {
 	return &Server{kub: kub}
 }
 

internal/server/routes/archive.go

@@ -41,9 +41,9 @@ func (cr *Router) PutArchive(c *gin.Context) {
 	}
 
 	// hmm... how to do this without a running container...
-	running, _ := cr.kubernetes.IsContainerRunning(tainr)
+	running, _ := cr.kub.IsContainerRunning(tainr)
 	if !running {
-		if err := cr.kubernetes.StartContainer(tainr); err != nil {
+		if err := cr.kub.StartContainer(tainr); err != nil {
 			httputil.Error(c, http.StatusInternalServerError, err)
 			return
 		}
@@ -55,7 +55,7 @@ func (cr *Router) PutArchive(c *gin.Context) {
 		return
 	}
 
-	if err := cr.kubernetes.CopyToContainer(tainr, archive, path); err != nil {
+	if err := cr.kub.CopyToContainer(tainr, archive, path); err != nil {
 		httputil.Error(c, http.StatusInternalServerError, err)
 		return
 	}

internal/server/routes/containers.go

@@ -51,9 +51,9 @@ func (cr *Router) ContainerStart(c *gin.Context) {
 		httputil.Error(c, http.StatusNotFound, err)
 		return
 	}
-	running, _ := cr.kubernetes.IsContainerRunning(tainr)
+	running, _ := cr.kub.IsContainerRunning(tainr)
 	if !running {
-		if err := cr.kubernetes.StartContainer(tainr); err != nil {
+		if err := cr.kub.StartContainer(tainr); err != nil {
 			httputil.Error(c, http.StatusInternalServerError, err)
 			return
 		}
@@ -74,7 +74,7 @@ func (cr *Router) ContainerDelete(c *gin.Context) {
 		return
 	}
 	tainr.SignalStop()
-	if err := cr.kubernetes.DeleteContainer(tainr); err != nil {
+	if err := cr.kub.DeleteContainer(tainr); err != nil {
 		httputil.Error(c, http.StatusInternalServerError, err)
 		return
 	}
@@ -96,7 +96,7 @@ func (cr *Router) ContainerInfo(c *gin.Context) {
 		return
 	}
 
-	status, err := cr.kubernetes.GetContainerStatus(tainr)
+	status, err := cr.kub.GetContainerStatus(tainr)
 	if err != nil {
 		httputil.Error(c, http.StatusNotFound, err)
 		return

internal/server/routes/exec.go

@@ -90,7 +90,7 @@ func (cr *Router) ExecStart(c *gin.Context) {
 	w := c.Writer
 	w.WriteHeader(http.StatusOK)
 
-	if err := cr.kubernetes.ExecContainer(tainr, exec, w); err != nil {
+	if err := cr.kub.ExecContainer(tainr, exec, w); err != nil {
 		httputil.Error(c, http.StatusInternalServerError, err)
 		return
 	}

internal/server/routes/logs.go

@@ -26,7 +26,7 @@ func (cr *Router) ContainerLogs(c *gin.Context) {
 		return
 	}
 
-	running, err := cr.kubernetes.IsContainerRunning(tainr)
+	running, err := cr.kub.IsContainerRunning(tainr)
 	if err != nil {
 		httputil.Error(c, http.StatusNotFound, err)
 		return
@@ -43,7 +43,7 @@ func (cr *Router) ContainerLogs(c *gin.Context) {
 	w.WriteHeader(http.StatusOK)
 
 	if !follow {
-		if err := cr.kubernetes.GetLogs(tainr, follow, w); err != nil {
+		if err := cr.kub.GetLogs(tainr, follow, w); err != nil {
 			httputil.Error(c, http.StatusInternalServerError, err)
 			return
 		}
@@ -70,7 +70,7 @@ func (cr *Router) ContainerLogs(c *gin.Context) {
 	}
 	fmt.Fprint(out, "\r\n")
 
-	if err := cr.kubernetes.GetLogs(tainr, follow, out); err != nil {
+	if err := cr.kub.GetLogs(tainr, follow, out); err != nil {
 		klog.Errorf("error retrieving logs: %s", err)
 		return
 	}

internal/server/routes/main.go

@@ -3,26 +3,26 @@ package routes
 import (
 	"github.com/gin-gonic/gin"
 
-	"github.com/joyrex2001/kubedock/internal/kubernetes"
+	"github.com/joyrex2001/kubedock/internal/backend"
 	"github.com/joyrex2001/kubedock/internal/model"
 	"github.com/joyrex2001/kubedock/internal/server/httputil"
 )
 
 // Router is the object that facilitates the kubedock API endpoints.
 type Router struct {
-	db         *model.Database
-	kubernetes kubernetes.Kubernetes
+	db  *model.Database
+	kub backend.Backend
 }
 
 // New will instantiate a containerRouter object.
-func New(router *gin.Engine, kube kubernetes.Kubernetes) (*Router, error) {
+func New(router *gin.Engine, kub backend.Backend) (*Router, error) {
 	db, err := model.New()
 	if err != nil {
 		return nil, err
 	}
 	cr := &Router{
-		db:         db,
-		kubernetes: kube,
+		db:  db,
+		kub: kub,
 	}
 	cr.initRoutes(router)
 	return cr, nil