Skip to content

Commit 710b527

Browse files
authored
Add Flex Clusters alongside Shared (#162) (#163)
* add Flex * update admonition
1 parent 94c72b7 commit 710b527

15 files changed

+62
-57
lines changed

snooty.toml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,14 @@ encrypt-at-rest = "Encryption at Rest using Customer Key Management"
7676
ecosystem = "`MongoDB Partner Ecosystem Catalog <https://www.mongodb.com/ecosystem/>`__"
7777
FDI = "Federated Database Instance"
7878
fdi = "federated database instance"
79+
Flex-Cluster = "Flex Cluster"
80+
Flex-cluster = "Flex cluster"
81+
Flex-Clusters = "Flex Clusters"
82+
Flex-clusters = "Flex clusters"
7983
Free-cluster = "Free cluster"
80-
free-cluster = "free cluster"
84+
# free-cluster = "free cluster"
8185
Free-clusters = "Free clusters"
82-
free-clusters = "free clusters"
86+
# free-clusters = "free clusters"
8387
Free-Cluster = "Free Cluster"
8488
Free-Clusters = "Free Clusters"
8589
fts = "Atlas Search"
@@ -110,15 +114,15 @@ sdk = ":abbr:`SDK (Software Development Kit)`"
110114
service = "Atlas"
111115
service-api-v1-base-uri = "https://cloud.mongodb.com/api/atlas/v1.0"
112116
Serverless-instance = "Serverless instance"
113-
serverless-instance = "serverless instance"
117+
# serverless-instance = "serverless instance"
114118
Serverless-Instance = "Serverless Instance"
115119
Serverless-instances = "Serverless instances"
116-
serverless-instances = "serverless instances"
120+
# serverless-instances = "serverless instances"
117121
Serverless-Instances = "Serverless Instances"
118122
Shared-cluster = "Shared cluster"
119-
shared-cluster = "shared cluster"
123+
# shared-cluster = "shared cluster"
120124
Shared-clusters = "Shared clusters"
121-
shared-clusters = "shared clusters"
125+
# shared-clusters = "shared clusters"
122126
Shared-Cluster = "Shared Cluster"
123127
Shared-Clusters = "Shared Clusters"
124128
spi = "stream processing instance"

source/ak8so-back-up-deployment.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ Back Up Your |service| {+Cluster+}
1616

1717
.. note:: {+Serverless-instances+} back up automatically
1818

19-
|service| automatically enables backups for {+serverless-instances+}
19+
|service| automatically enables backups for {+Serverless-instances+}
2020
and takes snapshots every six hours. Any |ak8so| backup custom
21-
resources you apply to a {+serverless-instance+} will not override
21+
resources you apply to a {+Serverless-instance+} will not override
2222
the automatic settings.
2323

24-
To learn more about backups for {+serverless-instances+}, see
24+
To learn more about backups for {+Serverless-instances+}, see
2525
:ref:`serverless-snapshots`.
2626

2727
|ak8so| supports :ref:`{+cloud-backup+} <backup-cloud-provider>` for

source/ak8so-bcp.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ Prerequisites
8282
.. note::
8383

8484
You can't convert a {+dedicated-cluster+} to an ``M0``
85-
{+free-cluster+}, an ``M2`` or ``M5`` {+shared-cluster+}, or a
86-
{+serverless-instance+}.
85+
{+Free-cluster+}, an ``M2`` or ``M5`` {+Shared-cluster+}, a
86+
{+Flex-cluster+}, or a {+Serverless-instance+}.
8787

8888
Procedure
8989
---------

source/ak8so-changelog.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -702,7 +702,7 @@ New Features
702702

703703
:ref:`atlasdeployment-custom-resource`:
704704

705-
- Supports :ref:`{+serverless-instances+} <ak8so-serverless-instance>`
705+
- Supports :ref:`{+Serverless-instances+} <ak8so-serverless-instance>`
706706
via the :setting:`spec.serverlessSpec` field.
707707
- Supports :ref:`scheduled backups <ak8so-backup>` for
708708
{+database-deployments+}.
@@ -717,7 +717,7 @@ New Features
717717
``M0``, ``M2``, and ``M5`` {+clusters+}.
718718
- Supports omitting the
719719
:setting:`spec.serverlessSpec.providerSettings.providerName` field for
720-
{+serverless-instances+}.
720+
{+Serverless-instances+}.
721721

722722
Fixes
723723
~~~~~

source/ak8so-private-link-serverless.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Manage Private Endpoints for {+Serverless-Instances+}
1313
:class: singlecol
1414

1515
|ak8so| supports managing private endpoints for
16-
{+serverless-instances+} on the following platforms:
16+
{+Serverless-instances+} on the following platforms:
1717

1818
- |aws| using the `{+aws-pl+} <https://aws.amazon.com/privatelink/>`__
1919
feature.
@@ -35,7 +35,7 @@ Before you begin, see :ref:`ak8so-private-endpoint`.
3535
Procedure
3636
---------
3737

38-
To enable clients to connect to |service| {+serverless-instances+}
38+
To enable clients to connect to |service| {+Serverless-instances+}
3939
using private endpoints:
4040

4141
.. tabs::

source/ak8so-private-link.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Manage Private Endpoints
1515
.. include:: /includes/fact-atlas-free-tier-limits.rst
1616

1717
|ak8so| supports private endpoints to connect to
18-
{+dedicated-clusters+}, {+serverless-instances+}, and {+fdi+}s.
18+
{+dedicated-clusters+}, {+Serverless-instances+}, and {+fdi+}s.
1919

2020
When you use |ak8so| to configure private links in |service|, |service|
2121
creates its own |vpc| or a Private Link service and places
22-
{+dedicated-clusters+} or {+serverless-instances+} within a region
22+
{+dedicated-clusters+} or {+Serverless-instances+} within a region
2323
behind a load balancer in the |service| |vpc| or |service| VNet. To
2424
learn more, see the :ref:`Private Endpoint Overview
2525
<private-endpoint-overview>`.
@@ -31,7 +31,7 @@ update one of the following parameters:
3131
:setting:`spec.privateEndpoints` parameter for the
3232
:ref:`atlasproject-custom-resource`.
3333

34-
- For {+serverless-instances+}, specify the
34+
- For {+Serverless-instances+}, specify the
3535
:setting:`spec.serverlessSpec.privateEndpoints` parameter for the
3636
:ref:`atlasdeployment-custom-resource`.
3737

@@ -144,7 +144,7 @@ Procedure
144144
---------
145145

146146
To enable clients to connect to |service| {+dedicated-clusters+} or
147-
{+serverless-instances+} using private endpoints, see the following
147+
{+Serverless-instances+} using private endpoints, see the following
148148
procedures:
149149

150150
- :ref:`ak8so-private-endpoint-dedicated`

source/atlasdeployment-custom-resource.txt

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
:class: singlecol
1414

1515
The ``AtlasDeployment`` custom resource configures your MongoDB {+cluster+}
16-
or {+serverless-instance+} in |service|. When you create the ``AtlasDeployment``
16+
or {+Serverless-instance+} in |service|. When you create the ``AtlasDeployment``
1717
custom resource, |ak8so| tries to create or update a {+cluster+} or
18-
{+serverless-instance+} in |service|.
18+
{+Serverless-instance+} in |service|.
1919

2020
.. important:: Action Required for Breaking Changes with |ak8so| 2.0
2121

@@ -48,9 +48,9 @@ specify in the ``AtlasDeployment`` custom resource:
4848
to create a new {+cluster+} or update an existing {+cluster+}.
4949
- If you specify values for fields under ``spec.serverlessSpec``, |ak8so|
5050
uses the |service| :oas-atlas-tag:`Serverless Instance API Resource </Serverless-Instances>`
51-
to create a new {+serverless-instance+} or update an existing {+serverless-instance+}.
51+
to create a new {+Serverless-instance+} or update an existing {+Serverless-instance+}.
5252

53-
Creating or updating a {+cluster+} or {+serverless-instance+} can take
53+
Creating or updating a {+cluster+} or {+Serverless-instance+} can take
5454
up to 10 minutes. |ak8so| monitors the update process.
5555

5656
You can run the following command to check on the status:
@@ -73,7 +73,7 @@ provisioning:
7373
message: Cluster is provisioning
7474

7575
The ``ClusterReady`` status will change to ``True`` when the {+cluster+}
76-
or {+serverless-instance+} is ready.
76+
or {+Serverless-instance+} is ready.
7777

7878
.. _atlasdeployment-examples:
7979

@@ -216,7 +216,7 @@ specification configured with some of the :oas-atlas-tag:`additional options
216216
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
217217

218218
The following example shows an ``AtlasDeployment`` custom resource
219-
specification configured for a {+serverless-instance+}:
219+
specification configured for a {+Serverless-instance+}:
220220

221221
.. code-block::
222222

@@ -421,7 +421,7 @@ parameters available.
421421
- For a full list of available parameters for {+clusters+},
422422
see the |service| :oas-atlas-op:`{+Clusters+} API </createCluster>`.
423423

424-
- For a full list of available parameters for {+serverless-instances+},
424+
- For a full list of available parameters for {+Serverless-instances+},
425425
see the |service| :oas-atlas-tag:`{+Serverless-Instances+} API </Serverless-Instances>`.
426426

427427
To customize your specifications, refer to these descriptions, the available
@@ -951,11 +951,11 @@ examples, and the |api| documentation.
951951

952952
.. note::
953953

954-
You can change this setting to upgrade an ``M0``, ``M2``, or
955-
``M5`` {+cluster+} to an ``M10+`` {+cluster+}. However, you can't
956-
upgrade an ``M0``, ``M2``, or ``M5`` {+cluster+} to another free
954+
You can change this setting to upgrade an ``M0``, ``M2``, ``M5``, or
955+
{+Flex-cluster+} to an ``M10+`` {+cluster+}. However, you can't
956+
upgrade an ``M0``, ``M2``, ``M5`, or {+Flex-cluster+} to another free
957957
or shared {+cluster+}. For example, you can't upgrade an ``M0``
958-
{+cluster+} to an ``M5`` {+cluster+}.
958+
{+cluster+} to a {+Flex-cluster+}.
959959

960960
.. setting:: spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.nodeCount
961961

@@ -1547,7 +1547,7 @@ examples, and the |api| documentation.
15471547

15481548
*Conditional*
15491549

1550-
List that contains the {+serverless-instance+} parameters from the
1550+
List that contains the {+Serverless-instance+} parameters from the
15511551
|api|. For a full list of available parameters, see the |service|
15521552
:oas-atlas-tag:`{+Serverless-Instances+} API
15531553
</Serverless-Instances>`.
@@ -1566,7 +1566,7 @@ examples, and the |api| documentation.
15661566

15671567
List that contains the :ref:`private endpoint
15681568
<ak8so-private-endpoint>` configurations for the
1569-
{+serverless-instance+}.
1569+
{+Serverless-instance+}.
15701570

15711571
.. setting:: spec.serverlessSpec.providerSettings
15721572

@@ -1578,9 +1578,9 @@ examples, and the |api| documentation.
15781578
on which MongoDB runs. The available options are specific to the
15791579
cloud service provider. To learn more, see the :ref:`AWS
15801580
<amazon-aws>`, :ref:`GCP <google-gcp>`, and :ref:`Azure
1581-
<microsoft-azure>` {+serverless-instance+} configuration options.
1581+
<microsoft-azure>` {+Serverless-instance+} configuration options.
15821582

1583-
If you want to create or update a {+serverless-instance+}, you must
1583+
If you want to create or update a {+Serverless-instance+}, you must
15841584
specify this setting.
15851585

15861586
.. important::
@@ -1604,7 +1604,7 @@ examples, and the |api| documentation.
16041604
*Conditional*
16051605

16061606
Cloud service provider on which |service| provisions the host for a
1607-
{+serverless-instance+}.
1607+
{+Serverless-instance+}.
16081608

16091609
|service| accepts the following values:
16101610

@@ -1625,7 +1625,7 @@ examples, and the |api| documentation.
16251625

16261626
**Conditional**
16271627

1628-
Physical location of your MongoDB {+serverless-instance+}. The
1628+
Physical location of your MongoDB {+Serverless-instance+}. The
16291629
region you choose can affect network latency for clients accessing
16301630
your databases.
16311631

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. note::
22

3-
This feature is not available for ``M0`` {+free-clusters+}, ``M2``, and
4-
``M5`` clusters. To learn more about which features are unavailable,
5-
see :ref:`atlas-free-tier`.
3+
This feature is not available for any of the following deployments:
4+
5+
- ``M0`` clusters
6+
- ``M2/M5`` clusters
7+
- {+Flex-clusters+}

source/includes/fact-custom-database-role-overview.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ roles together with:
1212

1313
You can assign multiple custom roles to each database user.
1414

15-
.. note:: {+Free-Cluster+}, {+Shared-Cluster+}, and {+Serverless-Instance+} Limitation
15+
.. note:: Limitations
1616

1717
Changes to :atlas:`custom roles </security-add-mongodb-roles>`
18-
might take up to 30 seconds to deploy in ``M0`` {+free-clusters+},
19-
``M2/M5`` {+shared-clusters+}, and {+serverless-instances+}.
18+
might take up to 30 seconds to deploy in ``M0`` {+Free-clusters+},
19+
``M2/M5`` {+Shared-clusters+}, {+Flex-clusters+}, and {+Serverless-instances+}.
2020

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
MongoDB plans to add support for more configurations and
2-
capabilities on {+serverless-instances+} over time. To learn which
3-
features MongoDB plans to support for {+serverless-instances+} in
2+
capabilities on {+Serverless-instances+} over time. To learn which
3+
features MongoDB plans to support for {+Serverless-instances+} in
44
the future, see :ref:`<serverless-instance-limitations>`.

0 commit comments

Comments
 (0)