Updated code snippets (#296)

<!-- start git-machete generated -->

# Based on PR #229

## Chain of upstream PRs as of 2025-07-28

* PR #229:
  `master` ← `search/public-preview`

  * **PR #296 (THIS ONE)**:
    `search/public-preview` ← `lsierant/search-snippets-update`

<!-- end git-machete generated -->

# Summary

<!-- Enter your issue summary here.-->

## Proof of Work

<!-- Enter your proof that it works here.-->

## Checklist
- [ ] Have you linked a jira ticket and/or is the ticket in the title?
- [ ] Have you checked whether your jira ticket required DOCSP changes?
- [ ] Have you checked for release_note changes?

---------

Co-authored-by: Yavor Georgiev <[email protected]>
Co-authored-by: Yavor Georgiev <[email protected]>

Author: lsierant

api/v1/search/mongodbsearch_types.go

@@ -19,24 +19,31 @@ const (
 	MongotDefaultPort               = 27027
 	MongotDefaultMetricsPort        = 9946
 	MongotDefautHealthCheckPort     = 8080
-	MongotDefaultSyncSourceUsername = "mongot-user"
+	MongotDefaultSyncSourceUsername = "search-sync-source"
 )
 
 func init() {
 	v1.SchemeBuilder.Register(&MongoDBSearch{}, &MongoDBSearchList{})
 }
 
 type MongoDBSearchSpec struct {
+	// Optional version of MongoDB Search component (mongot). If not set, then the operator will set the most appropriate version of MongoDB Search.
 	// +optional
 	Version string `json:"version"`
+	// MongoDB database connection details from which MongoDB Search will synchronize data to build indexes.
 	// +optional
 	Source *MongoDBSource `json:"source"`
+	// StatefulSetSpec which the operator will apply to the MongoDB Search StatefulSet at the end of the reconcile loop. Use to provide necessary customizations,
+	// which aren't exposed as fields in the MongoDBSearch.spec.
 	// +optional
 	StatefulSetConfiguration *common.StatefulSetConfiguration `json:"statefulSet,omitempty"`
+	// Configure MongoDB Search's persistent volume. If not defined, the operator will request 10GB of storage.
 	// +optional
 	Persistence *common.Persistence `json:"persistence,omitempty"`
+	// Configure resource requests and limits for the MongoDB Search pods.
 	// +optional
 	ResourceRequirements *corev1.ResourceRequirements `json:"resourceRequirements,omitempty"`
+	// Configure security settings of the MongoDB Search server that MongoDB database is connecting to when performing search queries.
 	// +optional
 	Security Security `json:"security"`
 }

controllers/operator/mongodbsearch_controller_test.go

@@ -92,7 +92,7 @@ func buildExpectedMongotConfig(search *searchv1.MongoDBSearch, mdbc *mdbcv1.Mong
 		SyncSource: mongot.ConfigSyncSource{
 			ReplicaSet: mongot.ConfigReplicaSet{
 				HostAndPort:    hostAndPorts,
-				Username:       "mongot-user",
+				Username:       searchv1.MongotDefaultSyncSourceUsername,
 				PasswordFile:   "/tmp/sourceUserPassword",
 				TLS:            ptr.To(false),
 				ReadPreference: ptr.To("secondaryPreferred"),

docker/mongodb-kubernetes-init-ops-manager/mmsconfiguration/edit_mms_configuration.go

@@ -145,7 +145,7 @@ func readLinesFromFile(name string) ([]string, error) {
 func writeLinesToFile(name string, lines []string) error {
 	output := strings.Join(lines, lineBreak)
 
-	err := os.WriteFile(name, []byte(output), 0o775)
+	err := os.WriteFile(name, []byte(output), 0o644)
 	if err != nil {
 		return xerrors.Errorf("error writing to file %s: %w", name, err)
 	}
@@ -168,7 +168,7 @@ func appendLinesToFile(name string, lines string) error {
 
 func getOmPropertiesFromEnvVars() map[string]string {
 	props := map[string]string{}
-	for _, pair := range os.Environ() {
+	for _, pair := range os.Environ() { // nolint:forbidigo
 		if !strings.HasPrefix(pair, omPropertyPrefix) {
 			continue
 		}

docker/mongodb-kubernetes-tests/tests/search/fixtures/community-replicaset-sample-mflix.yaml

@@ -4,59 +4,66 @@ kind: MongoDBCommunity
 metadata:
   name: mdbc-rs
 spec:
-  members: 3
+  version: 8.0.10
   type: ReplicaSet
-  version: "8.0.10"
+  members: 3
   security:
     authentication:
-      modes: ["SCRAM-SHA-1"]
+      ignoreUnknownUsers: true
+      modes:
+        - SCRAM
   agent:
     logLevel: DEBUG
+  statefulSet:
+    spec:
+      template:
+        spec:
+          containers:
+            - name: mongod
+              resources:
+                limits:
+                  cpu: "2"
+                  memory: 2Gi
+                requests:
+                  cpu: "1"
+                  memory: 1Gi
+            - name: mongodb-agent
+              resources:
+                limits:
+                  cpu: "1"
+                  memory: 2Gi
+                requests:
+                  cpu: "0.5"
+                  memory: 1Gi
   users:
+    # admin user with root role
     - name: mdb-admin
       db: admin
-      passwordSecretRef: # a reference to the secret that will be used to generate the user's password
+      passwordSecretRef: # a reference to the secret containing user password
         name: mdb-admin-user-password
+      scramCredentialsSecretName: mdb-admin-user
       roles:
         - name: root
           db: admin
-      scramCredentialsSecretName: mdb-admin-user-scram
+    # user performing search queries
     - name: mdb-user
       db: admin
-      passwordSecretRef: # a reference to the secret that will be used to generate the user's password
+      passwordSecretRef: # a reference to the secret containing user password
         name: mdb-user-password
+      scramCredentialsSecretName: mdb-user-scram
       roles:
         - name: restore
           db: sample_mflix
         - name: readWrite
           db: sample_mflix
-      scramCredentialsSecretName: mdb-user-scram
-    - name: mongot-user
+    # user used by MongoDB Search to connect to MongoDB database to synchronize data from
+    # For MongoDB <8.2, the operator will be creating the searchCoordinator custom role automatically
+    # From MongoDB 8.2, searchCoordinator role will be a built-in role.
+    - name: search-sync-source
       db: admin
       passwordSecretRef: # a reference to the secret that will be used to generate the user's password
-        name: mdbc-rs-mongot-user-password
+        name: mdbc-rs-search-sync-source-password
+      scramCredentialsSecretName: mdbc-rs-search-sync-source
       roles:
         - name: searchCoordinator
           db: admin
-      scramCredentialsSecretName: mongot-user-scram
-  statefulSet:
-    spec:
-      template:
-        spec:
-          containers:
-            - name: mongod
-              resources:
-                limits:
-                  cpu: "3"
-                  memory: 5Gi
-                requests:
-                  cpu: "2"
-                  memory: 5Gi
-            - name: mongodb-agent
-              resources:
-                limits:
-                  cpu: "3"
-                  memory: 5Gi
-                requests:
-                  cpu: "2"
-                  memory: 5Gi

docker/mongodb-kubernetes-tests/tests/search/search_community_basic.py

@@ -15,8 +15,8 @@
 ADMIN_USER_NAME = "mdb-admin-user"
 ADMIN_USER_PASSWORD = "mdb-admin-user-pass"
 
-MONGOT_USER_NAME = "mongot-user"
-MONGOT_USER_PASSWORD = "mongot-user-password"
+MONGOT_USER_NAME = "search-sync-source"
+MONGOT_USER_PASSWORD = "search-sync-source-user-password"
 
 USER_NAME = "mdb-user"
 USER_PASSWORD = "mdb-user-pass"
@@ -32,8 +32,8 @@ def mdbc(namespace: str) -> MongoDBCommunity:
         namespace=namespace,
     )
 
-    # if try_load(resource):
-    #     return resource
+    if try_load(resource):
+        return resource
 
     return resource
 
@@ -45,8 +45,8 @@ def mdbs(namespace: str) -> MongoDBSearch:
         namespace=namespace,
     )
 
-    # if try_load(resource):
-    #     return resource
+    if try_load(resource):
+        return resource
 
     return resource
 
@@ -75,7 +75,7 @@ def test_create_database_resource(mdbc: MongoDBCommunity):
 
 
 @mark.e2e_search_community_basic
-def test_create_search_resource(mdbs: MongoDBSearch, mdbc: MongoDBCommunity):
+def test_create_search_resource(mdbs: MongoDBSearch):
     mdbs.update()
     mdbs.assert_reaches_phase(Phase.Running, timeout=300)
 
@@ -102,11 +102,6 @@ def test_search_create_search_index(sample_movies_helper: SampleMoviesSearchHelp
     sample_movies_helper.create_search_index()
 
 
-# @mark.e2e_search_community_basic
-# def test_search_wait_for_search_indexes(sample_movies_helper: SampleMoviesSearchHelper):
-#     sample_movies_helper.wait_for_search_indexes()
-
-
 @mark.e2e_search_community_basic
 def test_search_assert_search_query(sample_movies_helper: SampleMoviesSearchHelper):
     sample_movies_helper.assert_search_query(retry_timeout=60)

docker/mongodb-kubernetes-tests/tests/search/search_community_tls.py

@@ -17,8 +17,8 @@
 ADMIN_USER_NAME = "mdb-admin-user"
 ADMIN_USER_PASSWORD = "mdb-admin-user-pass"
 
-MONGOT_USER_NAME = "mongot-user"
-MONGOT_USER_PASSWORD = "mongot-user-password"
+MONGOT_USER_NAME = "search-sync-source"
+MONGOT_USER_PASSWORD = "search-sync-source-user-password"
 
 USER_NAME = "mdb-user"
 USER_PASSWORD = "mdb-user-pass"