Add pre- and post-exec commands. (#49)

.github/workflows/docker.yaml

@@ -47,6 +47,10 @@ jobs:
         [ "${GITHUB_EVENT_NAME}" == 'release' ] && echo "tag=${GITHUB_REF##*/}" >> $GITHUB_ENV || true
         [ "${GITHUB_EVENT_NAME}" == 'push' ] && echo "tag=latest" >> $GITHUB_ENV || true
 
+    - name: Build
+      run:
+        make all
+
     - name: Build and push image
       uses: docker/build-push-action@v4
       with:

Dockerfile

@@ -1,29 +1,12 @@
-FROM golang:1.21 as builder
-WORKDIR /work
-COPY .git .git
-COPY api api
-COPY cmd cmd
-COPY go.mod .
-COPY go.sum .
-COPY Makefile .
-RUN make
-
+# TODO: remove tini in a future release, not required anymore since pre- and post-exec-cmd flags
 FROM krallin/ubuntu-tini as ubuntu-tini
 
-# rethinkdb backup/restore requires the python client library
-# let's make small binaries of these commands in order not to blow up the image size
-FROM rethinkdb:2.4.1 as rethinkdb-python-client-builder
-WORKDIR /work
-RUN apt update && apt install -y python3-pip
-RUN pip3 install pyinstaller==4.3.0 rethinkdb
-COPY build/rethinkdb-dump.spec rethinkdb-dump.spec
-COPY build/rethinkdb-restore.spec rethinkdb-restore.spec
-RUN pyinstaller rethinkdb-dump.spec \
-    && pyinstaller rethinkdb-restore.spec
+FROM ghcr.io/metal-stack/rethinkdb-backup-tools-build:v2.4.1 as rethinkdb-backup-tools
 
 FROM alpine:3.18
+# TODO: remove tini in a future release, not required anymore since pre- and post-exec-cmd flags
 RUN apk add --no-cache tini ca-certificates
-COPY --from=builder /work/bin/backup-restore-sidecar /backup-restore-sidecar
+COPY bin/backup-restore-sidecar /backup-restore-sidecar
 COPY --from=ubuntu-tini /usr/local/bin/tini-static /ubuntu/tini
-COPY --from=rethinkdb-python-client-builder /work/dist/rethinkdb-dump /work/dist/rethinkdb-restore /rethinkdb/
+COPY --from=rethinkdb-backup-tools /rethinkdb-dump /rethinkdb-restore /rethinkdb/
 CMD ["/backup-restore-sidecar"]

Makefile

@@ -3,7 +3,7 @@ BACKUP_PROVIDER := $(or ${BACKUP_PROVIDER},local)
 
 SHA := $(shell git rev-parse --short=8 HEAD)
 GITVERSION := $(shell git describe --long --all)
-BUILDDATE := $(shell GO111MODULE=off go run ${COMMONDIR}/time.go)
+BUILDDATE := $(shell date --rfc-3339=seconds)
 VERSION := $(or ${VERSION},$(shell git describe --tags --exact-match 2> /dev/null || git symbolic-ref -q --short HEAD || git rev-parse --short HEAD))
 
 GO111MODULE := on
@@ -25,7 +25,7 @@ proto:
 	make -C proto protoc
 
 .PHONY: dockerimage
-dockerimage:
+dockerimage: all
 	docker build -t ghcr.io/metal-stack/backup-restore-sidecar:${DOCKER_TAG} .
 
 .PHONY: dockerpush

cmd/internal/backup/backup.go

@@ -1,6 +1,7 @@
 package backup
 
 import (
+	"context"
 	"os"
 	"path"
 
@@ -14,7 +15,7 @@ import (
 )
 
 // Start starts the backup component, which is periodically taking backups of the database
-func Start(log *zap.SugaredLogger, backupSchedule string, db database.DatabaseProber, bp backuproviders.BackupProvider, metrics *metrics.Metrics, comp *compress.Compressor, stop <-chan struct{}) error {
+func Start(ctx context.Context, log *zap.SugaredLogger, backupSchedule string, db database.DatabaseProber, bp backuproviders.BackupProvider, metrics *metrics.Metrics, comp *compress.Compressor) error {
 	log.Info("database is now available, starting periodic backups")
 
 	c := cron.New()
@@ -70,7 +71,7 @@ func Start(log *zap.SugaredLogger, backupSchedule string, db database.DatabasePr
 
 	c.Start()
 	log.Infow("scheduling next backup", "at", c.Entry(id).Next.String())
-	<-stop
+	<-ctx.Done()
 	c.Stop()
 	return nil
 }

cmd/internal/database/rethinkdb/rethinkdb.go

@@ -1,6 +1,7 @@
 package rethinkdb
 
 import (
+	"context"
 	"fmt"
 	"net"
 	"os"
@@ -40,11 +41,13 @@ type RethinkDB struct {
 	passwordFile string
 	log          *zap.SugaredLogger
 	executor     *utils.CmdExecutor
+	ctx          context.Context
 }
 
 // New instantiates a new rethinkdb database
-func New(log *zap.SugaredLogger, datadir string, url string, passwordFile string) *RethinkDB {
+func New(ctx context.Context, log *zap.SugaredLogger, datadir string, url string, passwordFile string) *RethinkDB {
 	return &RethinkDB{
+		ctx:          ctx,
 		log:          log,
 		datadir:      datadir,
 		url:          url,
@@ -125,13 +128,18 @@ func (db *RethinkDB) Recover() error {
 	}()
 
 	db.log.Infow("waiting for rethinkdb database to come up")
-	restoreDB := New(db.log, db.datadir, "localhost:1", "")
-	stop := make(chan struct{})
+
+	restoreDB := New(db.ctx, db.log, db.datadir, "localhost:1", "")
+
 	done := make(chan bool)
 	defer close(done)
+
+	probeCtx, probeCancel := context.WithTimeout(context.Background(), restoreDatabaseStartupTimeout)
+	defer probeCancel()
+
 	var err error
 	go func() {
-		err = probe.Start(restoreDB.log, restoreDB, stop)
+		err = probe.Start(probeCtx, restoreDB.log, restoreDB)
 		done <- true
 	}()
 	select {
@@ -140,15 +148,17 @@ func (db *RethinkDB) Recover() error {
 			return fmt.Errorf("error while probing: %w", err)
 		}
 		db.log.Infow("rethinkdb in sidecar is now available, now triggering restore commands...")
-	case <-time.After(restoreDatabaseStartupTimeout):
-		close(stop)
+	case <-probeCtx.Done():
 		return errors.New("rethinkdb database did not come up in time")
 	}
 
 	args := []string{}
 	if db.url != "" {
 		args = append(args, "--connect="+restoreDB.url)
 	}
+	if db.passwordFile != "" {
+		args = append(args, "--password-file="+db.passwordFile)
+	}
 	args = append(args, rethinkDBRestoreFilePath)
 
 	out, err := db.executor.ExecuteCommandWithOutput(rethinkDBRestoreCmd, nil, args...)

cmd/internal/initializer/initializer.go

@@ -1,6 +1,7 @@
 package initializer
 
 import (
+	"context"
 	"fmt"
 	"net"
 	"os"
@@ -30,24 +31,26 @@ type Initializer struct {
 	db            database.Database
 	bp            providers.BackupProvider
 	comp          *compress.Compressor
+	dbDataDir     string
 }
 
-func New(log *zap.SugaredLogger, addr string, db database.Database, bp providers.BackupProvider, comp *compress.Compressor) *Initializer {
+func New(log *zap.SugaredLogger, addr string, db database.Database, bp providers.BackupProvider, comp *compress.Compressor, dbDataDir string) *Initializer {
 	return &Initializer{
 		currentStatus: &v1.StatusResponse{
 			Status:  v1.StatusResponse_CHECKING,
 			Message: "starting initializer server",
 		},
-		log:  log,
-		addr: addr,
-		db:   db,
-		bp:   bp,
-		comp: comp,
+		log:       log,
+		addr:      addr,
+		db:        db,
+		bp:        bp,
+		comp:      comp,
+		dbDataDir: dbDataDir,
 	}
 }
 
 // Start starts the initializer, which includes a server component and the initializer itself, which is potentially restoring a backup
-func (i *Initializer) Start(stop <-chan struct{}) {
+func (i *Initializer) Start(ctx context.Context) {
 	opts := []grpc.ServerOption{
 		grpc.StreamInterceptor(grpc_middleware.ChainStreamServer(
 			grpc_ctxtags.StreamServerInterceptor(),
@@ -75,7 +78,7 @@ func (i *Initializer) Start(stop <-chan struct{}) {
 	}
 
 	go func() {
-		<-stop
+		<-ctx.Done()
 		i.log.Info("received stop signal, shutting down")
 		grpcServer.Stop()
 	}()
@@ -106,9 +109,15 @@ func (i *Initializer) Start(stop <-chan struct{}) {
 func (i *Initializer) initialize() error {
 	i.log.Info("start running initializer")
 
+	i.log.Info("ensuring database data directory")
+	err := os.MkdirAll(i.dbDataDir, 0755)
+	if err != nil {
+		return fmt.Errorf("unable to ensure database data directory: %w", err)
+	}
+
 	i.log.Info("ensuring backup bucket")
 	i.currentStatus.Message = "ensuring backup bucket"
-	err := i.bp.EnsureBackupBucket()
+	err = i.bp.EnsureBackupBucket()
 	if err != nil {
 		return fmt.Errorf("unable to ensure backup bucket: %w", err)
 	}

cmd/internal/probe/probe.go

@@ -1,6 +1,7 @@
 package probe
 
 import (
+	"context"
 	"errors"
 	"time"
 
@@ -13,12 +14,12 @@ var (
 )
 
 // Start starts the database prober
-func Start(log *zap.SugaredLogger, db database.DatabaseProber, stop <-chan struct{}) error {
+func Start(ctx context.Context, log *zap.SugaredLogger, db database.DatabaseProber) error {
 	log.Info("start probing database")
 
 	for {
 		select {
-		case <-stop:
+		case <-ctx.Done():
 			return errors.New("received stop signal, stop probing")
 		case <-time.After(probeInterval):
 			err := db.Probe()