wip

Author: lsierant

.evergreen-snippets.yml

@@ -66,12 +66,6 @@ tasks:
       - func: test_code_snippets
       - func: sample_commit_output
 
-  - name: test_kind_search_enterprise_snippets.sh
-    tags: [ "code_snippets", "patch-run" ]
-    commands:
-      - func: test_code_snippets
-      - func: sample_commit_output
-
 task_groups:
   - name: gke_code_snippets_task_group
     <<: *setup_and_teardown_group_gke_code_snippets
@@ -85,7 +79,6 @@ task_groups:
     max_hosts: -1
     tasks:
       - test_kind_search_community_snippets.sh
-      - test_kind_search_enterprise_snippets.sh
 
 buildvariants:
   # These variants are used to test the code snippets and each one can be used in patches
@@ -117,7 +110,7 @@ buildvariants:
     allowed_requesters: [ "patch" ]
     run_on:
       - ubuntu2204-small
-#    <<: *base_om8_dependency
+    <<: *base_om8_dependency
     tasks:
       - name: gke_code_snippets_task_group
 

docs/search/01-search-community-deploy/README.md renamed to docs/community-search/quick-start/README.md

@@ -27,14 +27,14 @@ Download or copy the content of `env_variables.sh`:
 [env_variables.sh](env_variables.sh)
 ```shell copy
 # set it to the context name of the k8s cluster
-export K8S_CTX="<local cluster context>"
+export K8S_CLUSTER_0_CONTEXT_NAME="<local cluster context>"
 
 # At the private preview stage the community search image is accessible only from a private repository.
 # Please contact MongoDB Support to get access.
 export PRIVATE_PREVIEW_IMAGE_PULLSECRET="<.dockerconfigjson>"
 
 # the following namespace will be created if not exists
-export MDB_NS="mongodb"
+export MDB_NAMESPACE="mongodb"
 
 export MDB_ADMIN_USER_PASSWORD="admin-user-password-CHANGE-ME"
 export MDB_SEARCH_USER_PASSWORD="search-user-password-CHANGE-ME"
@@ -62,9 +62,9 @@ Next, install the MongoDB Kubernetes Operator from the Helm repository you just
 
 [code_snippets/0100_install_operator.sh](code_snippets/0100_install_operator.sh)
 ```shell copy
-helm upgrade --install --debug --kube-context "${K8S_CTX}" \
+helm upgrade --install --debug --kube-context "${K8S_CLUSTER_0_CONTEXT_NAME}" \
   --create-namespace \
-  --namespace="${MDB_NS}" \
+  --namespace="${MDB_NAMESPACE}" \
   mongodb-kubernetes \
   --set "${OPERATOR_ADDITIONAL_HELM_VALUES:-"dummy=value"}" \
   "${OPERATOR_HELM_CHART}"
@@ -133,28 +133,13 @@ MongoDB requires authentication for secure access. This step creates two Kuberne
 
 [code_snippets/0305_create_mongodb_community_user_secrets.sh](code_snippets/0305_create_mongodb_community_user_secrets.sh)
 ```shell copy
-<<<<<<<< HEAD:docs/community-search/quick-start/README.md
 kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" --namespace "${MDB_NAMESPACE}" \
   create secret generic admin-user-password \
   --from-literal=password="${MDB_ADMIN_USER_PASSWORD}"
 
 kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" --namespace "${MDB_NAMESPACE}" \
   create secret generic search-user-password \
   --from-literal=password="${MDB_SEARCH_USER_PASSWORD}"
-========
-kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
-  create secret generic mdb-admin-user-password \
-  --from-literal=password="${MDB_ADMIN_USER_PASSWORD}"
-
-kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
-  create secret generic mdbc-rs-search-sync-source-password \
-  --from-literal=password="${MDB_SEARCH_SYNC_USER_PASSWORD}"
-
-kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
-  create secret generic mdb-user-password \
-  --from-literal=password="${MDB_USER_PASSWORD}"
-
->>>>>>>> 6309cff6f (Refactor of existing snippets on master):docs/search/01-search-community-deploy/README.md
 ```
 Ensure these secrets are created in the same namespace where you plan to deploy MongoDB.
 
@@ -164,7 +149,7 @@ Now, deploy MongoDB Community by creating a `MongoDBCommunity` custom resource n
 
 [code_snippets/0310_create_mongodb_community_resource.sh](code_snippets/0310_create_mongodb_community_resource.sh)
 ```yaml copy
-kubectl apply --context "${K8S_CTX}" -n "${MDB_NS}" -f - <<EOF
+kubectl apply --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" -f - <<EOF
 apiVersion: mongodbcommunity.mongodb.com/v1
 kind: MongoDBCommunity
 metadata:
@@ -202,7 +187,6 @@ spec:
                   cpu: "1"
                   memory: 5Gi
   users:
-<<<<<<<< HEAD:docs/community-search/quick-start/README.md
     - name: admin-user
       passwordSecretRef:
         name: admin-user-password
@@ -219,45 +203,6 @@ spec:
         - db: sample_mflix
           name: dbOwner
       scramCredentialsSecretName: search-user
-========
-    # admin user with root role
-    - name: mdb-admin
-      db: admin
-      # a reference to the secret containing user password
-      passwordSecretRef:
-        name: mdb-admin-user-password
-      scramCredentialsSecretName: mdb-admin-user
-      roles:
-        - name: root
-          db: admin
-    # user performing search queries
-    - name: mdb-user
-      db: admin
-      # a reference to the secret containing user password
-      passwordSecretRef:
-        name: mdb-user-password
-      scramCredentialsSecretName: mdb-user-scram
-      roles:
-        - name: restore
-          db: sample_mflix
-        - name: readWrite
-          db: sample_mflix
-    # 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
-      # a reference to the secret that will be used to generate the user's password
-      passwordSecretRef:
-        name: mdbc-rs-search-sync-source-password
-      scramCredentialsSecretName: mdbc-rs-search-sync-source
-      roles:
-        - name: searchCoordinator
-          db: admin
->>>>>>>> 6309cff6f (Refactor of existing snippets on master):docs/search/01-search-community-deploy/README.md
 EOF
 ```
 
@@ -268,12 +213,11 @@ After applying the `MongoDBCommunity` custom resource, the operator begins deplo
 [code_snippets/0315_wait_for_community_resource.sh](code_snippets/0315_wait_for_community_resource.sh)
 ```shell copy
 echo "Waiting for MongoDBCommunity resource to reach Running phase..."
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
-  --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
+kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
 echo; echo "MongoDBCommunity resource"
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get mdbc/mdbc-rs
-echo; echo "Pods running in cluster ${K8S_CTX}"
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get pods
+kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" get mdbc/mdbc-rs
+echo; echo "Pods running in cluster ${K8S_CLUSTER_0_CONTEXT_NAME}"
+kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" get pods
 ```
 
 ### 9. Create MongoDB Search Resource
@@ -286,7 +230,7 @@ Note: Private preview of MongoDB Community Search comes with some limitations, a
 
 [code_snippets/0320_create_mongodb_search_resource.sh](code_snippets/0320_create_mongodb_search_resource.sh)
 ```shell copy
-kubectl apply --context "${K8S_CTX}" -n "${MDB_NS}" -f - <<EOF
+kubectl apply --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" -f - <<EOF
 apiVersion: mongodb.com/v1
 kind: MongoDBSearch
 metadata:
@@ -321,8 +265,7 @@ Similar to the MongoDB deployment, the Search deployment needs time to initializ
 [code_snippets/0325_wait_for_search_resource.sh](code_snippets/0325_wait_for_search_resource.sh)
 ```shell copy
 echo "Waiting for MongoDBSearch resource to reach Running phase..."
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
-  --for=jsonpath='{.status.phase}'=Running mdbs/mdbc-rs --timeout=300s
+kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbs/mdbc-rs --timeout=300s
 ```
 This command polls the status of the `MongoDBSearch` resource `mdbc-rs`.
 
@@ -333,8 +276,7 @@ Double-check the status of your `MongoDBCommunity` resource to ensure it remains
 [code_snippets/0330_wait_for_community_resource.sh](code_snippets/0330_wait_for_community_resource.sh)
 ```shell copy
 echo "Waiting for MongoDBCommunity resource to reach Running phase..."
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
-  --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
+kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
 ```
 This provides a final confirmation that the core database is operational.
 
@@ -345,11 +287,11 @@ View all the running pods in your namespace. You should see pods for the MongoDB
 [code_snippets/0335_show_running_pods.sh](code_snippets/0335_show_running_pods.sh)
 ```shell copy
 echo; echo "MongoDBCommunity resource"
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get mdbc/mdbc-rs
+kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" get mdbc/mdbc-rs
 echo; echo "MongoDBSearch resource"
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get mdbs/mdbc-rs
-echo; echo "Pods running in cluster ${K8S_CTX}"
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get pods
+kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" get mdbs/mdbc-rs
+echo; echo "Pods running in cluster ${K8S_CLUSTER_0_CONTEXT_NAME}"
+kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" get pods
 ```
 
 ## Using MongoDB Search
@@ -362,7 +304,9 @@ To interact with your MongoDB deployment, this step deploys a utility pod named
 
 [code_snippets/0410_run_mongodb_tools_pod.sh](code_snippets/0410_run_mongodb_tools_pod.sh)
 ```shell copy
-kubectl apply -n "${MDB_NS}" --context "${K8S_CTX}" -f - <<EOF
+#!/bin/bash
+
+kubectl apply -n "${MDB_NAMESPACE}" --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -f - <<EOF
 apiVersion: v1
 kind: Pod
 metadata:
@@ -379,8 +323,7 @@ spec:
 EOF
 
 echo "Waiting for the mongodb-tools to be ready..."
-kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
-  --for=condition=Ready pod/mongodb-tools-pod --timeout=60s
+kubectl wait --for=condition=Ready pod/mongodb-tools-pod -n "${MDB_NAMESPACE}" --context "${K8S_CLUSTER_0_CONTEXT_NAME}" --timeout=60s
 ```
 
 ### 14. Import Sample Data
@@ -389,22 +332,13 @@ To test the search functionality, this step imports the `sample_mflix.movies` co
 
 [code_snippets/0420_import_movies_mflix_database.sh](code_snippets/0420_import_movies_mflix_database.sh)
 ```shell copy
-kubectl exec -n "${MDB_NS}" --context "${K8S_CTX}" \
-  mongodb-tools-pod -- /bin/bash -eu -c "$(cat <<EOF
+#!/bin/bash
+
+kubectl exec -n "${MDB_NAMESPACE}" --context "${K8S_CLUSTER_0_CONTEXT_NAME}" mongodb-tools-pod -- /bin/bash -eu -c "$(cat <<EOF
 echo "Downloading sample database archive..."
-curl https://atlas-education.s3.amazonaws.com/sample_mflix.archive \
-  -o /tmp/sample_mflix.archive
+curl https://atlas-education.s3.amazonaws.com/sample_mflix.archive -o /tmp/sample_mflix.archive
 echo "Restoring sample database"
-<<<<<<<< HEAD:docs/community-search/quick-start/README.md
 mongorestore --archive=/tmp/sample_mflix.archive --verbose=1 --drop --nsInclude 'sample_mflix.*' --uri="mongodb://search-user:${MDB_SEARCH_USER_PASSWORD}@mdbc-rs-0.mdbc-rs-svc.${MDB_NAMESPACE}.svc.cluster.local:27017/?replicaSet=mdbc-rs"
-========
-mongorestore \
-  --archive=/tmp/sample_mflix.archive \
-  --verbose=1 \
-  --drop \
-  --nsInclude 'sample_mflix.*' \
-  --uri="mongodb://mdb-user:${MDB_USER_PASSWORD}@mdbc-rs-0.mdbc-rs-svc.${MDB_NS}.svc.cluster.local:27017/?replicaSet=mdbc-rs"
->>>>>>>> 6309cff6f (Refactor of existing snippets on master):docs/search/01-search-community-deploy/README.md
 EOF
 )"
 ```
@@ -416,16 +350,10 @@ Before performing search queries, create a search index. This step uses `kubectl
 
 [code_snippets/0430_create_search_index.sh](code_snippets/0430_create_search_index.sh)
 ```shell copy
-<<<<<<<< HEAD:docs/community-search/quick-start/README.md
 #!/bin/bash
 
 kubectl exec --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" mongodb-tools-pod -- \
   mongosh --quiet "mongodb://search-user:${MDB_SEARCH_USER_PASSWORD}@mdbc-rs-0.mdbc-rs-svc.${MDB_NAMESPACE}.svc.cluster.local:27017/?replicaSet=mdbc-rs" \
-========
-kubectl exec --context "${K8S_CTX}" -n "${MDB_NS}" mongodb-tools-pod -- \
-  mongosh --quiet \
-    "mongodb://mdb-user:${MDB_USER_PASSWORD}@mdbc-rs-0.mdbc-rs-svc.${MDB_NS}.svc.cluster.local:27017/?replicaSet=mdbc-rs" \
->>>>>>>> 6309cff6f (Refactor of existing snippets on master):docs/search/01-search-community-deploy/README.md
     --eval "use sample_mflix" \
     --eval 'db.movies.createSearchIndex("default", { mappings: { dynamic: true } });'
 ```
@@ -436,7 +364,6 @@ Creating a search index is an asynchronous operation. This script polls periodic
 
 [code_snippets/0440_wait_for_search_index_ready.sh](code_snippets/0440_wait_for_search_index_ready.sh)
 ```shell copy
-<<<<<<<< HEAD:docs/community-search/quick-start/README.md
 #!/bin/bash
 
 for _ in $(seq 0 10); do
@@ -457,11 +384,6 @@ if [[ "${search_index_status}" != "READY" ]]; then
   echo "Error waiting for the search index to be ready"
   return 1
 fi
-========
-# Currently it's not possible to check the status of search indexes, we need to just wait
-echo "Sleeping to wait for search indexes to be created"
-sleep 60
->>>>>>>> 6309cff6f (Refactor of existing snippets on master):docs/search/01-search-community-deploy/README.md
 ```
 
 ### 17. Execute a Search Query
@@ -470,6 +392,8 @@ Once the search index is ready, execute search queries using the `$search` aggre
 
 [code_snippets/0450_execute_search_query.sh](code_snippets/0450_execute_search_query.sh)
 ```shell copy
+#!/bin/bash
+
 mdb_script=$(cat <<'EOF'
 use sample_mflix;
 db.movies.aggregate([
@@ -510,14 +434,9 @@ db.movies.aggregate([
 EOF
 )
 
-kubectl exec --context "${K8S_CTX}" -n "${MDB_NS}" \
-  mongodb-tools-pod -- /bin/bash -eu -c "$(cat <<EOF
+kubectl exec --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" mongodb-tools-pod -- /bin/bash -eu -c "$(cat <<EOF
 echo '${mdb_script}' > /tmp/mdb_script.js
-<<<<<<<< HEAD:docs/community-search/quick-start/README.md
 mongosh --quiet "mongodb://search-user:${MDB_SEARCH_USER_PASSWORD}@mdbc-rs-0.mdbc-rs-svc.${MDB_NAMESPACE}.svc.cluster.local:27017/?replicaSet=mdbc-rs" < /tmp/mdb_script.js
-========
-mongosh --quiet "mongodb://mdb-user:${MDB_USER_PASSWORD}@mdbc-rs-0.mdbc-rs-svc.${MDB_NS}.svc.cluster.local:27017/?replicaSet=mdbc-rs" < /tmp/mdb_script.js
->>>>>>>> 6309cff6f (Refactor of existing snippets on master):docs/search/01-search-community-deploy/README.md
 EOF
 )"
 ```