You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can automate the management, provisioning, and configuration of
35
39
|service| building blocks like database users and roles, |service|
36
40
{+clusters+}, projects and organizations. Additionally, you can automate
37
41
setting up and managing of additional {+clusters+} resources, including
38
-
enabling auto-scaling and disk scaling, creating and updating
42
+
enabling auto-scaling compute and storage, creating and updating
39
43
multi-cloud {+clusters+}, monitoring {+cluster+} performance and health,
40
44
automating backups and restores, defining backup policies, and many more.
41
45
@@ -46,17 +50,18 @@ deploy and manage |service| at scale with repeatable, accurate, and
46
50
scalable processes.
47
51
48
52
{+atlas-admin-api+}
49
-
~~~~~~~~~~~~~~~~~~~~~~~~
53
+
`````````````````````````````
50
54
51
55
The {+atlas-admin-api+} provides a |rest|\ful interface that allows you
52
56
to leverage your preferred client such as cURL or Postman to
53
57
directly interact with |api| endpoints that correspond to |service|
54
-
resources.
58
+
resources. They can also be directly called in your favorite
59
+
programming language or bash script.
55
60
56
61
To learn more, see :ref:`atlas-admin-api-access`.
57
62
58
63
GoSDK Client
59
-
~~~~~~~~~~~~
64
+
````````````
60
65
61
66
The {+service+} Go SDK client simplifies interaction with the
62
67
{+atlas-admin-api+} by providing pre-built functions and full |api|
@@ -66,65 +71,92 @@ applications quickly and easily.
66
71
67
72
To learn more, see :ref:`Atlas Go SDK <atlas-admin-sdk>`.
68
73
74
+
.. _arch-center-iac:
75
+
69
76
Infrastructure as Code (IaC) Integrations
70
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77
+
`````````````````````````````````````````
71
78
72
79
The integrations with the following :abbr:`IaC (Infrastructure as Code)`
73
80
tools automate the deployment of |service| resources.
74
81
75
82
HashiCorp Terraform MongoDB Atlas Provider
76
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83
+
##########################################
77
84
78
85
Provisions |service| resources across cloud providers (|aws|, |azure|,
79
86
|gcp|) in the workflow of your choice. It allows you to integrate
80
87
|service| into your continuous delivery workflows with the official
81
-
plugin that is verified and tested by HashiCorp.
88
+
plugin.
82
89
83
90
Alternatively, you can use the :abbr:`CDKTF (Cloud Development Kit for
84
91
Terraform)` to deploy |service| in preferred languages such as
85
92
JavaScript, TypeScript, Python, Java, C#, and Go.
86
93
87
-
To learn more, see :ref:`getting-started-terraform` and
88
-
|service-terraform|. You can also use the Terraform examples in the
94
+
To learn more, see :ref:`getting-started-terraform` and the
95
+
`MongoDB Atlas Provider Terraform docs <https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs>`__. You can also use the Terraform examples in the
89
96
{+atlas-arch-center+} such as the :ref:`Org, Project, and
90
97
Cluster<arch-center-hierarchy>` examples to get started.
91
98
92
99
CloudFormation Resources
93
-
~~~~~~~~~~~~~~~~~~~~~~~~
100
+
########################
94
101
95
102
Resources to manage |service| include:
96
103
97
104
- :github:`JSON and YAML templates
98
-
<mongodb/mongodbatlas-cloudformation-resources>` allow you to leverage
105
+
<mongodb/mongodbatlas-cloudformation-resources/tree/master/examples>` allow you to leverage
99
106
multiple different types of |service| resources in the |aws|
you to set up an |service| environment in |aws| by using a pre-defined
103
-
CloudFormation template that creates an |service| project with a
104
-
standard, single-region, ``M10`` {+cluster+}.
105
-
- `AWS Cloud Development Kit (CDK) <https://constructs.dev/search?q=&keywords=MongoDB&offset=0>`__
108
+
- `AWS Cloud Development Kit (CDK) <https://constructs.dev/search?q=&keywords=MongoDB&offset=0&tags=mongodb-published>`__
106
109
defines infrastructure using familiar programming languages such as
107
110
JavaScript, TypeScript, Python, Java, C#, and Go.
108
111
109
112
To learn more, see `Deploy MongoDB Atlas with AWS CloudFormation <https://www.mongodb.com/developer/products/atlas/deploy-mongodb-atlas-aws-cloudformation/>`__.
110
113
111
114
{+atlas-cli+}
112
-
~~~~~~~~~~~~~
115
+
`````````````
113
116
114
117
Enables you to create, manage, and automate tasks related to |service|
115
118
resources from a unified command line tool.
116
119
117
-
To learn more, see :ref:`atlas-cli-ephemeral-cluster` and :ref:`Quick
118
-
Start <atlas-cli-quick-start>`. You can also use the {+atlas-cli+}
120
+
To learn more, see the following resources:
121
+
122
+
- :ref:`Atlas CLI <atlascli>`
123
+
- :ref:`Quick Start <atlas-cli-quick-start>`
124
+
- :ref:`atlas-cli-ephemeral-cluster`
125
+
126
+
You can also use the {+atlas-cli+}
119
127
examples in the {+atlas-arch-center+} such as the :ref:`Org, Project,
120
128
and Cluster<arch-center-hierarchy>` examples to get started.
121
129
122
130
|ak8so|
123
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
131
+
`````````````````````````
124
132
125
133
Allows you to deploy and manage |service| resources using you existing
126
134
Kubernetes tools. The Operator enables management of |service| through
127
135
custom resources applied into Kubernetes, which the Operator uses to
128
136
configure |service|.
129
137
130
138
To learn more, see :ref:`ak8so-quick-start-ref`.
139
+
140
+
Recommendations
141
+
~~~~~~~~~~~~~~~
142
+
143
+
If you already have an existing tool integrated into your deployment
144
+
workflow that you use today, we recommend that you use that tool for
145
+
automation. For example, if your developers and operations team are
146
+
used to building custom resource definitions for Kubernetes for
147
+
deployment, use the |ak8so| and Kubernetes for automation in
148
+
{+service+}.
149
+
150
+
If you don't already have an existing tool integrated into your development workflow, we recommend an :ref:`IaC tool <arch-center-iac>`
151
+
because they provide more robust options for infrastructure provisioning and state management.
152
+
If you instead call the {+atlas-admin-api+} directly or use the GoSDK, which wraps the {+atlas-admin-api+}, you might need to recreate your
153
+
infrastructure provisioning each time to match your needs across
154
+
environments.
155
+
156
+
You can also use a combination of multiple tools. For example, use IaC
157
+
tool for provisioning and state management, and leverage the {+atlas-admin-api+}, GoSDK, and {+atlas-cli+} for quick administrative
158
+
tasks that are ephemeral in nature. The {+atlas-cli+} is great for
159
+
local development as well as integration into a suite of tests as part
160
+
of your CI/CD pipeline for application development because it improves
0 commit comments