Merge branch 'rename-core-ui' into 'master'

chore: rename Local UI to Embed UI as a more suitable name and ce-ui Docker image to run UI application

See merge request postgres-ai/database-lab!394

Author: agneum

cmd/database-lab/main.go

@@ -21,8 +21,8 @@ import (
 	"github.com/pkg/errors"
 
 	"gitlab.com/postgres-ai/database-lab/v3/internal/cloning"
+	"gitlab.com/postgres-ai/database-lab/v3/internal/embedui"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/estimator"
-	"gitlab.com/postgres-ai/database-lab/v3/internal/localui"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/observer"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/platform"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/provision"
@@ -152,11 +152,11 @@ func main() {
 		Restore:       retrievalSvc.CollectRestoreTelemetry(),
 	})
 
-	localUI := localui.New(cfg.LocalUI, engProps, runner, docker)
+	embedUI := embedui.New(cfg.EmbedUI, engProps, runner, docker)
 	server := srv.NewServer(&cfg.Server, &cfg.Global, engProps, docker, cloningSvc, provisioner, retrievalSvc, platformSvc, obs, est, pm, tm)
 	shutdownCh := setShutdownListener()
 
-	go setReloadListener(ctx, provisioner, tm, retrievalSvc, pm, cloningSvc, platformSvc, est, localUI, server)
+	go setReloadListener(ctx, provisioner, tm, retrievalSvc, pm, cloningSvc, platformSvc, est, embedUI, server)
 
 	server.InitHandlers()
 
@@ -166,10 +166,10 @@ func main() {
 		}
 	}()
 
-	if cfg.LocalUI.Enabled {
+	if cfg.EmbedUI.Enabled {
 		go func() {
-			if err := localUI.Run(ctx); err != nil {
-				log.Err("Failed to start local UI container:", err.Error())
+			if err := embedUI.Run(ctx); err != nil {
+				log.Err("Failed to start Embed UI container:", err.Error())
 				return
 			}
 		}()
@@ -223,7 +223,7 @@ func getEngineProperties(ctx context.Context, dockerCLI *client.Client, cfg *con
 }
 
 func reloadConfig(ctx context.Context, provisionSvc *provision.Provisioner, tm *telemetry.Agent, retrievalSvc *retrieval.Retrieval,
-	pm *pool.Manager, cloningSvc *cloning.Base, platformSvc *platform.Service, est *estimator.Estimator, localUI *localui.UIManager,
+	pm *pool.Manager, cloningSvc *cloning.Base, platformSvc *platform.Service, est *estimator.Estimator, embedUI *embedui.UIManager,
 	server *srv.Server) error {
 	cfg, err := config.LoadConfiguration()
 	if err != nil {
@@ -247,7 +247,7 @@ func reloadConfig(ctx context.Context, provisionSvc *provision.Provisioner, tm *
 		return err
 	}
 
-	if err := localUI.Reload(ctx, cfg.LocalUI); err != nil {
+	if err := embedUI.Reload(ctx, cfg.EmbedUI); err != nil {
 		return err
 	}
 
@@ -268,15 +268,15 @@ func reloadConfig(ctx context.Context, provisionSvc *provision.Provisioner, tm *
 }
 
 func setReloadListener(ctx context.Context, provisionSvc *provision.Provisioner, tm *telemetry.Agent, retrievalSvc *retrieval.Retrieval,
-	pm *pool.Manager, cloningSvc *cloning.Base, platformSvc *platform.Service, est *estimator.Estimator, localUI *localui.UIManager,
+	pm *pool.Manager, cloningSvc *cloning.Base, platformSvc *platform.Service, est *estimator.Estimator, embedUI *embedui.UIManager,
 	server *srv.Server) {
 	reloadCh := make(chan os.Signal, 1)
 	signal.Notify(reloadCh, syscall.SIGHUP)
 
 	for range reloadCh {
 		log.Msg("Reloading configuration")
 
-		if err := reloadConfig(ctx, provisionSvc, tm, retrievalSvc, pm, cloningSvc, platformSvc, est, localUI, server); err != nil {
+		if err := reloadConfig(ctx, provisionSvc, tm, retrievalSvc, pm, cloningSvc, platformSvc, est, embedUI, server); err != nil {
 			log.Err("Failed to reload configuration", err)
 		}
 

configs/config.example.logical_generic.yml

@@ -23,14 +23,14 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-# Local UI. Controls the application to provide a user interface to DLE API.
-localUI:
+# Embed UI. Controls the application to provide a user interface to DLE API.
+embedUI:
   enabled: true
 
   # Docker image of the UI application.
-  dockerImage: "postgresai/local-ui:latest"
+  dockerImage: "postgresai/ce-ui:latest"
 
-  # Host or IP address, from which the Local UI container accepts HTTP connections.
+  # Host or IP address, from which the Embed UI container accepts HTTP connections.
   # By default, use a loop-back to accept only local connections.
   # The empty string means "all available addresses".
   host: "127.0.0.1"

configs/config.example.logical_rds_iam.yml

@@ -23,14 +23,14 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-# Local UI. Controls the application to provide a user interface to DLE API.
-localUI:
+# Embed UI. Controls the application to provide a user interface to DLE API.
+embedUI:
   enabled: true
 
   # Docker image of the UI application.
-  dockerImage: "postgresai/local-ui:latest"
+  dockerImage: "postgresai/ce-ui:latest"
 
-  # Host or IP address, from which the Local UI container accepts HTTP connections.
+  # Host or IP address, from which the Embed UI container accepts HTTP connections.
   # By default, use a loop-back to accept only local connections.
   # The empty string means "all available addresses".
   host: "127.0.0.1"

configs/config.example.physical_generic.yml

@@ -23,14 +23,14 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-# Local UI. Controls the application to provide a user interface to DLE API.
-localUI:
+# Embed UI. Controls the application to provide a user interface to DLE API.
+embedUI:
   enabled: true
 
   # Docker image of the UI application.
-  dockerImage: "postgresai/local-ui:latest"
+  dockerImage: "postgresai/ce-ui:latest"
 
-  # Host or IP address, from which the Local UI container accepts HTTP connections.
+  # Host or IP address, from which the Embed UI container accepts HTTP connections.
   # By default, use a loop-back to accept only local connections.
   # The empty string means "all available addresses".
   host: "127.0.0.1"

configs/config.example.physical_walg.yml

@@ -23,14 +23,14 @@ server:
   # HTTP server port. Default: 2345.
   port: 2345
 
-# Local UI. Controls the application to provide a user interface to DLE API.
-localUI:
+# Embed UI. Controls the application to provide a user interface to DLE API.
+embedUI:
   enabled: true
 
   # Docker image of the UI application.
-  dockerImage: "postgresai/local-ui:latest"
+  dockerImage: "postgresai/ce-ui:latest"
 
-  # Host or IP address, from which the Local UI container accepts HTTP connections.
+  # Host or IP address, from which the Embed UI container accepts HTTP connections.
   # By default, use a loop-back to accept only local connections.
   # The empty string means "all available addresses".
   host: "127.0.0.1"

internal/localui/local_ui.go renamed to internal/embedui/embed_ui.go

@@ -2,8 +2,8 @@
 2021 © Postgres.ai
 */
 
-// Package localui manages local UI container.
-package localui
+// Package embedui manages Embed UI container.
+package embedui
 
 import (
 	"context"
@@ -40,15 +40,15 @@ const (
 	healthCheckRetries  = 5
 )
 
-// Config defines configs for a local UI container.
+// Config defines configs for a Embed UI container.
 type Config struct {
 	Enabled     bool   `yaml:"enabled"`
 	DockerImage string `yaml:"dockerImage"`
 	Host        string `yaml:"host"`
 	Port        int    `yaml:"port"`
 }
 
-// UIManager manages local UI container.
+// UIManager manages Embed UI container.
 type UIManager struct {
 	runner   runners.Runner
 	docker   *client.Client
@@ -89,16 +89,16 @@ func (ui *UIManager) isConfigChanged(cfg Config) bool {
 		ui.cfg.Port != cfg.Port
 }
 
-// Run creates a new local UI container.
+// Run creates a new Embed UI container.
 func (ui *UIManager) Run(ctx context.Context) error {
 	if err := docker.PrepareImage(ui.runner, ui.cfg.DockerImage); err != nil {
 		return fmt.Errorf("failed to prepare Docker image: %w", err)
 	}
 
-	localUI, err := ui.docker.ContainerCreate(ctx,
+	embedUI, err := ui.docker.ContainerCreate(ctx,
 		&container.Config{
 			Labels: map[string]string{
-				cont.DBLabSatelliteLabel:  cont.DBLabLocalUILabel,
+				cont.DBLabSatelliteLabel:  cont.DBLabEmbedUILabel,
 				cont.DBLabInstanceIDLabel: ui.engProps.InstanceID,
 				cont.DBLabEngineNameLabel: ui.engProps.ContainerName,
 			},
@@ -125,27 +125,27 @@ func (ui *UIManager) Run(ctx context.Context) error {
 		},
 		&network.NetworkingConfig{},
 		nil,
-		getLocalUIName(ui.engProps.InstanceID),
+		getEmbedUIName(ui.engProps.InstanceID),
 	)
 
 	if err != nil {
-		return fmt.Errorf("failed to prepare Docker image for LocalUI: %w", err)
+		return fmt.Errorf("failed to prepare Docker image for Embed UI: %w", err)
 	}
 
-	if err := networks.Connect(ctx, ui.docker, ui.engProps.InstanceID, localUI.ID); err != nil {
+	if err := networks.Connect(ctx, ui.docker, ui.engProps.InstanceID, embedUI.ID); err != nil {
 		return fmt.Errorf("failed to connect UI container to the internal Docker network: %w", err)
 	}
 
-	if err := ui.docker.ContainerStart(ctx, localUI.ID, types.ContainerStartOptions{}); err != nil {
-		return fmt.Errorf("failed to start container %q: %w", localUI.ID, err)
+	if err := ui.docker.ContainerStart(ctx, embedUI.ID, types.ContainerStartOptions{}); err != nil {
+		return fmt.Errorf("failed to start container %q: %w", embedUI.ID, err)
 	}
 
 	reportLaunching(ui.cfg)
 
 	return nil
 }
 
-// Restart destroys and creates a new local UI container.
+// Restart destroys and creates a new Embed UI container.
 func (ui *UIManager) Restart(ctx context.Context) error {
 	ui.Stop(ctx)
 
@@ -156,22 +156,22 @@ func (ui *UIManager) Restart(ctx context.Context) error {
 	return nil
 }
 
-// Stop removes a local UI container.
+// Stop removes a Embed UI container.
 func (ui *UIManager) Stop(ctx context.Context) {
-	tools.RemoveContainer(ctx, ui.docker, getLocalUIName(ui.engProps.InstanceID), cont.StopTimeout)
+	tools.RemoveContainer(ctx, ui.docker, getEmbedUIName(ui.engProps.InstanceID), cont.StopTimeout)
 }
 
-func getLocalUIName(instanceID string) string {
-	return cont.DBLabLocalUILabel + "_" + instanceID
+func getEmbedUIName(instanceID string) string {
+	return cont.DBLabEmbedUILabel + "_" + instanceID
 }
 
-// reportLaunching reports the launch of the LocalUI container.
+// reportLaunching reports the launch of the Embed UI container.
 func reportLaunching(cfg Config) {
 	host := engine.DefaultListenerHost
 
 	if cfg.Host != "" {
 		host = cfg.Host
 	}
 
-	log.Msg(fmt.Sprintf("Local UI has started successfully on %s:%d.", host, cfg.Port))
+	log.Msg(fmt.Sprintf("Embed UI has started successfully on %s:%d.", host, cfg.Port))
 }

internal/retrieval/engine/postgres/tools/cont/container.go

@@ -53,8 +53,8 @@ const (
 	DBLabDumpLabel = "dblab_dump"
 	// DBLabRestoreLabel defines a label value for restore containers.
 	DBLabRestoreLabel = "dblab_restore"
-	// DBLabLocalUILabel defines a label value for local UI containers.
-	DBLabLocalUILabel = "dblab_local_ui"
+	// DBLabEmbedUILabel defines a label value for embed UI containers.
+	DBLabEmbedUILabel = "dblab_embed_ui"
 
 	// DBLabRunner defines a label to mark runner containers.
 	DBLabRunner = "dblab_runner"

pkg/config/config.go

@@ -15,8 +15,8 @@ import (
 	"gopkg.in/yaml.v2"
 
 	"gitlab.com/postgres-ai/database-lab/v3/internal/cloning"
+	"gitlab.com/postgres-ai/database-lab/v3/internal/embedui"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/estimator"
-	"gitlab.com/postgres-ai/database-lab/v3/internal/localui"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/observer"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/platform"
 	"gitlab.com/postgres-ai/database-lab/v3/internal/provision"
@@ -44,7 +44,7 @@ type Config struct {
 	Observer    observer.Config  `yaml:"observer"`
 	Estimator   estimator.Config `yaml:"estimator"`
 	PoolManager pool.Config      `yaml:"poolManager"`
-	LocalUI     localui.Config   `yaml:"localUI"`
+	EmbedUI     embedui.Config   `yaml:"embedUI"`
 }
 
 // LoadConfiguration instances a new application configuration.

test/1.synthetic.sh

@@ -81,7 +81,7 @@ curl https://gitlab.com/postgres-ai/database-lab/-/raw/"${CI_COMMIT_BRANCH:-mast
 yq eval -i '
   .global.debug = true |
   .global.telemetry.enabled = false |
-  .localUI.enabled = false |
+  .embedUI.enabled = false |
   .server.port = env(DLE_SERVER_PORT) |
   .provision.portPool.from = env(DLE_PORT_POOL_FROM) |
   .provision.portPool.to = env(DLE_PORT_POOL_TO) |

test/2.logical_generic.sh

@@ -87,7 +87,7 @@ curl https://gitlab.com/postgres-ai/database-lab/-/raw/"${CI_COMMIT_BRANCH:-mast
 yq eval -i '
   .global.debug = true |
   .global.telemetry.enabled = false |
-  .localUI.enabled = false |
+  .embedUI.enabled = false |
   .server.port = env(DLE_SERVER_PORT) |
   .poolManager.mountDir = env(DLE_TEST_MOUNT_DIR) |
   .provision.portPool.from = env(DLE_PORT_POOL_FROM) |

test/3.physical_walg.sh

@@ -47,7 +47,7 @@ curl https://gitlab.com/postgres-ai/database-lab/-/raw/"${CI_COMMIT_BRANCH:-mast
 yq eval -i '
   .global.debug = true |
   .global.telemetry.enabled = false |
-  .localUI.enabled = false |
+  .embedUI.enabled = false |
   .server.port = env(DLE_SERVER_PORT) |
   .poolManager.mountDir = env(DLE_TEST_MOUNT_DIR) |
   .provision.portPool.from = env(DLE_PORT_POOL_FROM) |

test/4.physical_basebackup.sh

@@ -102,7 +102,7 @@ curl https://gitlab.com/postgres-ai/database-lab/-/raw/"${CI_COMMIT_BRANCH:-mast
 yq eval -i '
   .global.debug = true |
   .global.telemetry.enabled = false |
-  .localUI.enabled = false |
+  .embedUI.enabled = false |
   .server.port = env(DLE_SERVER_PORT) |
   .poolManager.mountDir = env(DLE_TEST_MOUNT_DIR) |
   .provision.portPool.from = env(DLE_PORT_POOL_FROM) |

test/5.logical_rds.sh

@@ -43,7 +43,7 @@ curl https://gitlab.com/postgres-ai/database-lab/-/raw/"${CI_COMMIT_BRANCH:-mast
 yq eval -i '
   .global.debug = true |
   .global.telemetry.enabled = false |
-  .localUI.enabled = false |
+  .embedUI.enabled = false |
   .server.port = env(DLE_SERVER_PORT) |
   .poolManager.mountDir = env(DLE_TEST_MOUNT_DIR) |
   .provision.portPool.from = env(DLE_PORT_POOL_FROM) |