Skip to content

Commit 39f38a3

Browse files
kanchana-mongodbsarahsimpers
kanchana-mongodb
and
sarahsimpers
authored
DOCSP-43339 doc for Automation (#14)
* DOCSP-43339 doc for Automation * Apply suggestions from code review Co-authored-by: Sarah Simpers <[email protected]> * DOCSP-43339 updates for SS' feedback --------- Co-authored-by: Sarah Simpers <[email protected]>
1 parent 1e71a1b commit 39f38a3

File tree

2 files changed

+114
-36
lines changed

2 files changed

+114
-36
lines changed

‎snooty.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ intersphinx = [ "https://www.mongodb.com/docs/master/objects.inv",
1818
"https://www.mongodb.com/docs/languages/scala/scala-driver/current/objects.inv",
1919
"https://www.mongodb.com/docs/ruby-driver/current/objects.inv",
2020
"https://www.mongodb.com/docs/atlas/cli/current/objects.inv",
21-
"https://www.mongodb.com/docs/atlas/objects.inv"
21+
"https://www.mongodb.com/docs/atlas/objects.inv",
22+
"https://www.mongodb.com/docs/atlas/operator/current/objects.inv"
2223
]
2324

2425
# toc_landing_pages = ["/paths/to/pages/that/have/nested/content"]

‎source/automation.txt

Lines changed: 112 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,125 @@ Automation
66

77
.. default-domain:: mongodb
88

9+
.. facet::
10+
:name: genre
11+
:values: reference
12+
13+
.. meta::
14+
:keywords: atlas architecture center
15+
:description: Learn about the different Atlas tools to automate the provisioning and management of Atlas clusters and projects.
16+
917
.. contents:: On this page
1018
:local:
1119
:backlinks: none
1220
:depth: 1
1321
:class: onecol
1422

15-
Intro statement
23+
|service-fullname| provides an easy way to host and manage your data in
24+
the cloud. It includes tools that automate the deployment, scaling, and
25+
maintenance of your {+service+} {+clusters+} to streamline operations,
26+
reduce manual interventions, and ensure consistent, policy-compliant
27+
deployments. These tools offer you the flexibility to work with
28+
|service| through direct scripting, a Kubernetes-native workflow, or
29+
using Infrastructure as Code (IaC) resources.
1630

1731
{+service+} Features and Best Practices for Automation
1832
------------------------------------------------------
1933

20-
Content here
21-
22-
Examples
23-
--------
24-
25-
The following examples <perform this action> using |service|
26-
:ref:`tools for automation <arch-center-automation>`.
27-
28-
These examples also apply other recommended configurations, including:
29-
30-
.. tabs::
31-
32-
.. tab:: Dev and Test Environments
33-
:tabid: devtest
34-
35-
.. include:: /includes/shared-settings-clusters-devtest.rst
36-
37-
.. tab:: Staging and Prod Environments
38-
:tabid: stagingprod
39-
40-
.. include:: /includes/shared-settings-clusters-stagingprod.rst
41-
42-
.. tabs::
43-
44-
.. tab:: CLI
45-
:tabid: cli
46-
47-
Content here
48-
49-
.. tab:: Terraform
50-
:tabid: Terraform
51-
52-
Content here
53-
34+
You can automate the management, provisioning, and configuration of
35+
|service| building blocks like database users and roles, |service|
36+
{+clusters+}, projects and organizations. Additionally, you can automate
37+
setting up and managing of additional {+clusters+} resources, including
38+
enabling auto-scaling and disk scaling, creating and updating
39+
multi-cloud {+clusters+}, monitoring {+cluster+} performance and health,
40+
automating backups and restores, defining backup policies, and many more.
41+
42+
You can align your choice of tools with your preferred workflow to
43+
ensure seamless integration of |service-fullname| into your existing
44+
processes. The following |service-fullname| tools allow you to easily
45+
deploy and manage |service| at scale with repeatable, accurate, and
46+
scalable processes.
47+
48+
{+atlas-admin-api+}
49+
~~~~~~~~~~~~~~~~~~~~~~~~
50+
51+
The {+atlas-admin-api+} provides a |rest|\ful interface that allows you
52+
to leverage your preferred client such as cURL or Postman to
53+
directly interact with |api| endpoints that correspond to |service|
54+
resources.
55+
56+
To learn more, see :ref:`atlas-admin-api-access`.
57+
58+
GoSDK Client
59+
~~~~~~~~~~~~
60+
61+
The {+service+} Go SDK client simplifies interaction with the
62+
{+atlas-admin-api+} by providing pre-built functions and full |api|
63+
endpoint coverage. The SDK provides platform-specific and GoLang
64+
language-specific tools, libraries, and documentation to help build
65+
applications quickly and easily.
66+
67+
To learn more, see :ref:`Atlas Go SDK <atlas-admin-sdk>`.
68+
69+
Infrastructure as Code (IaC) Integrations
70+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71+
72+
The integrations with the following :abbr:`IaC (Infrastructure as Code)`
73+
tools automate the deployment of |service| resources.
74+
75+
HashiCorp Terraform MongoDB Atlas Provider
76+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77+
78+
Provisions |service| resources across cloud providers (|aws|, |azure|,
79+
|gcp|) in the workflow of your choice. It allows you to integrate
80+
|service| into your continuous delivery workflows with the official
81+
plugin that is verified and tested by HashiCorp.
82+
83+
Alternatively, you can use the :abbr:`CDKTF (Cloud Development Kit for
84+
Terraform)` to deploy |service| in preferred languages such as
85+
JavaScript, TypeScript, Python, Java, C#, and Go.
86+
87+
To learn more, see :ref:`getting-started-terraform` and
88+
|service-terraform|. You can also use the Terraform examples in the
89+
{+atlas-arch-center+} such as the :ref:`Org, Project, and
90+
Cluster<arch-center-hierarchy>` examples to get started.
91+
92+
CloudFormation Resources
93+
~~~~~~~~~~~~~~~~~~~~~~~~
94+
95+
Resources to manage |service| include:
96+
97+
- :github:`JSON and YAML templates
98+
<mongodb/mongodbatlas-cloudformation-resources>` allow you to leverage
99+
multiple different types of |service| resources in the |aws|
100+
CloudFormation Public Registry.
101+
- `AWS Partner Solutions <https://aws.amazon.com/solutions/>`__ enable
102+
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>`__
106+
defines infrastructure using familiar programming languages such as
107+
JavaScript, TypeScript, Python, Java, C#, and Go.
108+
109+
To learn more, see `Deploy MongoDB Atlas with AWS CloudFormation <https://www.mongodb.com/developer/products/atlas/deploy-mongodb-atlas-aws-cloudformation/>`__.
110+
111+
{+atlas-cli+}
112+
~~~~~~~~~~~~~
113+
114+
Enables you to create, manage, and automate tasks related to |service|
115+
resources from a unified command line tool.
116+
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+}
119+
examples in the {+atlas-arch-center+} such as the :ref:`Org, Project,
120+
and Cluster<arch-center-hierarchy>` examples to get started.
121+
122+
|ak8so|
123+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
124+
125+
Allows you to deploy and manage |service| resources using you existing
126+
Kubernetes tools. The Operator enables management of |service| through
127+
custom resources applied into Kubernetes, which the Operator uses to
128+
configure |service|.
129+
130+
To learn more, see :ref:`ak8so-quick-start-ref`.

0 commit comments

Comments
 (0)