Skip to content

Commit 3619a4b

Browse files
authored
(DOCSP-47200) Transferred the same follow-up to the AKO docs as done for Atlas Docs (#203) (#206)
* (DOCSP-47200) Transferred the same followup to the AKO docs as done for Atlas docs * edits * Edits * Edits
1 parent f1355b7 commit 3619a4b

File tree

4 files changed

+81
-39
lines changed

4 files changed

+81
-39
lines changed

source/atlasdeployment-custom-resource.txt

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Migration to {+Flex-Clusters+}
3131
* Replace references to :setting:`spec.serverlessSpec` with configuration for
3232
:setting:`spec.flexSpec`.
3333

34+
3435
Breaking Changes with |ak8so| 2.0
3536
----------------------------------
3637

@@ -78,7 +79,7 @@ specify in the ``AtlasDeployment`` custom resource:
7879
.. note::
7980

8081
Don't specify values for fields under :setting:`spec.serverlessSpec` because
81-
{+Serverless-instances+} will be deprecated soon. Instead, specify fields under
82+
{+Serverless-instances+} are deprecated. Instead, specify fields under
8283
:setting:`spec.flexSpec`. To learn more, see :ref:`ak8so-migration-to-flex`.
8384

8485
Creating or updating a {+cluster+} or {+Flex-cluster+} can take
@@ -246,6 +247,11 @@ specification configured with some of the :oas-atlas-tag:`additional options
246247
{+Flex-Cluster+} Example
247248
~~~~~~~~~~~~~~~~~~~~~~~~~
248249

250+
.. _ak8so-flex-notes:
251+
252+
Notes on Transition To {+Flex-Clusters+}
253+
++++++++++++++++++++++++++++++++++++++++++
254+
249255
.. include:: /includes/fact-ak8so-flex.rst
250256

251257
The following example shows an ``AtlasDeployment`` custom resource
@@ -490,7 +496,7 @@ parameters available.
490496
- For a full list of available parameters for {+Flex-clusters+},
491497
see the |service| :oas-atlas-tag:`{+Flex-Clusters+} API </Flex-Clusters>`.
492498

493-
.. include:: /includes/fact-ak8so-flex.rst
499+
See :ref:`ak8so-flex-notes` for full information on changes.
494500

495501
To customize your specifications, refer to these descriptions, the available
496502
examples, and the |api| documentation.
@@ -562,7 +568,7 @@ examples, and the |api| documentation.
562568
You must specify :setting:`spec.deploymentSpec` or :setting:`spec.flexSpec`
563569
in your configuration.
564570

565-
.. include:: /includes/fact-ak8so-flex.rst
571+
See :ref:`ak8so-flex-notes` for full information on changes.
566572

567573
.. setting:: spec.deploymentSpec.clusterType
568574

@@ -742,8 +748,8 @@ examples, and the |api| documentation.
742748
``LTS``.
743749
- |service| deploys a {+cluster+} that runs MongoDB 7.0.
744750

745-
* - |service| will deprecate ``M2`` and ``M5`` {+clusters+} and
746-
{+Serverless-instances+} in the near future. To learn more,
751+
* - |service| deprecated ``M2`` and ``M5`` {+clusters+} and
752+
{+Serverless-instances+}. To learn more,
747753
see :ref:`ak8so-migration-to-flex`.
748754
Set the :setting:`spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs.instanceSize`
749755
parameter to ``M0``, ``M2``, or ``M5``.
@@ -1480,7 +1486,7 @@ examples, and the |api| documentation.
14801486

14811487
.. note::
14821488

1483-
.. include:: /includes/fact-ak8so-flex.rst
1489+
See :ref:`ak8so-flex-notes` for full information on changes.
14841490

14851491
List that contains the {+Flex-cluster+} parameters from the
14861492
|api|. For a full list of available parameters, see the |service|
@@ -1701,7 +1707,7 @@ examples, and the |api| documentation.
17011707

17021708
.. note::
17031709

1704-
.. include:: /includes/fact-ak8so-flex.rst
1710+
See :ref:`ak8so-flex-notes` for full information on changes.
17051711

17061712
List that contains the {+Serverless-instance+} parameters from the
17071713
|api|. For a full list of available parameters, see the |service|
@@ -1736,7 +1742,7 @@ examples, and the |api| documentation.
17361742

17371743
.. note::
17381744

1739-
.. include:: /includes/fact-ak8so-flex.rst
1745+
See :ref:`ak8so-flex-notes` for full information on changes.
17401746

17411747
Configuration that specifies the settings for the provisioned hosts
17421748
on which MongoDB runs. The available options are specific to the
@@ -1769,7 +1775,7 @@ examples, and the |api| documentation.
17691775

17701776
.. note::
17711777

1772-
.. include:: /includes/fact-ak8so-flex.rst
1778+
See :ref:`ak8so-flex-notes` for full information on changes.
17731779

17741780
Cloud service provider on which |service| provisions the host for a
17751781
{+Serverless-instance+}.
@@ -1795,7 +1801,7 @@ examples, and the |api| documentation.
17951801

17961802
.. note::
17971803

1798-
.. include:: /includes/fact-ak8so-flex.rst
1804+
See :ref:`ak8so-flex-notes` for full information on changes.
17991805

18001806
Physical location of your MongoDB {+Serverless-instance+}. The
18011807
region you choose can affect network latency for clients accessing
@@ -1813,7 +1819,7 @@ examples, and the |api| documentation.
18131819
.. setting:: spec.serverlessSpec.tags
18141820

18151821
.. note::
1816-
.. include:: /includes/fact-ak8so-flex.rst
1822+
See :ref:`ak8so-flex-notes` for full information on changes.
18171823

18181824
.. include:: /includes/fact-ak8so-tags.rst
18191825

source/includes/fact-ak8so-continuous-backup-private-endpoints-flex.rst

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
|service| will deprecate ``M2`` and ``M5`` {+clusters+} and {+Serverless-instances+}
2-
in the near future. |service| will automatically migrate all ``M2`` and ``M5``
1+
|service| deprecated ``M2`` and ``M5`` {+clusters+} and {+Serverless-instances+}.
2+
In the near future, |service| will automatically migrate all ``M2`` and ``M5``
33
{+clusters+} to {+Flex-clusters+}. For {+Serverless-instances+}, |service| will
44
determine whether to migrate instances to {+Free-clusters+},
55
{+Flex-clusters+}, or {+Dedicated-clusters+} according to your usage,
66
then migrate your {+Serverless-instances+} automatically.
77

8-
The automatic migration of ``M2`` and ``M5`` {+clusters+} and {+Serverless-instances+}
9-
to {+Flex-clusters+} is seamless in |ak8so| without you having to make any
10-
migration changes, even though your CRD configurations might still contain parameters
11-
that are EOL.
128

139
To preserve backwards compatibility of the APIs for a period of time, |service|
1410
will continue to allow for these migrated {+clusters+} to be managed

source/includes/fact-ak8so-flex.rst

Lines changed: 60 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,63 @@
1-
{+Serverless-instances+} will be deprecated soon. |ak8so| supports {+Flex-clusters+}.
2-
Replace references to :setting:`spec.serverlessSpec` with configuration for
3-
:setting:`spec.flexSpec`.
4-
5-
The automatic migration of ``M2`` and ``M5`` {+clusters+} and {+Serverless-instances+}
6-
to {+Flex-clusters+} is seamless in |ak8so| without you having to make any
7-
migration changes, even though your CRD configurations might still contain parameters
8-
that are EOL.
9-
10-
To preserve backwards compatibility of the APIs for a period of time, |service|
11-
will continue to allow for these migrated {+clusters+} to be managed
12-
through the same APIs, including when using |ak8so|. The backwards
13-
compatibility of APIs will remain in place until January 2026, when the old
14-
APIs will be removed and only APIs related to {+Flex-clusters+} will remain in place.
15-
16-
Support for private endpoints on {+Serverless-instances+} will end in March 2025.
17-
You must update your {+ak8so+} configurations to remove private endpoints
18-
by March 2025. You must remove all remaining ``M2``, ``M5``, and
19-
{+Serverless-instance+} features from your {+ak8so+} configurations before
20-
January 2026.
1+
- Until January 2026, to preserve backwards compatibility for a period of time,
2+
|service| allows you to manage migrated {+clusters+} through both
3+
the {+Serverless-instances+} and {+Flex-clusters+} APIs, including when
4+
you're using |ak8so|.
5+
6+
- You can create and manage {+Flex-clusters+} in the same
7+
:ref:`AtlasDeployment <atlasdeployment-custom-resource>` in which you
8+
created and managed {+Serverless-instances+} and ``M2`` and ``M5`` {+clusters+}.
9+
10+
- You can't create **NEW** ``M2``/``M5`` {+clusters+} and {+Serverless-instances+}
11+
in |service|. Attempting to do so creates a {+Flex-cluster+} instead.
12+
13+
- You can still use existing {+Serverless-instances+} in |ak8so| even though
14+
existing {+Serverless-instances+} are deprecated as of early February 2025.
15+
16+
- For your existing {+Serverless-instances+}, you can choose to replace
17+
references to :setting:`spec.serverlessSpec` in the :ref:`AtlasDeployment <atlasdeployment-custom-resource>`
18+
with the configuration for :setting:`spec.flexSpec`. Or, you can
19+
continue using the same spec. Managing a deployment via the ``spec.serverlessSpec``
20+
in the ``AtlasDeployment`` Custom Resource will continue to work even
21+
once |service| automatically migrates these existing {+clusters+} to
22+
{+Flex-clusters+} in March 2025.
23+
24+
- For your existing ``M2`` and ``M5`` {+clusters+}, you can choose to replace
25+
references to :setting:`spec.deploymentSpec` in the ``AtlasDeployment``
26+
Custom Resource with the configuration for :setting:`spec.flexSpec`. Or, you can
27+
continue using the same spec. Managing a deployment via the ``spec.deploymentSpec``
28+
in the ``AtlasDeployment`` Custom Resource will continue to work even
29+
once |service| automatically migrates these existing ``M2`` and ``M5`` {+clusters+}
30+
to {+Flex-clusters+} in May 2025.
31+
32+
- For your existing {+Serverless-instances+}, if you receive errors during
33+
reconciliations related to private endpoints, you must upgrade to
34+
{+ak8so+} 2.7.1, or replace the ``serverlessSpec`` configuration with
35+
the configuration for ``flexSpec`` in the ``AtlasDeployment`` custom resource.
36+
37+
- For your ``M2`` and ``M5`` {+clusters+}, to avoid reconciliation errors
38+
that you might notice after the automigration, make the following changes
39+
to your CRD configurations:
40+
41+
- Remove the :setting:`spec.deploymentSpec.replicationSpecs.zoneName` setting.
42+
43+
- Remove any of the :setting:`spec.deploymentSpec.replicationSpecs.regionConfigs`
44+
settings after the first set of settings.
45+
46+
- Specify ``replicaset`` only in the :setting:`spec.deploymentSpec.clusterType`.
47+
48+
Alternatively, replace references to ``spec.deploymentSpec``
49+
in the :ref:`AtlasDeployment <atlasdeployment-custom-resource>` with the configuration for
50+
``spec.flexSpec``.
51+
52+
- By January 2026, you must remove all remaining ``M2``/``M5`` and
53+
{+Serverless-Instance+} configurations from your {+ak8so+} custom resources
54+
because backwards compatibility of APIs ends January 2026, when the old
55+
APIs will be removed and only APIs related to {+Flex-clusters+} will
56+
remain in place.
57+
58+
- Newer releases of {+ak8so+} will cease supporting existing
59+
``M2``/``M5`` {+clusters+} and {+Serverless-instances+}. Older versions of {+ak8so+}
60+
will continue to support these instance types until January 2026.
2161

2262
To learn more, see :ref:`ak8so-migration-to-flex`
2363
in this guide and the :atlas:`Flex Migration Guide </flex-migration>`

source/includes/fact-ak8so-migration-to-flex.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
|service| will deprecate ``M2`` and ``M5`` {+clusters+} and
2-
{+Serverless-instances+} in the near future. |service| will
1+
|service| deprecated ``M2`` and ``M5`` {+clusters+} and
2+
{+Serverless-instances+}. |service| will
33
automatically migrate all ``M2`` and ``M5`` {+clusters+}
44
to {+Flex-clusters+}.
55
For {+Serverless-instances+}, |service| will

0 commit comments

Comments
 (0)