12
12
:depth: 2
13
13
:class: singlecol
14
14
15
- The ``AtlasDeployment`` custom resource configures your MongoDB
16
- {+cluster+} or {+serverless-instance+} in |service|. When you create
17
- the ``AtlasDeployment`` custom resource, |ak8so| tries to create or
18
- update a {+cluster+} or {+serverless-instance+} in |service|.
15
+ The ``AtlasDeployment`` custom resource configures your MongoDB {+cluster+}
16
+ or {+serverless-instance+} in |service|. When you create the ``AtlasDeployment``
17
+ custom resource, |ak8so| tries to create or update a {+cluster+} or
18
+ {+serverless-instance+} in |service|.
19
19
20
20
.. important:: Action Required for Breaking Changes with |ak8so| 2.0
21
21
22
22
* With |ak8so| 2.0, ``deploymentSpec`` replaces ``advancedDeploymentSpec`` in
23
23
the ``AtlasDeployment`` custom resource. You must update your ``AtlasDeployment``
24
24
custom resource as follows:
25
25
26
- * If you use ``advancedDeploymentSpec``, rename to ``deploymentSpec``.
26
+ * If you use ``advancedDeploymentSpec``, rename it to ``deploymentSpec``.
27
27
You don't need to change any formatting.
28
28
29
29
* If you used ``deploymentSpec`` prior to |ak8so| 2.0, rewrite your
30
30
``AtlasDeployment`` custom resource to match the formatting used in
31
31
:ref:`the examples <atlasdeployment-examples>`.
32
32
33
33
* |ak8so| uses :ref:`custom resource <custom-resources>` configuration
34
- files to manage your |service| configuration, but as of |ak8so| 2.0,
34
+ files to manage your |service| configuration. As of |ak8so| 2.0,
35
35
custom resources you delete in |k8s| are no longer deleted in
36
36
|service|. Instead, |ak8so| simply stops managing those resources.
37
37
For example, if you delete an :ref:`atlasproject-custom-resource`
@@ -40,17 +40,15 @@ update a {+cluster+} or {+serverless-instance+} in |service|.
40
40
including how to :ref:`revert this behavior <revert-deletion-protection>` to
41
41
the default used prior to |ak8so| 2.0, see :ref:`deletion-protection`.
42
42
43
- |ak8so| does one of the following actions depending on the
44
- values you specify in the ``AtlasDeployment`` custom resource:
43
+ |ak8so| does one of the following actions depending on the values you
44
+ specify in the ``AtlasDeployment`` custom resource:
45
45
46
- - If you specify values for fields under ``spec.deploymentSpec``,
47
- |ak8so| uses the |service| :oas-atlas-tag:`Clusters API Resource
48
- </Clusters>` to create a new {+cluster+} or
49
- update an existing {+cluster+}.
50
- - If you specify values for fields under ``spec.serverlessSpec``,
51
- |ak8so| uses the |service| :oas-atlas-tag:`Serverless Instance API
52
- Resource </Serverless-Instances>` to create a new
53
- {+serverless-instance+} or update an existing {+serverless-instance+}.
46
+ - If you specify values for fields under ``spec.deploymentSpec``, |ak8so|
47
+ uses the |service| :oas-atlas-tag:`Clusters API Resource </Clusters>`
48
+ to create a new {+cluster+} or update an existing {+cluster+}.
49
+ - If you specify values for fields under ``spec.serverlessSpec``, |ak8so|
50
+ 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+}.
54
52
55
53
Creating or updating a {+cluster+} or {+serverless-instance+} can take
56
54
up to 10 minutes. |ak8so| monitors the update process.
@@ -74,8 +72,8 @@ provisioning:
74
72
reason: ClusterCreating
75
73
message: Cluster is provisioning
76
74
77
- The ``ClusterReady`` status will change to ``True`` when the
78
- {+cluster+} or {+serverless-instance+} is ready.
75
+ The ``ClusterReady`` status will change to ``True`` when the {+cluster+}
76
+ or {+serverless-instance+} is ready.
79
77
80
78
.. _atlasdeployment-examples:
81
79
@@ -85,7 +83,7 @@ Examples
85
83
Status Example
86
84
~~~~~~~~~~~~~~
87
85
88
- The following example shows the ``AtlasDeployment`` resource with a
86
+ The following example shows the ``AtlasDeployment`` resource with a
89
87
``ClusterReady`` status of ``True``:
90
88
91
89
.. code-block::
@@ -134,7 +132,7 @@ The following example shows the ``AtlasDeployment`` resource with a
134
132
135
133
Configuration Example
136
134
~~~~~~~~~~~~~~~~~~~~~
137
-
135
+
138
136
The following example shows an ``AtlasDeployment`` custom resource
139
137
specification configured for autoscaling multi-region {+clusters+}:
140
138
@@ -187,8 +185,8 @@ specification configured for autoscaling multi-region {+clusters+}:
187
185
Additional Options Example
188
186
~~~~~~~~~~~~~~~~~~~~~~~~~~
189
187
190
- The following example shows an ``AtlasDeployment`` custom resource
191
- specification configured with some of the :oas-atlas-tag:`additional options
188
+ The following example shows an ``AtlasDeployment`` custom resource
189
+ specification configured with some of the :oas-atlas-tag:`additional options
192
190
</Clusters>`.
193
191
194
192
.. code-block::
@@ -219,7 +217,7 @@ specification configured with some of the :oas-atlas-tag:`additional options
219
217
{+Serverless-Instance+} Example
220
218
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
219
222
- The following example shows an ``AtlasDeployment`` custom resource
220
+ The following example shows an ``AtlasDeployment`` custom resource
223
221
specification configured for a {+serverless-instance+}:
224
222
225
223
.. code-block::
@@ -246,10 +244,10 @@ specification configured for a {+serverless-instance+}:
246
244
.. _ak8so-advanced-clusters:
247
245
248
246
Multi-Region {+Cluster+} Example
249
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
247
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
250
248
251
- {+Clusters+} can span regions and cloud service providers. To
252
- learn more, see :ref:`create-new-cluster-considerations`.
249
+ {+Clusters+} can span regions and cloud service providers. To learn more,
250
+ see :ref:`create-new-cluster-considerations`.
253
251
254
252
.. note::
255
253
@@ -288,10 +286,9 @@ resource specification configured for multi-region {+clusters+}:
288
286
289
287
Multiple Cloud Service Providers Example
290
288
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
291
-
292
- The following example shows an ``AtlasDeployment`` custom
293
- resource specification configured to span multiple cloud service
294
- providers:
289
+
290
+ The following example shows an ``AtlasDeployment`` custom resource
291
+ specification configured to span multiple cloud service providers:
295
292
296
293
.. code-block::
297
294
@@ -336,24 +333,26 @@ providers:
336
333
Parameters
337
334
----------
338
335
339
- This section describes some of the key ``AtlasDeployment`` custom
340
- resource parameters available. For a full list of available parameters
341
- for {+clusters+}, see the |service| :oas-atlas-op:`{+Clusters+} API
342
- </createCluster>`. For a full list of available parameters for
343
- {+serverless-instances+}, see the |service|
344
- :oas-atlas-tag:`{+Serverless-Instances+} API </Serverless-Instances>`.
336
+ This section describes some of the key ``AtlasDeployment`` custom resource
337
+ parameters available.
338
+
339
+ - For a full list of available parameters for {+clusters+},
340
+ see the |service| :oas-atlas-op:`{+Clusters+} API </createCluster>`.
345
341
346
- Refer to these descriptions, the available examples, and the |api|
347
- documentation to customize your specifications.
342
+ - For a full list of available parameters for {+serverless-instances+},
343
+ see the |service| :oas-atlas-tag:`{+Serverless-Instances+} API </Serverless-Instances>`.
344
+
345
+ To customize your specifications, Refer to these descriptions, the available
346
+ examples, and the |api| documentation.
348
347
349
348
.. setting:: spec.backupRef
350
349
351
350
*Type*: object
352
351
353
352
*Optional*
354
353
355
- List that contains the details for the
356
- :ref:`atlasbackupschedule-custom-resource` that you want to apply. You can specify one backup schedule per {+cluster+}.
354
+ List that contains the details for the :ref:`atlasbackupschedule-custom-resource`
355
+ that you want to apply. You can specify one backup schedule per {+cluster+}.
357
356
358
357
.. setting:: spec.backupRef.name
359
358
@@ -362,13 +361,12 @@ documentation to customize your specifications.
362
361
*Optional*
363
362
364
363
``metadata.name`` value within the
365
- :ref:`atlasbackupschedule-custom-resource` for the backup schedule
366
- that you want to apply. You can specify only one backup schedule per
367
- {+cluster+}, but you can use the same backup schedule for multiple
368
- {+clusters+}.
364
+ :ref:`atlasbackupschedule-custom-resource` for the backup schedule that
365
+ you want to apply. You can specify only one backup schedule per {+cluster+},
366
+ but you can use the same backup schedule for multiple {+clusters+}.
369
367
370
- If you don't specify this parameter, |service| doesn't apply your
371
- backup configuration to this {+cluster+}.
368
+ If you omit this parameter, |service| doesn't apply your backup
369
+ configuration to this {+cluster+}.
372
370
373
371
.. setting:: spec.backupRef.namespace
374
372
@@ -392,8 +390,8 @@ documentation to customize your specifications.
392
390
393
391
.. important::
394
392
395
- You must specify ``spec.deploymentSpec``
396
- or ``spec.serverlessSpec`` in your configuration.
393
+ You must specify ``spec.deploymentSpec`` or ``spec.serverlessSpec``
394
+ in your configuration.
397
395
398
396
.. setting:: spec.deploymentSpec.clusterType
399
397
@@ -419,8 +417,7 @@ documentation to customize your specifications.
419
417
:atlas:`Global {+Clusters+} </global-clusters>`.
420
418
- Required
421
419
422
- * - You are deploying non-Global replica sets and sharded
423
- {+clusters+}.
420
+ * - You are deploying non-Global replica sets and sharded {+clusters+}.
424
421
- Optional
425
422
426
423
|service| accepts:
@@ -456,33 +453,31 @@ documentation to customize your specifications.
456
453
457
454
*Optional*
458
455
459
- Capacity, in gigabytes, that indicates the host's root volume.
460
- Increase this number to add capacity, up to a maximum possible value
461
- of ``4096`` (4 TB). You must specify a positive number for
462
- this value.
456
+ Capacity, in gigabytes, that indicates the host's root volume. Increase
457
+ this number to add capacity, up to a maximum possible value of
458
+ ``4096`` (4 TB). You must specify a positive number for this value.
463
459
464
460
You can't set this value for |nvme-clusters|.
465
461
466
462
.. note::
467
463
468
- If you enable autoscaling for ``diskGB`` in any region, you
469
- can't edit this option. To learn more, see
470
- :setting:`spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB.enabled`.
464
+ If you enable autoscaling for ``diskGB`` in any region, you can't edit
465
+ this option. To learn more, see :setting:`spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB.enabled`.
471
466
472
- The minimum disk size for {+dedicated-clusters+} is 10 GB for |aws|
473
- and |gcp|. If you specify this setting with a lower disk size,
474
- |service| defaults to the minimum disk size value.
467
+ The minimum disk size for {+dedicated-clusters+} is 10 GB for |aws| and
468
+ |gcp|. If you specify this setting with a lower disk size, |service|
469
+ defaults to the minimum disk size value.
475
470
476
- If your {+database-deployment+} includes |azure| nodes, this value
477
- must correspond to an existing |azure| disk type (8, 16, 32, 64,
478
- 128, 256, 512, 1024, 2048, or 4096).
471
+ If your {+database-deployment+} includes |azure| nodes, this value must
472
+ correspond to an existing |azure| disk type (8, 16, 32, 64, 128, 256,
473
+ 512, 1024, 2048, or 4096).
479
474
480
- |service| calculates storage charges differently depending on
481
- whether you choose the default value or a custom value.
475
+ |service| calculates storage charges differently depending on whether
476
+ you choose the default value or a custom value.
482
477
483
478
.. include:: /includes/cluster-settings/extended-storage-limit.rst
484
479
485
- If your {+database-deployment+} spans cloud service providers, this
480
+ If your {+database-deployment+} spans cloud service providers, this
486
481
value defaults to the minimum default of the providers involved.
487
482
488
483
To learn more, see :ref:`storage-capacity`.
@@ -493,11 +488,9 @@ documentation to customize your specifications.
493
488
494
489
*Optional*
495
490
496
- Cloud service provider that manages the customer key for this
497
- {+cluster+}. You must set this value to enable encryption at rest
498
- using customer-managed keys for this {+cluster+}, which provides an
499
- additional layer of encryption.
500
-
491
+ Cloud service provider that manages the customer key for this {+cluster+}.
492
+ You must set this value to enable encryption at rest using customer-managed
493
+ keys for this {+cluster+}, which provides an additional layer of encryption.
501
494
To learn more, see :ref:`ak8so-ear`.
502
495
503
496
|service| accepts the following values:
@@ -572,17 +565,17 @@ documentation to customize your specifications.
572
565
573
566
* - You omit this parameter and you omit the
574
567
:setting:`spec.deploymentSpec.versionReleaseSystem` parameter.
575
- - |service| deploys a {+cluster+} that runs MongoDB 6 .0.
568
+ - |service| deploys a {+cluster+} that runs MongoDB 7 .0.
576
569
577
570
* - You omit this parameter and you set the
578
571
:setting:`spec.deploymentSpec.versionReleaseSystem` parameter to
579
572
``LTS``.
580
- - |service| deploys a {+cluster+} that runs MongoDB 6 .0.
573
+ - |service| deploys a {+cluster+} that runs MongoDB 7 .0.
581
574
582
575
* - You set the
583
576
:setting:`spec.deploymentSpec.providerSettings.instanceSizeName`
584
577
parameter to ``M0``, ``M2``, or ``M5``.
585
- - You must deploy MongoDB 6 .0.
578
+ - You must deploy MongoDB 7 .0.
586
579
587
580
* - You specify this parameter.
588
581
- |service| always deploys the {+cluster+} with the latest
@@ -599,24 +592,21 @@ documentation to customize your specifications.
599
592
600
593
*Conditional*
601
594
602
- Configuration that enables continuous cloud backup. To enable
603
- continuous cloud backup, you must specify this setting with a value
604
- of ``true``.
595
+ Configuration that enables continuous cloud backup. To enable continuous
596
+ cloud backup, you must specify ``true`` for this setting.
605
597
606
598
.. setting:: spec.deploymentSpec.providerSettings
607
599
608
600
*Type*: Object
609
601
610
602
*Conditional*
611
603
612
- Configuration that specifies the settings for the provisioned hosts
613
- on which MongoDB runs. The available options are specific to the
614
- cloud service provider. To learn more, see the :ref:`AWS
615
- <amazon-aws>`, :ref:`GCP <google-gcp>`, and :ref:`Azure
616
- <microsoft-azure>` {+cluster+} configuration options.
604
+ Configuration that specifies the settings for the provisioned hosts on
605
+ which MongoDB runs. The available options are specific to the cloud service
606
+ provider. To learn more, see the :ref:`AWS <amazon-aws>`, :ref:`GCP <google-gcp>`,
607
+ and :ref:`Azure <microsoft-azure>` {+cluster+} configuration options.
617
608
618
- If you want to create or update a {+cluster+}, you must
619
- specify this setting.
609
+ If you want to create or update a {+cluster+}, you must specify this setting.
620
610
621
611
.. setting:: spec.deploymentSpec.providerSettings.providerName
622
612
@@ -643,11 +633,11 @@ documentation to customize your specifications.
643
633
644
634
*Required*
645
635
646
- |service| provides different {+cluster+} tiers, each with a default
647
- storage capacity and RAM size. The {+cluster+} you select is
648
- used for all the data-bearing servers in your {+cluster+}. To learn
649
- more, see the :ref:`AWS <amazon-aws>`, :ref:`GCP <google-gcp>`, and
650
- :ref:`Azure <microsoft-azure>` custom storage sizes.
636
+ |service| provides different {+cluster+} tiers, each with a default storage
637
+ capacity and RAM size. The {+cluster+} you select is used for all the
638
+ data-bearing servers in your {+cluster+}. To learn more, see the
639
+ :ref:`AWS <amazon-aws>`, :ref:`GCP <google-gcp>`, and :ref:`Azure <microsoft-azure>`
640
+ custom storage sizes.
651
641
652
642
If you change the instance size name after you deploy your
653
643
{+cluster+}, |service| changes the {+database-deployment+} to the
0 commit comments