CLOUDP-101809: Respect value of storage.dbPath (#753)

Author: chatton

api/v1/mongodbcommunity_types.go

@@ -3,6 +3,7 @@ package v1
 import (
 	"encoding/json"
 	"fmt"
+	"github.com/stretchr/objx"
 	"net/url"
 	"strings"
 
@@ -405,6 +406,14 @@ type MongoDBCommunity struct {
 	Status MongoDBCommunityStatus `json:"status,omitempty"`
 }
 
+func (m MongoDBCommunity) GetMongodConfiguration() map[string]interface{} {
+	mongodConfig := objx.New(map[string]interface{}{})
+	for k, v := range m.Spec.AdditionalMongodConfig.Object {
+		mongodConfig.Set(k, v)
+	}
+	return mongodConfig
+}
+
 func (m MongoDBCommunity) GetAgentPasswordSecretNamespacedName() types.NamespacedName {
 	return types.NamespacedName{Name: m.Name + "-agent-password", Namespace: m.Namespace}
 }

controllers/construct/build_statefulset_test.go

@@ -61,7 +61,7 @@ func TestMultipleCalls_DoNotCauseSideEffects(t *testing.T) {
 }
 
 func TestMongod_Container(t *testing.T) {
-	c := container.New(mongodbContainer("4.2", []corev1.VolumeMount{}))
+	c := container.New(mongodbContainer("4.2", []corev1.VolumeMount{}, map[string]interface{}{}))
 
 	t.Run("Has correct Env vars", func(t *testing.T) {
 		assert.Len(t, c.Env, 1)
@@ -78,6 +78,25 @@ func TestMongod_Container(t *testing.T) {
 	})
 }
 
+func TestGetDbPath(t *testing.T) {
+	t.Run("Test default is used if unspecifed", func(t *testing.T) {
+		m := map[string]interface{}{}
+		path := GetDBDataDir(m)
+		assert.Equal(t, defaultDataDir, path)
+	})
+
+	t.Run("Test storage.dbPath is used if specified", func(t *testing.T) {
+		m := map[string]interface{}{
+			"storage": map[string]interface{}{
+				"dbPath": "/data/db",
+			},
+		}
+
+		path := GetDBDataDir(m)
+		assert.Equal(t, "/data/db", path)
+	})
+}
+
 func assertStatefulSetIsBuiltCorrectly(t *testing.T, mdb mdbv1.MongoDBCommunity, sts *appsv1.StatefulSet) {
 	assert.Len(t, sts.Spec.Template.Spec.Containers, 2)
 	assert.Len(t, sts.Spec.Template.Spec.InitContainers, 2)

controllers/construct/mongodbstatefulset.go

@@ -2,6 +2,7 @@ package construct
 
 import (
 	"fmt"
+	"github.com/stretchr/objx"
 	"os"
 	"strings"
 
@@ -43,8 +44,9 @@ const (
 	ReadinessProbeImageEnv     = "READINESS_PROBE_IMAGE"
 	ManagedSecurityContextEnv  = "MANAGED_SECURITY_CONTEXT"
 
-	automationconfFilePath = "/data/automation-mongod.conf"
-	keyfileFilePath        = "/var/lib/mongodb-mms-automation/authentication/keyfile"
+	defaultDataDir               = "/data"
+	automationMongodConfFileName = "automation-mongod.conf"
+	keyfileFilePath              = "/var/lib/mongodb-mms-automation/authentication/keyfile"
 
 	automationAgentOptions = " -skipMongoStart -noDaemonize -useLocalMongoDbTools"
 
@@ -82,6 +84,9 @@ type MongoDBStatefulSetOwner interface {
 	DataVolumeName() string
 	// LogsVolumeName returns the name that the data volume should have
 	LogsVolumeName() string
+
+	// GetMongodConfiguration returns the MongoDB configuration for each member.
+	GetMongodConfiguration() map[string]interface{}
 }
 
 // BuildMongoDBReplicaSetStatefulSetModificationFunction builds the parts of the replica set that are common between every resource that implements
@@ -122,14 +127,14 @@ func BuildMongoDBReplicaSetStatefulSetModificationFunction(mdb MongoDBStatefulSe
 	singleModeVolumeClaim := func(s *appsv1.StatefulSet) {}
 	if mdb.HasSeparateDataAndLogsVolumes() {
 		logVolumeMount := statefulset.CreateVolumeMount(mdb.LogsVolumeName(), automationconfig.DefaultAgentLogPath)
-		dataVolumeMount := statefulset.CreateVolumeMount(mdb.DataVolumeName(), "/data")
+		dataVolumeMount := statefulset.CreateVolumeMount(mdb.DataVolumeName(), GetDBDataDir(mdb.GetMongodConfiguration()))
 		dataVolumeClaim = statefulset.WithVolumeClaim(mdb.DataVolumeName(), dataPvc(mdb.DataVolumeName()))
 		logVolumeClaim = statefulset.WithVolumeClaim(mdb.LogsVolumeName(), logsPvc(mdb.LogsVolumeName()))
 		mongodbAgentVolumeMounts = append(mongodbAgentVolumeMounts, dataVolumeMount, logVolumeMount)
 		mongodVolumeMounts = append(mongodVolumeMounts, dataVolumeMount, logVolumeMount)
 	} else {
 		mounts := []corev1.VolumeMount{
-			statefulset.CreateVolumeMount(mdb.DataVolumeName(), "/data", statefulset.WithSubPath("data")),
+			statefulset.CreateVolumeMount(mdb.DataVolumeName(), GetDBDataDir(mdb.GetMongodConfiguration()), statefulset.WithSubPath("data")),
 			statefulset.CreateVolumeMount(mdb.DataVolumeName(), automationconfig.DefaultAgentLogPath, statefulset.WithSubPath("logs")),
 		}
 		mongodbAgentVolumeMounts = append(mongodbAgentVolumeMounts, mounts...)
@@ -165,7 +170,7 @@ func BuildMongoDBReplicaSetStatefulSetModificationFunction(mdb MongoDBStatefulSe
 				podtemplatespec.WithVolume(keyFileVolume),
 				podtemplatespec.WithServiceAccount(mongodbDatabaseServiceAccountName),
 				podtemplatespec.WithContainer(AgentName, mongodbAgentContainer(mdb.AutomationConfigSecretName(), mongodbAgentVolumeMounts)),
-				podtemplatespec.WithContainer(MongodbName, mongodbContainer(mdb.GetMongoDBVersion(), mongodVolumeMounts)),
+				podtemplatespec.WithContainer(MongodbName, mongodbContainer(mdb.GetMongoDBVersion(), mongodVolumeMounts, mdb.GetMongodConfiguration())),
 				podtemplatespec.WithInitContainer(versionUpgradeHookName, versionUpgradeHookInit([]corev1.VolumeMount{hooksVolumeMount})),
 				podtemplatespec.WithInitContainer(ReadinessProbeContainerName, readinessProbeInit([]corev1.VolumeMount{scriptsVolumeMount})),
 			),
@@ -276,7 +281,16 @@ func getMongoDBImage(version string) string {
 	return fmt.Sprintf("%s/%s:%s", repoUrl, mongoImageName, version)
 }
 
-func mongodbContainer(version string, volumeMounts []corev1.VolumeMount) container.Modification {
+// GetDBDataDir returns the db path which should be used.
+func GetDBDataDir(additionalMongoDBConfig objx.Map) string {
+	if additionalMongoDBConfig == nil {
+		return defaultDataDir
+	}
+	return additionalMongoDBConfig.Get("storage.dbPath").Str(defaultDataDir)
+}
+
+func mongodbContainer(version string, volumeMounts []corev1.VolumeMount, additionalMongoDBConfig map[string]interface{}) container.Modification {
+	filePath := GetDBDataDir(additionalMongoDBConfig) + "/" + automationMongodConfFileName
 	mongoDbCommand := fmt.Sprintf(`
 #run post-start hook to handle version changes
 /hooks/version-upgrade
@@ -291,7 +305,7 @@ tail -F /var/log/mongodb-mms-automation/mongodb.log > /dev/stdout &
 # start mongod with this configuration
 exec mongod -f %s;
 
-`, automationconfFilePath, keyfileFilePath, automationconfFilePath)
+`, filePath, keyfileFilePath, filePath)
 
 	containerCommand := []string{
 		"/bin/sh",

controllers/replica_set_controller.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/imdario/mergo"
+	"github.com/stretchr/objx"
 	"os"
 
 	"github.com/mongodb/mongodb-kubernetes-operator/controllers/predicates"
@@ -25,13 +27,10 @@ import (
 
 	"github.com/pkg/errors"
 
-	"github.com/imdario/mergo"
-	"github.com/mongodb/mongodb-kubernetes-operator/pkg/authentication/scram"
-	"github.com/stretchr/objx"
-
 	"github.com/mongodb/mongodb-kubernetes-operator/controllers/construct"
 	"github.com/mongodb/mongodb-kubernetes-operator/controllers/validation"
 	"github.com/mongodb/mongodb-kubernetes-operator/controllers/watch"
+	"github.com/mongodb/mongodb-kubernetes-operator/pkg/authentication/scram"
 
 	"github.com/mongodb/mongodb-kubernetes-operator/pkg/kube/annotations"
 	"github.com/mongodb/mongodb-kubernetes-operator/pkg/kube/podtemplatespec"
@@ -441,6 +440,7 @@ func buildAutomationConfig(mdb mdbv1.MongoDBCommunity, auth automationconfig.Aut
 		SetFCV(mdb.Spec.FeatureCompatibilityVersion).
 		SetOptions(automationconfig.Options{DownloadBase: "/var/lib/mongodb-mms-automation"}).
 		SetAuth(auth).
+		SetDataDir(construct.GetDBDataDir(mdb.GetMongodConfiguration())).
 		AddModifications(getMongodConfigModification(mdb)).
 		AddModifications(modifications...).
 		Build()

controllers/replicaset_controller_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/mongodb/mongodb-kubernetes-operator/pkg/kube/container"
 	"io/ioutil"
 	"os"
 	"reflect"
@@ -611,7 +612,7 @@ func TestReplicaSet_IsScaledUpToDesiredMembers_WhenFirstCreated(t *testing.T) {
 }
 
 func TestVolumeClaimTemplates_Configuration(t *testing.T) {
-	sts := performReconciliationAndGetStatefulSet(t, "volume_claim_templates_mdb.yaml")
+	sts, _ := performReconciliationAndGetStatefulSet(t, "volume_claim_templates_mdb.yaml")
 
 	assert.Len(t, sts.Spec.VolumeClaimTemplates, 3)
 
@@ -626,7 +627,7 @@ func TestVolumeClaimTemplates_Configuration(t *testing.T) {
 }
 
 func TestChangeDataVolume_Configuration(t *testing.T) {
-	sts := performReconciliationAndGetStatefulSet(t, "change_data_volume.yaml")
+	sts, _ := performReconciliationAndGetStatefulSet(t, "change_data_volume.yaml")
 	assert.Len(t, sts.Spec.VolumeClaimTemplates, 2)
 
 	dataVolume := sts.Spec.VolumeClaimTemplates[0]
@@ -639,7 +640,7 @@ func TestChangeDataVolume_Configuration(t *testing.T) {
 }
 
 func TestCustomStorageClass_Configuration(t *testing.T) {
-	sts := performReconciliationAndGetStatefulSet(t, "custom_storage_class.yaml")
+	sts, _ := performReconciliationAndGetStatefulSet(t, "custom_storage_class.yaml")
 
 	dataVolume := sts.Spec.VolumeClaimTemplates[0]
 
@@ -655,7 +656,7 @@ func TestCustomStorageClass_Configuration(t *testing.T) {
 }
 
 func TestCustomTaintsAndTolerations_Configuration(t *testing.T) {
-	sts := performReconciliationAndGetStatefulSet(t, "tolerations_example.yaml")
+	sts, _ := performReconciliationAndGetStatefulSet(t, "tolerations_example.yaml")
 
 	assert.Len(t, sts.Spec.Template.Spec.Tolerations, 2)
 	assert.Equal(t, "example-key", sts.Spec.Template.Spec.Tolerations[0].Key)
@@ -667,7 +668,39 @@ func TestCustomTaintsAndTolerations_Configuration(t *testing.T) {
 	assert.Equal(t, corev1.TaintEffectNoExecute, sts.Spec.Template.Spec.Tolerations[1].Effect)
 }
 
-func performReconciliationAndGetStatefulSet(t *testing.T, filePath string) appsv1.StatefulSet {
+func TestCustomDataDir_Configuration(t *testing.T) {
+	sts, c := performReconciliationAndGetStatefulSet(t, "specify_data_dir.yaml")
+
+	agentContainer := container.GetByName("mongodb-agent", sts.Spec.Template.Spec.Containers)
+	assert.NotNil(t, agentContainer)
+	assertVolumeMountPath(t, agentContainer.VolumeMounts, "data-volume", "/some/path/db")
+
+	mongoContainer := container.GetByName("mongod", sts.Spec.Template.Spec.Containers)
+	assert.NotNil(t, mongoContainer)
+
+	lastCommand := mongoContainer.Command[len(agentContainer.Command)-1]
+	assert.Contains(t, lastCommand, "/some/path/db", "startup command should be using the newly specified path")
+
+	ac, err := automationconfig.ReadFromSecret(c, types.NamespacedName{Name: "example-mongodb-config", Namespace: "test-ns"})
+	assert.NoError(t, err)
+
+	for _, p := range ac.Processes {
+		actualStoragePath := p.Args26.Get("storage.dbPath").String()
+		assert.Equal(t, "/some/path/db", actualStoragePath, "process dbPath should have been set")
+	}
+}
+
+func assertVolumeMountPath(t *testing.T, mounts []corev1.VolumeMount, name, path string) {
+	for _, v := range mounts {
+		if v.Name == name {
+			assert.Equal(t, path, v.MountPath)
+			return
+		}
+	}
+	t.Fatalf("volume with name %s was not present!", name)
+}
+
+func performReconciliationAndGetStatefulSet(t *testing.T, filePath string) (appsv1.StatefulSet, client.Client) {
 	mdb, err := loadTestFixture(filePath)
 	assert.NoError(t, err)
 	mgr := client.NewManager(&mdb)
@@ -678,7 +711,7 @@ func performReconciliationAndGetStatefulSet(t *testing.T, filePath string) appsv
 
 	sts, err := mgr.Client.GetStatefulSet(mdb.NamespacedName())
 	assert.NoError(t, err)
-	return sts
+	return sts, mgr.Client
 }
 
 func generatePasswordsForAllUsers(mdb mdbv1.MongoDBCommunity, c client.Client) error {

controllers/testdata/specify_data_dir.yaml

@@ -0,0 +1,26 @@
+---
+apiVersion: mongodbcommunity.mongodb.com/v1
+kind: MongoDBCommunity
+metadata:
+  name: example-mongodb
+  namespace: test-ns
+spec:
+  members: 3
+  type: ReplicaSet
+  version: "4.2.6"
+  security:
+    authentication:
+      modes: ["SCRAM"]
+  users:
+    - name: my-user
+      db: admin
+      passwordSecretRef:
+        name: my-user-password
+      roles:
+        - name: clusterAdmin
+          db: admin
+        - name: userAdminAnyDatabase
+          db: admin
+      scramCredentialsSecretName: my-scram
+  additionalMongodConfig:
+    storage.dbPath: /some/path/db

docs/RELEASE_NOTES.md

@@ -6,6 +6,12 @@
   - MongoDB database of the statefulSet is managed using distinct Role, ServiceAccount and RoleBinding.
   - TLS Secret can also contain a single "tls.pem" entry, containing the concatenation of the certificate and key
     - If a TLS secret contains all of "tls.key", "tls.crt" and "tls.pem" entries, the operator will raise an error if the "tls.pem" one is not equal to the concatenation of "tls.crt" with "tls.key"
+
+## MongoDBCommunity Resource
+* Changes
+* Specifying `spec.additionalMongodConfig.storage.dbPath` will now be respected correctly. 
+
+
 ## Updated Image Tags
 
 - mongodb-kubernetes-operator:0.7.1

pkg/automationconfig/automation_config_builder.go

@@ -47,6 +47,7 @@ type Builder struct {
 	cafilePath           string
 	sslConfig            *TLS
 	tlsConfig            *TLS
+	dataDir              string
 }
 
 func NewBuilder() *Builder {
@@ -108,6 +109,11 @@ func (b *Builder) SetName(name string) *Builder {
 	return b
 }
 
+func (b *Builder) SetDataDir(dataDir string) *Builder {
+	b.dataDir = dataDir
+	return b
+}
+
 func (b *Builder) SetFCV(fcv string) *Builder {
 	b.fcv = fcv
 	return b
@@ -209,6 +215,12 @@ func (b *Builder) Build() (AutomationConfig, error) {
 	if err := b.setFeatureCompatibilityVersionIfUpgradeIsHappening(); err != nil {
 		return AutomationConfig{}, errors.Errorf("can't build the automation config: %s", err)
 	}
+
+	dataDir := DefaultMongoDBDataDir
+	if b.dataDir != "" {
+		dataDir = b.dataDir
+	}
+
 	totalVotes := 0
 	for i, h := range hostnames {
 
@@ -226,7 +238,7 @@ func (b *Builder) Build() (AutomationConfig, error) {
 		}
 
 		process.SetPort(27017)
-		process.SetStoragePath(DefaultMongoDBDataDir)
+		process.SetStoragePath(dataDir)
 		process.SetReplicaSetName(b.name)
 
 		for _, mod := range b.processModifications {

test/e2e/replica_set_mongod_config/replica_set_mongod_config_test.go

@@ -37,17 +37,30 @@ func TestReplicaSet(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	// Override the journal compressor setting
-	setting := "storage.wiredTiger.engineConfig.journalCompressor"
-	value := "zlib"
+	settings := []string{
+		"storage.wiredTiger.engineConfig.journalCompressor",
+		"storage.dbPath",
+	}
+
+	values := []string{
+		"zlib",
+		"/some/path/db",
+	}
+
+	// Override the journal compressor and dbPath settings
 	mongodConfig := objx.New(map[string]interface{}{})
-	mongodConfig.Set(setting, value)
+	for i := range settings {
+		mongodConfig.Set(settings[i], values[i])
+	}
+
 	mdb.Spec.AdditionalMongodConfig.Object = mongodConfig
 
 	t.Run("Create MongoDB Resource", mongodbtests.CreateMongoDBResource(&mdb, ctx))
 	t.Run("Basic tests", mongodbtests.BasicFunctionality(&mdb))
 	t.Run("Ensure Authentication", tester.EnsureAuthenticationIsConfigured(3))
 	t.Run("Test Basic Connectivity", tester.ConnectivitySucceeds())
 	t.Run("AutomationConfig has the correct version", mongodbtests.AutomationConfigVersionHasTheExpectedVersion(&mdb, 1))
-	t.Run("Mongod config has been set", tester.EnsureMongodConfig(setting, value))
+	for i := range settings {
+		t.Run(fmt.Sprintf("Mongod setting %s has been set", settings[i]), tester.EnsureMongodConfig(settings[i], values[i]))
+	}
 }