DOCSP-45418 -- Update MCSC Overview page for GA (#1988)

* DOCSP-45418 -- Update MCSC Overview page for GA

* DOCSP-45418 -- remove public preview banner

* DOCSP-45418 -- copy edit

* DOCSP-45418 -- review revisions

* DOCSP-45418 -- add example yaml content

* DOCSP-45418 -- fix list items

* DOCSP-45418 -- fix list items

* DOCSP-45418 -- fix list items

* DOCSP-45418 -- fix list items

* DOCSP-45418 -- fix list items

* DOCSP-45418 -- remove banner

* DOCSP-45418 -- External review revsions

* DOCSP-45418 -- External review revsions

* DOCSP-45418 -- External review revsions

* DOCSP-45418 -- External review revsions

* DOCSP-45418 -- external review revisions

* DOCSP-45418 -- begin shard overrides

* DOCSP-45418 -- wip

* DOCSP-45418 -- wip

* DOCSP-45418 -- wip

* DOCSP-45418 -- wip

* DOCSP-45418 -- wip

* Add Multi Cluster Sharded Cluster examples files - shard overrides

* DOCSP-45418 -- WIP

* DOCSP-45418 -- add code snippits

* DOCSP-45418 -- add code snippits

* DOCSP-45418 -- add code snippits

* DOCSP-45418 -- add code snippits

* DOCSP-45418 -- add code snippits

* DOCSP-45418 -- disaster recovery

* DOCSP-45418 -- remove merge policy column from table

* DOCSP-45418 -- add links

* Wrapped yaml examples for MC Sharded

* DOCSP-45418 -- disaster recovery pages added

* DOCSP-45418 -- DR WIP

* DOCSP-45418 -- DR WIP

* DOCSP-45418 -- DR Operator Cluster Works

* DOCSP-45418 -- replica sets lose majority

* DOCSP-45418 -- Add DR no k8s op cluster

* DOCSP-45418 -- DR WIP

* DOCSP-45418 -- add merge policy definition

* DOCSP-45418 -- technical review -- shard overrides and DR

* DOCSP-45418 -- external review

* DOCSP-45418 -- external review

* DOCSP-45418 -- non-service mesh

* DOCSP-45418 -- shard overrides; non-service mesh

* DOCSP-45418 -- external review

* DOCSP-45418 -- WIP

* DOCSP-45418 -- external review

* DOCSP-45418 -- external review

---------

Co-authored-by: Julien-Ben <[email protected]>
Co-authored-by: Łukasz Sierant <[email protected]>

Author: 3 people

snooty.toml

@@ -16,6 +16,7 @@ toc_landing_pages = [
     "/multi-cluster",
     "/multi-cluster-connect",
     "/om-resources",
+    "/multi-cluster-sharded-cluster-disaster-recovery",
     "/reference",
     "/reference/operator-settings",
     "/reference-architectures/multi-cluster",
@@ -218,6 +219,7 @@ service-pricing = "Atlas pricing page"
 service = "Atlas"
 mdb-support = "`MongoDB Support <https://support.mongodb.com/welcome>`__"
 svc-api-key = "Programmatic API Key"
+sharded-cluster = "Sharded Cluster"
 sms = ":abbr:`SMS (short message service)`"
 sni = ":abbr:`SNI (Server Name Indication)`"
 smtp = ":abbr:`SMTP (Simple Mail Transport Protocol)`"

source/includes/code-examples/yaml-files/example-sharded-cluster-deployment.yaml

@@ -7,7 +7,8 @@ spec:
   type: ShardedCluster
   # this deployment will have 3 shards
   shardCount: 3
-  # you cannot specify mongodsPerShardCount, configServerCount and mongosCount in MultiCluster topology
+  # you cannot specify mongodsPerShardCount, configServerCount and mongosCount
+  # in MultiCluster topology
   version: 8.0.3
   opsManager:
     configMapRef:
@@ -18,7 +19,10 @@ spec:
   shardPodSpec: # applies to all shards on all clusters
     persistence:
       single:
-        storage: 10G # all pods for all shards on all clusters will use that storage size in their PersistentVolumeClaim unless overridden in spec.shard.clusterSpecList or spec.shardOverrides.
+        # all pods for all shards on all clusters will use that storage size in their
+        # PersistentVolumeClaim unless overridden in spec.shard.clusterSpecList or
+        # spec.shardOverrides.
+        storage: 10G
 
   configSrvPodSpec: # applies to all config server nodes in all clusters
     persistence:
@@ -30,43 +34,62 @@ spec:
         logs:
           storage: 1G
 
-  shard: # consider this section as a default configuration for ALL shards
+  # consider this section as a default configuration for ALL shards
+  shard:
     clusterSpecList:
       - clusterName: kind-e2e-cluster-1
-        members: 1 # each shard will have only one mongod process deployed in this cluster
+        # each shard will have only one mongod process deployed in this cluster
+        members: 1
         memberConfig:
           - votes: 1
             priority: "20" # we increase the priority to have primary in this cluster
       - clusterName: kind-e2e-cluster-2
-        members: 1 # one member in this cluster, no votes and priority defined means it'll get the default values votes=1, priority="1"
+        # one member in this cluster, no votes and priority defined means it'll get
+        # the default values votes=1, priority="1"
+        members: 1
       - clusterName: kind-e2e-cluster-3
         members: 1 # one member in this cluster
 
   shardOverrides: # here you specify customizations for specific shards
-    - shardNames: # here you specify to which shard names the following configuration will apply
+    # here you specify to which shard names the following configuration will
+    # apply
+    - shardNames:
         - sc-0
       clusterSpecList:
         - clusterName: kind-e2e-cluster-1
           # all fields here are optional
-          members: 2 # shard "sc-0" will have two members instead of one, which was defined as the default for all shards in spec.shard.clusterSpecList[0].members
+          # shard "sc-0" will have two members instead of one, which was defined as the
+          # default for all shards in spec.shard.clusterSpecList[0].members
+          members: 2
           memberConfig:
             - votes: 1
-              priority: "1" # shard "sc-0" should not have primary in this cluster like every other shard
+              # shard "sc-0" should not have primary in this cluster like every other shard
+              priority: "1"
             - votes: 1
               priority: "1"
         - clusterName: kind-e2e-cluster-2
           members: 2 # shard "sc-0" will have two members instead of one
           memberConfig:
             - votes: 1
-              priority: "20" # both processes of shard "sc-0" in this cluster will have the same likelihood to become a primary member
+              # both processes of shard "sc-0" in this cluster will have the same
+              # likelihood to become a primary member
+              priority: "20"
             - votes: 1
               priority: "20"
-        - clusterName: kind-e2e-cluster-3 # We need to specify the list of all clusters on which this shard will be deployed.
-          # If the clusterName element is omitted here, it will be considered as an override for this shard, so that the operator shouldn't deploy any member to it.
-          # No fields are mandatory in here, though. In case a field is not set, it's not overridden and the default value is taken from a top level spec.shard settings.
+        # We need to specify the list of all clusters on which this shard will be
+        # deployed.
+        - clusterName: kind-e2e-cluster-3
+          # If the clusterName element is omitted here, it will be considered as an
+          # override for this shard, so that the operator shouldn't deploy any member
+          # to it.
+          # No fields are mandatory in here, though. In case a field is not set, it's
+          # not overridden and the default value is taken from a top level spec.shard
+          # settings.
 
   configSrv:
-    clusterSpecList: # the same configuration fields are available as in spec.shard.clusterSpecList.
+    # the same configuration fields are available as in
+    # spec.shard.clusterSpecList.
+    clusterSpecList:
       - clusterName: kind-e2e-cluster-1
         members: 1
       - clusterName: kind-e2e-cluster-2
@@ -75,11 +98,13 @@ spec:
         members: 1
 
   mongos:
-    clusterSpecList: # the same configuration fields are available as in spec.shard.clusterSpecList apart from storage and replica-set related fields.
+    # the same configuration fields are available as in
+    # spec.shard.clusterSpecList apart from storage and replica-set related
+    # fields.
+    clusterSpecList:
       - clusterName: kind-e2e-cluster-1
         members: 1
       - clusterName: kind-e2e-cluster-2
         members: 1
       - clusterName: kind-e2e-cluster-3
         members: 1
-

source/includes/code-examples/yaml-files/pod_template_config_servers.yaml

@@ -18,6 +18,7 @@ spec:
   credentials: my-credentials
   persistent: true
 
+  # doc-region-start: configSrv
   configSrvPodSpec: # applicable to all members in all clusters
     persistence:
       single:
@@ -63,7 +64,7 @@ spec:
                 storage: "6G"
       - clusterName: kind-e2e-cluster-2
         members: 1
-
+  # doc-highlight-end: configSrv
   mongos:
     clusterSpecList:
       - clusterName: kind-e2e-cluster-1

source/includes/code-examples/yaml-files/pod_template_shards_0.yaml

@@ -1,5 +1,5 @@
-# This file is a minimal example of how to define global custom pod templates and persistence settings
-# and how to override them in clusterSpecList
+# This file is a minimal example of how to define global custom pod templates
+# and persistence settings and how to override them in clusterSpecList
 apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
@@ -26,7 +26,7 @@ spec:
       - clusterName: kind-e2e-cluster-1
         members: 2
       - clusterName: kind-e2e-cluster-2
-        members: 1
+        members: 1 # cluster count
 
   shardPodSpec: # applicable to all shards in all clusters
     persistence:
@@ -48,8 +48,10 @@ spec:
       - clusterName: kind-e2e-cluster-1
         members: 2
         # The below statefulset override is applicable only to pods in kind-e2e-cluster-1
-        # Specs will be merged, the "request" field defined above will still be applied to containers in this cluster
-        # However, limits will be replaced with below values, because clusterSpecList.statefulSet.spec.template has a
+        # Specs will be merged, the "request" field defined above will still be
+        # applied to containers in this cluster.
+        # However, limits will be replaced with below values, because
+        # clusterSpecList.statefulSet.spec.template has a
         # higher priority than shardPodSpec.podTemplate
         statefulSet:
           spec:
@@ -61,8 +63,11 @@ spec:
                       limits:
                         cpu: 1.0
                         memory: 2.5G
-        # In clusterSpecList.podSpec, only persistence field must be used, the podTemplate field is ignored.
-        podSpec: # In kind-e2e-cluster-1, we replace the persistence settings defined in shardPodSpec
+        # In clusterSpecList.podSpec, only persistence field must be used, the
+        # podTemplate field is ignored.
+        # In kind-e2e-cluster-1, we replace the persistence settings defined in
+        # shardPodSpec
+        podSpec:
           persistence:
             multiple:
               journal:

source/includes/code-examples/yaml-files/pod_template_shards_1.yaml

@@ -1,5 +1,5 @@
-# This file is a minimal example of how to define custom pod templates and persistence settings
-# at the cluster level, and in shard overrides.
+# This file is a minimal example of how to define custom pod templates and
+# persistence settings at the cluster level, and in shard overrides.
 apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
@@ -43,8 +43,10 @@ spec:
                       limits:
                         cpu: 1.0
                         memory: 2.0G
-        # In clusterSpecList.podSpec, only persistence field must be used, the podTemplate field is ignored.
-        podSpec: # In kind-e2e-cluster-1, we define custom persistence settings
+        # In clusterSpecList.podSpec, only persistence field must be used, the
+        # podTemplate field is ignored.
+        # In kind-e2e-cluster-1, we define custom persistence settings
+        podSpec:
           persistence:
             multiple:
               journal:
@@ -57,13 +59,15 @@ spec:
         members: 1
 
   shardOverrides:
-    - shardNames: [ "pod-template-shards-1-2" ] # this override will apply to shard of index 2
-      # Statefulset settings defined at this level (shardOverrides.statefulSet) apply to members
-      # of shard 2 in ALL clusters
-      # This field has higher priority than shard.clusterSpecList.statefulSet, but lower than
-      # shardOverrides.clusterSpecList.statefulSet
-      # It has a merge policy, which means that the limits defined above for the mongodb-enterprise-database container
-      # field still apply to all members in that shard, except if overriden.
+    - shardNames: [ "pod-template-shards-1-2" ]
+      # This override will apply to shard of index 2
+      # Statefulset settings defined at this level (shardOverrides.statefulSet)
+      # apply to members of shard 2 in ALL clusters.
+      # This field has higher priority than shard.clusterSpecList.statefulSet, but
+      # lower than shardOverrides.clusterSpecList.statefulSet
+      # It has a merge policy, which means that the limits defined above for the
+      # mongodb-enterprise-database container field still apply to all members in
+      # that shard, except if overridden.
       statefulSet:
         spec:
           template:
@@ -79,8 +83,8 @@ spec:
         - clusterName: kind-e2e-cluster-2
           members: 1
           # The below statefulset override is applicable only to members of shard 2, in cluster 1
-          # Specs will be merged, the "limits" field defined above will still be applied to containers in this cluster,
-          # together with the requests field below.
+          # Specs will be merged, the "limits" field defined above will still be applied
+          # to containers in this cluster together with the requests field below.
           statefulSet:
             spec:
               template:
@@ -93,7 +97,8 @@ spec:
                           memory: 1.0G
 
           podSpec:
-            # In shardOverrides.clusterSpecList.podSpec, only persistence field must be used, the podTemplate field is ignored.
+            # In shardOverrides.clusterSpecList.podSpec, only persistence field must be
+            # used, the podTemplate field is ignored.
             persistence: # we assign additional disk resources in shard 2, cluster 1
               multiple:
                 journal:

source/includes/code-examples/yaml-files/shardSpecificPodSpec_migration.yaml

@@ -1,15 +1,16 @@
-# This file is an example of how to migrate from the old deprecated ShardSpecificPodSpec field to the new
-# shardOverrides fields, for single cluster deployments.
-# The settings specified in shardOverrides are the exact equivalent to the ones in shardSpecificPodSpec, showing how
-# to replicate them
+# This file is an example of how to migrate from the old deprecated
+# ShardSpecificPodSpec field to the new shardOverrides fields
+# for single cluster deployments.
+# The settings specified in shardOverrides are the exact equivalent to the
+# ones in shardSpecificPodSpec, showing how to replicate them
 apiVersion: mongodb.com/v1
 kind: MongoDB
 metadata:
   name: shardspecificpodspec-migration
   namespace: mongodb-test
 spec:
-  # There are 4 shards in this cluster, but the shardSpecificPodSpec field doesn't need to have on entry per shard,
-  # it can have less
+  # There are 4 shards in this cluster, but the shardSpecificPodSpec field
+  # doesn't need to have on entry per shard, it can have less
   shardCount: 4
   mongodsPerShardCount: 2
   mongosCount: 1
@@ -32,7 +33,8 @@ spec:
     - persistence: # shard of index 0
         single:
           storage: "6G"
-      podTemplate: # Specify resources settings to enterprise database container in shard 0
+      # Specify resources settings to enterprise database container in shard 0
+      podTemplate:
         spec:
           containers:
             - name: mongodb-enterprise-database
@@ -50,7 +52,8 @@ spec:
         single:
           storage: "7G"
 
-  # The below shardOverrides replicate the same shards configuration as the one specified above in shardSpecificPodSpec
+  # The below shardOverrides replicate the same shards configuration as the one
+  # specified above in shardSpecificPodSpec
   shardOverrides:
     - shardNames: [ "shardspecificpodspec-migration-0" ] # overriding shard #0
       podSpec:
@@ -71,8 +74,9 @@ spec:
                       cpu: 1.0
                       memory: 2.0G
 
-    # The ShardSpecificPodSpec field above has the same configuration for shards 1 and 2. It is possible
-    # to specify both shard names in the override and not duplicate that configuration
+    # The ShardSpecificPodSpec field above has the same configuration for shards
+    # 1 and 2. It is possible to specify both shard names in the override and not
+    # duplicate that configuration
     - shardNames: [ "shardspecificpodspec-migration-1", "shardspecificpodspec-migration-2" ]
       podSpec:
         persistence:

source/multi-cluster-sharded-cluster-disaster-recovery.txt

@@ -0,0 +1,27 @@
+.. _mcsc-disaster-recovery:
+
+=============================================================
+Disaster Recovery for Multi-Cluster Sharded Cluster Resources
+=============================================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+:ref:`recover-mcsc-yes-k8sop-cluster`
+
+:ref:`recover-mcsc-no-k8sop-cluster`
+
+:ref:`recover-mcsc-forced-reconfig`
+
+.. toctree::
+   :titlesonly:
+   :hidden:
+
+   Recover Available Cluster </tutorial/recover-mcsc-yes-k8sop-cluster>
+   Recover Failed Cluster </tutorial/recover-mcsc-no-k8sop-cluster>
+   Recover Lost Majority Replica Set </tutorial/recover-mcsc-forced-reconfig>