Refactored search snippets and incorporated changes from docs

Author: lsierant

docs/search/community/quick-start/README.md

@@ -25,10 +25,10 @@ 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_CLUSTER_0_CONTEXT_NAME="<local cluster context>"
+export K8S_CTX="<local cluster context>"
 
 # the following namespace will be created if not exists
-export MDB_NAMESPACE="mongodb"
+export MDB_NS="mongodb"
 
 # minimum required MongoDB version for running MongoDB Search is 8.0.10
 export MDB_VERSION="8.0.10"
@@ -63,9 +63,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_CLUSTER_0_CONTEXT_NAME}" \
+helm upgrade --install --debug --kube-context "${K8S_CTX}" \
   --create-namespace \
-  --namespace="${MDB_NAMESPACE}" \
+  --namespace="${MDB_NS}" \
   mongodb-kubernetes \
   --set "${OPERATOR_ADDITIONAL_HELM_VALUES:-"dummy=value"}" \
   "${OPERATOR_HELM_CHART}"
@@ -82,15 +82,15 @@ 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
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" --namespace "${MDB_NAMESPACE}" \
+kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
   create secret generic mdb-admin-user-password \
   --from-literal=password="${MDB_ADMIN_USER_PASSWORD}"
 
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" --namespace "${MDB_NAMESPACE}" \
+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_CLUSTER_0_CONTEXT_NAME}" --namespace "${MDB_NAMESPACE}" \
+kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
   create secret generic mdb-user-password \
   --from-literal=password="${MDB_USER_PASSWORD}"
 
@@ -106,7 +106,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_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" -f - <<EOF
+kubectl apply --context "${K8S_CTX}" -n "${MDB_NS}" -f - <<EOF
 apiVersion: mongodbcommunity.mongodb.com/v1
 kind: MongoDBCommunity
 metadata:
@@ -147,7 +147,8 @@ spec:
     # admin user with root role
     - name: mdb-admin
       db: admin
-      passwordSecretRef: # a reference to the secret containing user password
+      # a reference to the secret containing user password
+      passwordSecretRef:
         name: mdb-admin-user-password
       scramCredentialsSecretName: mdb-admin-user
       roles:
@@ -156,20 +157,25 @@ spec:
     # user performing search queries
     - name: mdb-user
       db: admin
-      passwordSecretRef: # a reference to the secret containing user password
+      # 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.
+    # 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
+      # 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:
@@ -185,11 +191,12 @@ 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_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
+  --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
 echo; echo "MongoDBCommunity resource"
-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
+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
 ```
 
 ### 7. Create MongoDB Search Resource
@@ -201,7 +208,7 @@ Note: Public Preview of MongoDB Community Search comes with some limitations, an
 
 [code_snippets/0320_create_mongodb_search_resource.sh](code_snippets/0320_create_mongodb_search_resource.sh)
 ```shell copy
-kubectl apply --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" -f - <<EOF
+kubectl apply --context "${K8S_CTX}" -n "${MDB_NS}" -f - <<EOF
 apiVersion: mongodb.com/v1
 kind: MongoDBSearch
 metadata:
@@ -236,7 +243,8 @@ 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_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbs/mdbc-rs --timeout=300s
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
+  --for=jsonpath='{.status.phase}'=Running mdbs/mdbc-rs --timeout=300s
 ```
 This command polls the status of the `MongoDBSearch` resource `mdbc-rs`.
 
@@ -247,7 +255,8 @@ 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_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
+  --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
 ```
 This provides a final confirmation that the core database is operational.
 
@@ -258,11 +267,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_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" get mdbc/mdbc-rs
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" get mdbc/mdbc-rs
 echo; echo "MongoDBSearch resource"
-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
+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
 ```
 
 ## Using MongoDB Search
@@ -275,9 +284,7 @@ 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
-#!/bin/bash
-
-kubectl apply -n "${MDB_NAMESPACE}" --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -f - <<EOF
+kubectl apply -n "${MDB_NS}" --context "${K8S_CTX}" -f - <<EOF
 apiVersion: v1
 kind: Pod
 metadata:
@@ -294,7 +301,8 @@ spec:
 EOF
 
 echo "Waiting for the mongodb-tools to be ready..."
-kubectl wait --for=condition=Ready pod/mongodb-tools-pod -n "${MDB_NAMESPACE}" --context "${K8S_CLUSTER_0_CONTEXT_NAME}" --timeout=60s
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
+  --for=condition=Ready pod/mongodb-tools-pod --timeout=60s
 ```
 
 ### 12. Import Sample Data
@@ -303,14 +311,18 @@ 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
-#!/bin/bash
-
-kubectl exec -n "${MDB_NAMESPACE}" --context "${K8S_CLUSTER_0_CONTEXT_NAME}" mongodb-tools-pod -- /bin/bash -eu -c "$(cat <<EOF
+kubectl exec -n "${MDB_NS}" --context "${K8S_CTX}" \
+  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"
-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_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"
 EOF
 )"
 ```
@@ -322,10 +334,9 @@ 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
-#!/bin/bash
-
-kubectl exec --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" mongodb-tools-pod -- \
-  mongosh --quiet "mongodb://mdb-user:${MDB_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" \
     --eval "use sample_mflix" \
     --eval 'db.movies.createSearchIndex("default", { mappings: { dynamic: true } });'
 ```
@@ -336,8 +347,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
-#!/bin/bash
-
 # 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
@@ -349,8 +358,6 @@ 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([
@@ -391,9 +398,10 @@ db.movies.aggregate([
 EOF
 )
 
-kubectl exec --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" mongodb-tools-pod -- /bin/bash -eu -c "$(cat <<EOF
+kubectl exec --context "${K8S_CTX}" -n "${MDB_NS}" \
+  mongodb-tools-pod -- /bin/bash -eu -c "$(cat <<EOF
 echo '${mdb_script}' > /tmp/mdb_script.js
-mongosh --quiet "mongodb://mdb-user:${MDB_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
 EOF
 )"
-```
+```

docs/search/community/quick-start/code_snippets/0045_create_namespaces.sh

@@ -1 +1 @@
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" create namespace "${MDB_NAMESPACE}"
+kubectl --context "${K8S_CTX}" create namespace "${MDB_NS}"

docs/search/community/quick-start/code_snippets/0046_create_image_pull_secrets.sh

@@ -1,3 +1,3 @@
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" \
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" \
     create secret generic "image-registries-secret" \
       --from-file=.dockerconfigjson="${HOME}/.docker/config.json" --type=kubernetes.io/dockerconfigjson

docs/search/community/quick-start/code_snippets/0100_install_operator.sh

@@ -1,6 +1,6 @@
-helm upgrade --install --debug --kube-context "${K8S_CLUSTER_0_CONTEXT_NAME}" \
+helm upgrade --install --debug --kube-context "${K8S_CTX}" \
   --create-namespace \
-  --namespace="${MDB_NAMESPACE}" \
+  --namespace="${MDB_NS}" \
   mongodb-kubernetes \
   --set "${OPERATOR_ADDITIONAL_HELM_VALUES:-"dummy=value"}" \
   "${OPERATOR_HELM_CHART}"

docs/search/community/quick-start/code_snippets/0305_create_mongodb_community_user_secrets.sh

@@ -1,12 +1,12 @@
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" --namespace "${MDB_NAMESPACE}" \
+kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
   create secret generic mdb-admin-user-password \
   --from-literal=password="${MDB_ADMIN_USER_PASSWORD}"
 
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" --namespace "${MDB_NAMESPACE}" \
+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_CLUSTER_0_CONTEXT_NAME}" --namespace "${MDB_NAMESPACE}" \
+kubectl --context "${K8S_CTX}" --namespace "${MDB_NS}" \
   create secret generic mdb-user-password \
   --from-literal=password="${MDB_USER_PASSWORD}"
 

docs/search/community/quick-start/code_snippets/0310_create_mongodb_community_resource.sh

@@ -1,4 +1,4 @@
-kubectl apply --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" -f - <<EOF
+kubectl apply --context "${K8S_CTX}" -n "${MDB_NS}" -f - <<EOF
 apiVersion: mongodbcommunity.mongodb.com/v1
 kind: MongoDBCommunity
 metadata:
@@ -39,7 +39,8 @@ spec:
     # admin user with root role
     - name: mdb-admin
       db: admin
-      passwordSecretRef: # a reference to the secret containing user password
+      # a reference to the secret containing user password
+      passwordSecretRef:
         name: mdb-admin-user-password
       scramCredentialsSecretName: mdb-admin-user
       roles:
@@ -48,20 +49,25 @@ spec:
     # user performing search queries
     - name: mdb-user
       db: admin
-      passwordSecretRef: # a reference to the secret containing user password
+      # 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.
+    # 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
+      # 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:

docs/search/community/quick-start/code_snippets/0315_wait_for_community_resource.sh

@@ -1,6 +1,7 @@
 echo "Waiting for MongoDBCommunity resource to reach Running phase..."
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
+  --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
 echo; echo "MongoDBCommunity resource"
-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
+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

docs/search/community/quick-start/code_snippets/0320_create_mongodb_search_resource.sh

@@ -1,4 +1,4 @@
-kubectl apply --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" -f - <<EOF
+kubectl apply --context "${K8S_CTX}" -n "${MDB_NS}" -f - <<EOF
 apiVersion: mongodb.com/v1
 kind: MongoDBSearch
 metadata:

docs/search/community/quick-start/code_snippets/0325_wait_for_search_resource.sh

@@ -1,2 +1,3 @@
 echo "Waiting for MongoDBSearch resource to reach Running phase..."
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbs/mdbc-rs --timeout=300s
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
+  --for=jsonpath='{.status.phase}'=Running mdbs/mdbc-rs --timeout=300s

docs/search/community/quick-start/code_snippets/0330_wait_for_community_resource.sh

@@ -1,2 +1,3 @@
 echo "Waiting for MongoDBCommunity resource to reach Running phase..."
-kubectl --context "${K8S_CLUSTER_0_CONTEXT_NAME}" -n "${MDB_NAMESPACE}" wait --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s
+kubectl --context "${K8S_CTX}" -n "${MDB_NS}" wait \
+  --for=jsonpath='{.status.phase}'=Running mdbc/mdbc-rs --timeout=400s