feat: LVM snapshots/clone as an alternative to ZFS

Author: astansler

.gitlab-ci.yml

@@ -20,7 +20,7 @@ build-binary-alpine:
   stage: build-binary
   only:
     refs:
-      - master
+      - branches
       - tags
   artifacts:
     paths:
@@ -67,6 +67,38 @@ build-binary-generic:
   only:
     - master
 
+.only_var_template: &only_feature
+  only:
+    variables:
+      - $CI_COMMIT_TAG == null
+      - $CI_COMMIT_REF_SLUG != "master"
+
+build-image-feature-server:
+  <<: *build_image_definition
+  <<: *only_feature
+  variables:
+    REGISTRY_USER: "${CI_REGISTRY_USER}"
+    REGISTRY_PASSWORD: "${CI_REGISTRY_PASSWORD}"
+    REGISTRY: "${CI_REGISTRY}"
+    DOCKER_FILE: "Dockerfile.dblab-server"
+    DOCKER_NAME: "registry.gitlab.com/postgres-ai/database-lab/dblab-server"
+    TAGS: "${DOCKER_NAME}:${CI_COMMIT_REF_SLUG}"
+  before_script:
+    - cp ./bin/dblab-server-alpine ./bin/dblab-server
+
+build-image-feature-client:
+  <<: *build_image_definition
+  <<: *only_feature
+  variables:
+    REGISTRY_USER: "${CI_REGISTRY_USER}"
+    REGISTRY_PASSWORD: "${CI_REGISTRY_PASSWORD}"
+    REGISTRY: "${CI_REGISTRY}"
+    DOCKER_FILE: "Dockerfile.dblab"
+    DOCKER_NAME: "registry.gitlab.com/postgres-ai/database-lab/dblab"
+    TAGS: "${DOCKER_NAME}:${CI_COMMIT_REF_SLUG}"
+  before_script:
+    - cp ./bin/dblab-alpine ./bin/dblab
+
 build-image-master-server:
   <<: *build_image_definition
   <<: *only_master

Dockerfile.dblab-server

@@ -32,7 +32,7 @@
 FROM docker:19
 
 # Install dependecies.
-RUN apk update && apk add --no-cache zfs bash
+RUN apk update && apk add --no-cache zfs lvm2 bash
 
 WORKDIR /home/dblab
 

cmd/database-lab/main.go

@@ -57,15 +57,15 @@ func main() {
 
 	// TODO(anatoly): Annotate envs in configs. Use different lib for flags/configs?
 	if len(opts.MountDir) > 0 {
-		cfg.Provision.ModeZfs.MountDir = opts.MountDir
+		cfg.Provision.ModeLocal.MountDir = opts.MountDir
 	}
 
 	if len(opts.UnixSocketDir) > 0 {
-		cfg.Provision.ModeZfs.UnixSocketDir = opts.UnixSocketDir
+		cfg.Provision.ModeLocal.UnixSocketDir = opts.UnixSocketDir
 	}
 
 	if len(opts.DockerImage) > 0 {
-		cfg.Provision.ModeZfs.DockerImage = opts.DockerImage
+		cfg.Provision.ModeLocal.DockerImage = opts.DockerImage
 	}
 
 	provisionSvc, err := provision.NewProvision(ctx, cfg.Provision)

configs/config.sample.yml

@@ -6,8 +6,8 @@ server:
   port: 3000
 
 provision:
-  # Provision mode to use. More comming soon (e.g., LVM, Ceph).
-  mode: "zfs"
+  # Provision mode to use.
+  mode: "local"
 
   # Subdir where PGDATA located relative to the pool root dir.
   pgDataSubdir: "/"
@@ -16,9 +16,12 @@ provision:
   # The user should exist.
   pgMgmtUsername: "postgres"
 
-  # ZFS mode related parameters.
-  zfs:
-    # Name of your ZFS pool.
+  # "Local" mode related parameters.
+  local:
+    # Which volume manager to use. Available options: "zfs", "lvm".
+    volumeManager: "zfs"
+
+    # Name of your pool or volume group with logic volume name (e.g. "dblab_vg/pg1_lv").
     pool: "dblab_pool"
 
     # Pool of ports for Postgres clones.
@@ -45,7 +48,7 @@ provision:
     # is recommended in case if customization is needed.
     dockerImage: "postgres:12-alpine"
 
-    # Use sudo for ZFS and Docker commands if Database Lab server running
+    # Use sudo for ZFS/LVM and Docker commands if Database Lab server running
     # outside a container.
     useSudo: false
 

pkg/services/cloning/cloning.go

@@ -14,6 +14,7 @@ import (
 	"gitlab.com/postgres-ai/database-lab/pkg/log"
 	"gitlab.com/postgres-ai/database-lab/pkg/models"
 	"gitlab.com/postgres-ai/database-lab/pkg/services/provision"
+	"gitlab.com/postgres-ai/database-lab/pkg/services/provision/resources"
 )
 
 const (
@@ -56,7 +57,7 @@ type Cloning interface {
 // CloneWrapper represents a cloning service wrapper.
 type CloneWrapper struct {
 	clone   *models.Clone
-	session *provision.Session
+	session *resources.Session
 
 	timeCreatedAt time.Time
 	timeStartedAt time.Time

pkg/services/cloning/mode_base.go

@@ -20,6 +20,7 @@ import (
 	"gitlab.com/postgres-ai/database-lab/pkg/log"
 	"gitlab.com/postgres-ai/database-lab/pkg/models"
 	"gitlab.com/postgres-ai/database-lab/pkg/services/provision"
+	"gitlab.com/postgres-ai/database-lab/pkg/services/provision/resources"
 	"gitlab.com/postgres-ai/database-lab/pkg/util"
 	"gitlab.com/postgres-ai/database-lab/pkg/util/pglog"
 )
@@ -122,11 +123,13 @@ func (c *baseCloning) CreateClone(clone *models.Clone) error {
 		session, err := c.provision.StartSession(w.username, w.password, w.snapshot.ID)
 		if err != nil {
 			// TODO(anatoly): Empty room case.
+			log.Errf("Failed to create a clone: %+v.", err)
+
 			if err := c.updateCloneStatus(cloneID, models.Status{
 				Code:    models.StatusFatal,
 				Message: models.CloneMessageFatal,
 			}); err != nil {
-				log.Errf("failed to update clone status: %v", err)
+				log.Errf("Failed to update clone status: %v", err)
 			}
 
 			return
@@ -193,15 +196,15 @@ func (c *baseCloning) DestroyClone(cloneID string) error {
 
 	go func() {
 		if err := c.provision.StopSession(w.session); err != nil {
+			log.Errf("Failed to delete a clone: %+v.", err)
+
 			if err := c.updateCloneStatus(cloneID, models.Status{
 				Code:    models.StatusFatal,
 				Message: models.CloneMessageFatal,
 			}); err != nil {
 				log.Errf("Failed to update clone status: %v", err)
 			}
 
-			log.Errf("Failed to delete clone: %+v.", err)
-
 			return
 		}
 
@@ -304,15 +307,15 @@ func (c *baseCloning) ResetClone(cloneID string) error {
 	go func() {
 		err := c.provision.ResetSession(w.session, w.snapshot.ID)
 		if err != nil {
+			log.Errf("Failed to reset a clone: %+v.", err)
+
 			if err := c.updateCloneStatus(cloneID, models.Status{
 				Code:    models.StatusFatal,
 				Message: models.CloneMessageFatal,
 			}); err != nil {
 				log.Errf("failed to update clone status: %v", err)
 			}
 
-			log.Errf("Failed to reset session: %+v.", err)
-
 			return
 		}
 
@@ -541,7 +544,7 @@ func (c *baseCloning) isIdleClone(wrapper *CloneWrapper) (bool, error) {
 const pgDriverName = "postgres"
 
 // hasNotQueryActivity opens connection and checks if there is no any query running by a user.
-func hasNotQueryActivity(session *provision.Session) (bool, error) {
+func hasNotQueryActivity(session *resources.Session) (bool, error) {
 	log.Dbg(fmt.Sprintf("Check an active query for: %q.", session.ID))
 
 	db, err := sql.Open(pgDriverName, getSocketConnStr(session))
@@ -560,7 +563,7 @@ func hasNotQueryActivity(session *provision.Session) (bool, error) {
 }
 
 // TODO(akartasov): Move the function to the provision service.
-func getSocketConnStr(session *provision.Session) string {
+func getSocketConnStr(session *resources.Session) string {
 	return fmt.Sprintf("host=%s user=%s dbname=postgres", session.SocketHost, session.User)
 }
 
@@ -569,8 +572,8 @@ func checkActiveQueryNotExists(db *sql.DB) (bool, error) {
 	var isRunningQueryNotExists bool
 
 	query := `select not exists (
-      select * from pg_stat_activity
-	  where state <> 'idle' and query not like 'autovacuum: %' and pid <> pg_backend_pid()
+		select * from pg_stat_activity
+		where state <> 'idle' and query not like 'autovacuum: %' and pid <> pg_backend_pid()
 	)`
 	err := db.QueryRow(query).Scan(&isRunningQueryNotExists)