Merge branch '225-customize-shared-memory' into 'master'

agneum · agneum · commit e6baac3274a8 · 2021-01-21T04:48:15.000Z
feat: be able to tune shared memory for clone containers (#225) Closes #225 See merge request postgres-ai/database-lab!241
diff --git a/configs/config.example.logical_generic.yml b/configs/config.example.logical_generic.yml
@@ -94,6 +94,11 @@ provision:
   # existing users to log in with old passwords.
   keepUserPasswords: false
 
+  # Custom parameters for clone containers, see
+  # https://docs.docker.com/engine/reference/run/#runtime-constraints-on-resources
+  containerConfig:
+    "shm-size": 256MB
+
 # Data retrieval flow. This section defines both initial retrieval, and rules
 # to keep the data directory in a synchronized state with the source. Both are optional:
 # you may already have the data directory, so neither initial retrieval nor
diff --git a/configs/config.example.logical_rds_iam.yml b/configs/config.example.logical_rds_iam.yml
@@ -94,6 +94,10 @@ provision:
   # existing users to log in with old passwords.
   keepUserPasswords: false
 
+  # Custom parameters for clone containers (https://docs.docker.com/engine/reference/run/#runtime-constraints-on-resources).
+  containerConfig:
+    "shm-size": 256MB
+
 # Data retrieval flow. This section defines both initial retrieval, and rules
 # to keep the data directory in a synchronized state with the source. Both are optional:
 # you may already have the data directory, so neither initial retrieval nor
diff --git a/configs/config.example.physical_generic.yml b/configs/config.example.physical_generic.yml
@@ -94,6 +94,10 @@ provision:
   # existing users to log in with old passwords.
   keepUserPasswords: false
 
+  # Custom parameters for clone containers (https://docs.docker.com/engine/reference/run/#runtime-constraints-on-resources).
+  containerConfig:
+    "shm-size": 256MB
+
 # Data retrieval flow. This section defines both initial retrieval, and rules
 # to keep the data directory in a synchronized state with the source. Both are optional:
 # you may already have the data directory, so neither initial retrieval nor
diff --git a/configs/config.example.physical_walg.yml b/configs/config.example.physical_walg.yml
@@ -94,6 +94,10 @@ provision:
   # existing users to log in with old passwords.
   keepUserPasswords: false
 
+  # Custom parameters for clone containers (https://docs.docker.com/engine/reference/run/#runtime-constraints-on-resources).
+  containerConfig:
+    "shm-size": 256MB
+
 # Data retrieval flow. This section defines both initial retrieval, and rules
 # to keep the data directory in a synchronized state with the source. Both are optional:
 # you may already have the data directory, so neither initial retrieval nor
diff --git a/pkg/services/provision/docker/docker.go b/pkg/services/provision/docker/docker.go
@@ -51,6 +51,11 @@ func RunContainer(r runners.Runner, c *resources.AppConfig) (string, error) {
 		return "", errors.Wrap(err, "failed to create socket clone directory")
 	}
 
+	containerFlags := make([]string, 0, len(c.ContainerConf))
+	for flagName, flagValue := range c.ContainerConf {
+		containerFlags = append(containerFlags, fmt.Sprintf("--%s=%s", flagName, flagValue))
+	}
+
 	instancePort := strconv.Itoa(int(c.Port))
 	dockerRunCmd := strings.Join([]string{
 		"docker run",
@@ -61,6 +66,7 @@ func RunContainer(r runners.Runner, c *resources.AppConfig) (string, error) {
 		strings.Join(volumes, " "),
 		"--label", labelClone,
 		"--label", c.Pool.Name,
+		strings.Join(containerFlags, " "),
 		c.DockerImage,
 		"-p", instancePort,
 		"-k", unixSocketCloneDir,
diff --git a/pkg/services/provision/mode_local.go b/pkg/services/provision/mode_local.go
@@ -43,10 +43,11 @@ type PortPool struct {
 
 // Config defines configuration for provisioning.
 type Config struct {
-	PortPool          PortPool `yaml:"portPool"`
-	DockerImage       string   `yaml:"dockerImage"`
-	UseSudo           bool     `yaml:"useSudo"`
-	KeepUserPasswords bool     `yaml:"keepUserPasswords"`
+	PortPool          PortPool          `yaml:"portPool"`
+	DockerImage       string            `yaml:"dockerImage"`
+	UseSudo           bool              `yaml:"useSudo"`
+	KeepUserPasswords bool              `yaml:"keepUserPasswords"`
+	ContainerConfig   map[string]string `yaml:"containerConfig"`
 }
 
 // Provisioner describes a struct for ports and clones management.
@@ -465,12 +466,13 @@ func (p *Provisioner) stopPoolSessions(fsm pool.FSManager) error {
 
 func (p *Provisioner) getAppConfig(pool *resources.Pool, name string, port uint) *resources.AppConfig {
 	appConfig := &resources.AppConfig{
-		CloneName:   name,
-		DockerImage: p.config.DockerImage,
-		Host:        pool.SocketCloneDir(name),
-		Port:        port,
-		DB:          p.dbCfg,
-		Pool:        *pool,
+		CloneName:     name,
+		DockerImage:   p.config.DockerImage,
+		Host:          pool.SocketCloneDir(name),
+		Port:          port,
+		DB:            p.dbCfg,
+		Pool:          *pool,
+		ContainerConf: p.config.ContainerConfig,
 	}
 
 	return appConfig
diff --git a/pkg/services/provision/resources/appconfig.go b/pkg/services/provision/resources/appconfig.go
@@ -17,7 +17,8 @@ type AppConfig struct {
 	Port        uint
 	DB          *DB
 
-	extraConf map[string]string
+	ContainerConf map[string]string
+	pgExtraConf   map[string]string
 }
 
 // DB describes a default database configuration.
@@ -34,10 +35,10 @@ func (c *AppConfig) DataDir() string {
 
 // ExtraConf returns a map with an extra configuration.
 func (c *AppConfig) ExtraConf() map[string]string {
-	return c.extraConf
+	return c.pgExtraConf
 }
 
 // SetExtraConf sets a map with an extra configuration.
 func (c *AppConfig) SetExtraConf(extraConf map[string]string) {
-	c.extraConf = extraConf
+	c.pgExtraConf = extraConf
 }

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,8 @@ type AppConfig struct {`
`17`	`17`	`Port uint`
`18`	`18`	`DB *DB`
`19`	`19`
`20`		`- extraConf map[string]string`
	`20`	`+ ContainerConf map[string]string`
	`21`	`+ pgExtraConf map[string]string`
`21`	`22`	`}`
`22`	`23`
`23`	`24`	`// DB describes a default database configuration.`
`@@ -34,10 +35,10 @@ func (c *AppConfig) DataDir() string {`
`34`	`35`
`35`	`36`	`// ExtraConf returns a map with an extra configuration.`
`36`	`37`	`func (c *AppConfig) ExtraConf() map[string]string {`
`37`		`- return c.extraConf`
	`38`	`+ return c.pgExtraConf`
`38`	`39`	`}`
`39`	`40`
`40`	`41`	`// SetExtraConf sets a map with an extra configuration.`
`41`	`42`	`func (c *AppConfig) SetExtraConf(extraConf map[string]string) {`
`42`		`- c.extraConf = extraConf`
	`43`	`+ c.pgExtraConf = extraConf`
`43`	`44`	`}`