Skip to content

Commit b0e5649

Browse files
jvincent-mongodbjwilliams-mongo
authored andcommitted
DOCSP-43584 -- Create Multi Cluster Sharded Cluster Overview Page (#1842)
* DOCSP-43584 -- Add page to toc * DOCSP-43584 -- Add public preview banner to page * DOCSP-43584 -- Fix title * DOCSP-43584 -- Fix title * DOCSP-43584 -- add banner * DOCSP-43584 -- draft page copy * DOCSP-43584 -- edit * DOCSP-43584 -- edit * DOCSP-43584 -- fix toc * DOCSP-43584 -- fix toc * DOCSP-43584 -- fix toc * DOCSP-43584 -- external review revisions * DOCSP-43584 -- external review revisions * DOCSP-43584 -- copy review revisions * DOCSP-43584 -- add link to ref docs * DOCSP-43584 -- add multi-region latency warning
1 parent 7746ff0 commit b0e5649

File tree

4 files changed

+65
-1
lines changed

4 files changed

+65
-1
lines changed

snooty.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,3 +236,13 @@ vault-short = "Vault"
236236
vpc = ":abbr:`VPC (Virtual Private Cloud)`"
237237
yaml = ":abbr:`YAML (Yet Another Markup Language)`"
238238

239+
[[banners]]
240+
# dark mode/appearance in public preview
241+
targets = [
242+
"k8s-operator-specification.txt",
243+
"multi-cluster-sharded-cluster.txt"
244+
]
245+
variant = "warning"
246+
value = """
247+
Multi-cluster Sharded Cluster Deployments are currently in public preview.
248+
"""

source/mdb-resources.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,4 @@ from the |k8s| |api|, without having to configure them in
5252
/tutorial/configure-mongodb-specific-storage
5353
/manage-users
5454
/connect
55+
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
.. _multi-cluster-sharded-cluster:
2+
3+
==============================
4+
Multi-Cluster Sharded Cluster
5+
==============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. meta::
10+
:keywords: multicluster, multi-cluster
11+
12+
.. contents:: On this page
13+
:local:
14+
:backlinks: none
15+
:depth: 2
16+
:class: singlecol
17+
18+
The multi-cluster sharded cluster deployment topology is currently in public preview.
19+
Multi-cluster sharded cluster deployments are not recommended for
20+
use in production environments, as there may be breaking changes in the
21+
functionality before this features becomes generally available and supported
22+
for production use. Moreover, during the public preview we are unable to provide
23+
support for this specific deployment topology without prior commitment from the
24+
product and engineering teams responsible for this feature.
25+
26+
.. important::
27+
28+
The multi-cluster sharded cluster functionality makes it possible to deploy
29+
MongoDB resources across multiple |k8s| clusters in multiple geographic regions;
30+
however, doing so will likely increase latency for replication operations.
31+
32+
If you are interested in discussing the public preview of multi-cluster
33+
sharded cluster deployments, or have any feedback on the feature, please contact
34+
your MongoDB account team.
35+
36+
The scope of the public preview release of the multi-cluster sharded
37+
cluster feature includes the following:
38+
39+
- Implement multi-cluster sharded cluster deployment capabilities by defining
40+
a ``MongoDB`` custom resource as having a ``spec.topology`` value of
41+
``MultiCluster``, and a ``spec.type`` value of ``ShardedCluster``.
42+
43+
- Introduce the ability to override any settings for a particular shard
44+
via the new ``spec.shard.shardOverrides`` field.
45+
46+
- Ensure backwards compatibility for existing :ref:`single-cluster MongoDB sharded
47+
cluster deployments <deploy-sharded-cluster>`.
48+
49+
To learn more about the specific configuration options for the multi-cluster
50+
sharded cluster topology, please see the :ref:`sharded cluster reference documentation <sharded-cluster-settings>`.

source/multi-cluster.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ Deploy MongoDB Resources on Multiple Kubernetes Clusters
4141
:ref:`multi-cluster-no-service-mesh-deploy-rs`
4242
Deploy a |mongodb-multi| as a replica set without a service mesh.
4343

44+
:ref:`multi-cluster-sharded-cluster`
45+
Deploy a |mongodb-multi| as Sharded Clusters.
46+
4447
:ref:`multi-cluster-edit-replica-set`
4548
Modify the configuration of a |mongodb-multi|.
4649

@@ -73,7 +76,7 @@ Deploy MongoDB Resources on Multiple Kubernetes Clusters
7376
Edit a MongoDBMultiCluster Resource </tutorial/multi-cluster-edit-deployment>
7477
Secure Connections </tutorial/multi-cluster-secure-client-connections>
7578
Access Resources </multi-cluster-connect>
76-
79+
Sharded Cluster </multi-cluster-sharded-cluster>
7780
Disaster Recovery </multi-cluster-disaster-recovery>
7881
MongoDB Plugin Reference </plugin-reference>
7982
Troubleshoot Deployments </multi-cluster-troubleshooting>

0 commit comments

Comments
 (0)