Skip to content

Commit cbdcbe8

Browse files
agneumagneum
committed
feat: Create a new satellite container containing the UI app to have a visual and more user-friendly interface to interact with DLE (#302):
* prepare configuration of the local UI container * start and stop the local UI container * support configuration reloading * manages the container state after configuration reloading
1 parent b8c883e commit cbdcbe8

File tree

14 files changed

+384
-78
lines changed

14 files changed

+384
-78
lines changed

‎cmd/database-lab/main.go‎

Lines changed: 52 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import (
2323
"gitlab.com/postgres-ai/database-lab/v2/pkg/config"
2424
"gitlab.com/postgres-ai/database-lab/v2/pkg/config/global"
2525
"gitlab.com/postgres-ai/database-lab/v2/pkg/estimator"
26+
"gitlab.com/postgres-ai/database-lab/v2/pkg/localui"
2627
"gitlab.com/postgres-ai/database-lab/v2/pkg/log"
2728
"gitlab.com/postgres-ai/database-lab/v2/pkg/observer"
2829
"gitlab.com/postgres-ai/database-lab/v2/pkg/retrieval"
@@ -49,20 +50,6 @@ func main() {
4950
log.Fatal(errors.WithMessage(err, "failed to parse config"))
5051
}
5152

52-
log.Msg("Database Lab Instance ID:", cfg.Global.InstanceID)
53-
log.Msg("Database Lab Engine version:", version.GetVersion())
54-
55-
if cfg.Server.VerificationToken == "" {
56-
log.Warn("Verification Token is empty. Database Lab Engine is insecure")
57-
}
58-
59-
runner := runners.NewLocalRunner(cfg.Provision.UseSudo)
60-
61-
pm := pool.NewPoolManager(&cfg.PoolManager, runner)
62-
if err := pm.ReloadPools(); err != nil {
63-
log.Fatal(err.Error())
64-
}
65-
6653
dockerCLI, err := client.NewClientWithOpts(client.FromEnv)
6754
if err != nil {
6855
log.Fatal("Failed to create a Docker client:", err)
@@ -71,13 +58,27 @@ func main() {
7158
ctx, cancel := context.WithCancel(context.Background())
7259
defer cancel()
7360

74-
engProps, err := getEngineProperties(ctx, dockerCLI, cfg.Global.InstanceID)
61+
engProps, err := getEngineProperties(ctx, dockerCLI, cfg)
7562
if err != nil {
7663
log.Err("failed to get Database Lab Engine properties:", err.Error())
7764
return
7865
}
7966

80-
internalNetworkID, err := networks.Setup(ctx, dockerCLI, cfg.Global.InstanceID, engProps.ContainerName)
67+
log.Msg("Database Lab Instance ID:", engProps.InstanceID)
68+
log.Msg("Database Lab Engine version:", version.GetVersion())
69+
70+
if cfg.Server.VerificationToken == "" {
71+
log.Warn("Verification Token is empty. Database Lab Engine is insecure")
72+
}
73+
74+
runner := runners.NewLocalRunner(cfg.Provision.UseSudo)
75+
76+
pm := pool.NewPoolManager(&cfg.PoolManager, runner)
77+
if err := pm.ReloadPools(); err != nil {
78+
log.Fatal(err.Error())
79+
}
80+
81+
internalNetworkID, err := networks.Setup(ctx, dockerCLI, engProps.InstanceID, engProps.ContainerName)
8182
if err != nil {
8283
log.Errf(err.Error())
8384
return
@@ -152,10 +153,11 @@ func main() {
152153
Restore: retrievalSvc.CollectRestoreTelemetry(),
153154
})
154155

156+
localUI := localui.New(cfg.LocalUI, engProps, runner, dockerCLI)
155157
server := srv.NewServer(&cfg.Server, &cfg.Global, engProps, cloningSvc, retrievalSvc, platformSvc, dockerCLI, obs, est, pm, tm)
156158
shutdownCh := setShutdownListener()
157159

158-
go setReloadListener(ctx, provisionSvc, tm, retrievalSvc, pm, cloningSvc, platformSvc, est, server)
160+
go setReloadListener(ctx, provisionSvc, tm, retrievalSvc, pm, cloningSvc, platformSvc, est, localUI, server)
159161

160162
server.InitHandlers()
161163

@@ -166,6 +168,17 @@ func main() {
166168
}
167169
}()
168170

171+
if cfg.LocalUI.Enabled {
172+
go func() {
173+
if err := localUI.Run(ctx); err != nil {
174+
log.Err("Failed to start local UI container:", err.Error())
175+
return
176+
}
177+
178+
log.Msg("Local UI has started successfully")
179+
}()
180+
}
181+
169182
<-shutdownCh
170183
cancel()
171184

@@ -181,7 +194,7 @@ func main() {
181194
tm.SendEvent(ctx, telemetry.EngineStoppedEvent, telemetry.EngineStopped{Uptime: server.Uptime()})
182195
}
183196

184-
func getEngineProperties(ctx context.Context, dockerCLI *client.Client, instanceID string) (global.EngineProps, error) {
197+
func getEngineProperties(ctx context.Context, dockerCLI *client.Client, cfg *config.Config) (global.EngineProps, error) {
185198
hostname := os.Getenv("HOSTNAME")
186199
if hostname == "" {
187200
return global.EngineProps{}, errors.New("hostname is empty")
@@ -192,16 +205,23 @@ func getEngineProperties(ctx context.Context, dockerCLI *client.Client, instance
192205
return global.EngineProps{}, fmt.Errorf("failed to inspect DLE container: %w", err)
193206
}
194207

208+
instanceID, err := config.LoadInstanceID(cfg.PoolManager.MountDir)
209+
if err != nil {
210+
return global.EngineProps{}, fmt.Errorf("failed to load instance ID: %w", err)
211+
}
212+
195213
engProps := global.EngineProps{
196214
InstanceID: instanceID,
197215
ContainerName: strings.Trim(dleContainer.Name, "/"),
216+
EnginePort: cfg.Server.Port,
198217
}
199218

200219
return engProps, nil
201220
}
202221

203222
func reloadConfig(ctx context.Context, provisionSvc *provision.Provisioner, tm *telemetry.Agent, retrievalSvc *retrieval.Retrieval,
204-
pm *pool.Manager, cloningSvc *cloning.Base, platformSvc *platform.Service, est *estimator.Estimator, server *srv.Server) error {
223+
pm *pool.Manager, cloningSvc *cloning.Base, platformSvc *platform.Service, est *estimator.Estimator, localUI *localui.UIManager,
224+
server *srv.Server) error {
205225
cfg, err := config.LoadConfiguration()
206226
if err != nil {
207227
return err
@@ -224,6 +244,10 @@ func reloadConfig(ctx context.Context, provisionSvc *provision.Provisioner, tm *
224244
return err
225245
}
226246

247+
if err := localUI.Reload(ctx, cfg.LocalUI); err != nil {
248+
return err
249+
}
250+
227251
dbCfg := resources.DB{
228252
Username: cfg.Global.Database.User(),
229253
DBName: cfg.Global.Database.Name(),
@@ -241,14 +265,15 @@ func reloadConfig(ctx context.Context, provisionSvc *provision.Provisioner, tm *
241265
}
242266

243267
func setReloadListener(ctx context.Context, provisionSvc *provision.Provisioner, tm *telemetry.Agent, retrievalSvc *retrieval.Retrieval,
244-
pm *pool.Manager, cloningSvc *cloning.Base, platformSvc *platform.Service, est *estimator.Estimator, server *srv.Server) {
268+
pm *pool.Manager, cloningSvc *cloning.Base, platformSvc *platform.Service, est *estimator.Estimator, localUI *localui.UIManager,
269+
server *srv.Server) {
245270
reloadCh := make(chan os.Signal, 1)
246271
signal.Notify(reloadCh, syscall.SIGHUP)
247272

248273
for range reloadCh {
249274
log.Msg("Reloading configuration")
250275

251-
if err := reloadConfig(ctx, provisionSvc, tm, retrievalSvc, pm, cloningSvc, platformSvc, est, server); err != nil {
276+
if err := reloadConfig(ctx, provisionSvc, tm, retrievalSvc, pm, cloningSvc, platformSvc, est, localUI, server); err != nil {
252277
log.Err("Failed to reload configuration", err)
253278
}
254279

@@ -264,13 +289,17 @@ func setShutdownListener() chan os.Signal {
264289
}
265290

266291
func shutdownDatabaseLabEngine(ctx context.Context, dockerCLI *client.Client, engProps global.EngineProps, fsp *resources.Pool) {
267-
log.Msg("Stopping control containers")
292+
log.Msg("Stopping auxiliary containers")
268293

269294
if err := cont.StopControlContainers(ctx, dockerCLI, engProps.InstanceID, fsp.DataDir()); err != nil {
270295
log.Err("Failed to stop control containers", err)
271296
}
272297

273-
log.Msg("Control containers have been stopped")
298+
if err := cont.CleanUpSatelliteContainers(ctx, dockerCLI, engProps.InstanceID); err != nil {
299+
log.Err("Failed to stop satellite containers", err)
300+
}
301+
302+
log.Msg("Auxiliary containers have been stopped")
274303
}
275304

276305
func removeObservingClones(obsCh chan string, obs *observer.Observer) {

‎configs/config.example.logical_generic.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@ server:
2525
# HTTP server port. Default: 2345.
2626
port: 2345
2727

28+
# Local UI. Controls the application to provide a user interface to DLE API.
29+
localUI:
30+
enabled: true
31+
32+
# Docker image of the UI application.
33+
dockerImage: "postgresai/basic-ui:latest"
34+
35+
# HTTP port of the UI application. Default: 2346.
36+
port: 2346
37+
2838
global:
2939
# Database engine. Currently, the only supported option: "postgres".
3040
engine: postgres

‎configs/config.example.logical_rds_iam.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@ server:
2525
# HTTP server port. Default: 2345.
2626
port: 2345
2727

28+
# Local UI. Controls the application to provide a user interface to DLE API.
29+
localUI:
30+
enabled: true
31+
32+
# Docker image of the UI application.
33+
dockerImage: "postgresai/basic-ui:latest"
34+
35+
# HTTP port of the UI application. Default: 2346.
36+
port: 2346
37+
2838
global:
2939
# Database engine. Currently, the only supported option: "postgres".
3040
engine: postgres

‎configs/config.example.physical_generic.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@ server:
2525
# HTTP server port. Default: 2345.
2626
port: 2345
2727

28+
# Local UI. Controls the application to provide a user interface to DLE API.
29+
localUI:
30+
enabled: true
31+
32+
# Docker image of the UI application.
33+
dockerImage: "postgresai/basic-ui:latest"
34+
35+
# HTTP port of the UI application. Default: 2346.
36+
port: 2346
37+
2838
global:
2939
# Database engine. Currently, the only supported option: "postgres".
3040
engine: postgres

‎configs/config.example.physical_walg.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@ server:
2525
# HTTP server port. Default: 2345.
2626
port: 2345
2727

28+
# Local UI. Controls the application to provide a user interface to DLE API.
29+
localUI:
30+
enabled: true
31+
32+
# Docker image of the UI application.
33+
dockerImage: "postgresai/basic-ui:latest"
34+
35+
# HTTP port of the UI application. Default: 2346.
36+
port: 2346
37+
2838
global:
2939
# Database engine. Currently, the only supported option: "postgres".
3040
engine: postgres

‎pkg/config/config.go‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import (
1616

1717
"gitlab.com/postgres-ai/database-lab/v2/pkg/config/global"
1818
"gitlab.com/postgres-ai/database-lab/v2/pkg/estimator"
19+
"gitlab.com/postgres-ai/database-lab/v2/pkg/localui"
1920
"gitlab.com/postgres-ai/database-lab/v2/pkg/log"
2021
"gitlab.com/postgres-ai/database-lab/v2/pkg/observer"
2122
retConfig "gitlab.com/postgres-ai/database-lab/v2/pkg/retrieval/config"
@@ -43,6 +44,7 @@ type Config struct {
4344
Observer observer.Config `yaml:"observer"`
4445
Estimator estimator.Config `yaml:"estimator"`
4546
PoolManager pool.Config `yaml:"poolManager"`
47+
LocalUI localui.Config `yaml:"localUI"`
4648
}
4749

4850
// LoadConfiguration instances a new application configuration.
@@ -55,28 +57,29 @@ func LoadConfiguration() (*Config, error) {
5557
log.SetDebug(cfg.Global.Debug)
5658
log.Dbg("Config loaded", cfg)
5759

58-
return cfg, cfg.loadInstanceID()
60+
return cfg, nil
5961
}
6062

61-
// loadInstanceID tries to make instance ID persistent across runs and load its value after restart
62-
func (cfg *Config) loadInstanceID() error {
63-
idFilepath := filepath.Join(cfg.PoolManager.MountDir, instanceIDFile)
63+
// LoadInstanceID tries to make instance ID persistent across runs and load its value after restart
64+
func LoadInstanceID(mountDir string) (string, error) {
65+
instanceID := ""
66+
idFilepath := filepath.Join(mountDir, instanceIDFile)
6467

6568
data, err := os.ReadFile(idFilepath)
6669
if err != nil {
6770
if os.IsNotExist(err) {
68-
cfg.Global.InstanceID = xid.New().String()
69-
log.Dbg("no instance_id file was found, generate new instance ID", cfg.Global.InstanceID)
71+
instanceID = xid.New().String()
72+
log.Dbg("no instance_id file was found, generate new instance ID", instanceID)
7073

71-
return os.WriteFile(idFilepath, []byte(cfg.Global.InstanceID), 0544)
74+
return instanceID, os.WriteFile(idFilepath, []byte(instanceID), 0544)
7275
}
7376

74-
return fmt.Errorf("failed to load instanceid, %w", err)
77+
return instanceID, fmt.Errorf("failed to load instanceid, %w", err)
7578
}
7679

77-
cfg.Global.InstanceID = string(data)
80+
instanceID = string(data)
7881

79-
return nil
82+
return instanceID, nil
8083
}
8184

8285
// readConfig reads application configuration.
@@ -96,5 +99,5 @@ func readConfig() (*Config, error) {
9699
return nil, errors.WithMessagef(err, "error parsing %s config", configPath)
97100
}
98101

99-
return cfg, cfg.loadInstanceID()
102+
return cfg, nil
100103
}

‎pkg/config/config_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ func (s *ConfigSuite) TearDownTest() {
5959
}
6060

6161
func (s *ConfigSuite) TestGenerateNewID() {
62-
cfg, err := readConfig()
62+
instanceID, err := LoadInstanceID(s.mountDir)
6363
s.Require().NoError(err)
64-
s.NotEmpty(cfg.Global.InstanceID)
64+
s.NotEmpty(instanceID)
6565

6666
data, err := os.ReadFile(filepath.Join(s.mountDir, "instance_id"))
6767
s.NoError(err)
68-
s.Equal(cfg.Global.InstanceID, string(data))
68+
s.Equal(instanceID, string(data))
6969
}
7070

7171
func (s *ConfigSuite) TestLoadInstanceID() {
@@ -74,7 +74,7 @@ func (s *ConfigSuite) TestLoadInstanceID() {
7474
err := os.WriteFile(filepath.Join(s.mountDir, "instance_id"), []byte(instanceID), 0600)
7575
s.Require().NoError(err)
7676

77-
cfg, err := readConfig()
77+
instanceID, err = LoadInstanceID(s.mountDir)
7878
s.NoError(err)
79-
s.Equal(cfg.Global.InstanceID, instanceID)
79+
s.Equal(instanceID, instanceID)
8080
}

‎pkg/config/global/config.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,10 @@ import (
1111

1212
// Config contains global Database Lab configurations.
1313
type Config struct {
14-
InstanceID string
15-
Database Database `yaml:"database"`
16-
Engine string `yaml:"engine"`
17-
Debug bool `yaml:"debug"`
18-
Telemetry Telemetry `yaml:"telemetry"`
14+
Database Database `yaml:"database"`
15+
Engine string `yaml:"engine"`
16+
Debug bool `yaml:"debug"`
17+
Telemetry Telemetry `yaml:"telemetry"`
1918
}
2019

2120
// Database contains default configurations of the managed database.
@@ -52,4 +51,5 @@ type Telemetry struct {
5251
type EngineProps struct {
5352
InstanceID string
5453
ContainerName string
54+
EnginePort uint
5555
}

0 commit comments

Comments
 (0)