Skip to content

Commit 88f6b83

Browse files
DOCSP-44988 automation page feedback (#74)
* DM automation feedback * network security image fix
1 parent e68b0ce commit 88f6b83

File tree

6 files changed

+32
-32
lines changed

6 files changed

+32
-32
lines changed

source/automation.txt

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,19 @@ Automation
1717
.. contents:: On this page
1818
:local:
1919
:backlinks: none
20-
:depth: 2
20+
:depth: 3
2121
:class: onecol
2222

2323
|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 (such as scripts that call the
29-
{+atlas-admin-api+}), a Kubernetes-native workflow, or
30-
using Infrastructure as Code (IaC) tools like Terraform.
24+
the cloud. It includes tools that enable programmatic management of the
25+
deployment, scaling, and maintenance of your {+service+} {+clusters+} to
26+
streamline operations, reduce manual interventions, and ensure
27+
consistent, policy-compliant deployments. These tools offer you the
28+
flexibility to work with {+service+} through direct scripting (such as
29+
scripts that use the GoSDK Client or call the {+atlas-admin-api+}
30+
directly), or Infrastructure as Code (IaC) tooling that uses declarative
31+
configuration, like our Kubernetes Operator, Terraform, Cloud Formation
32+
or AWS CDK.
3133

3234
{+service+} Features and Recommendations for Automation
3335
-------------------------------------------------------
@@ -38,8 +40,7 @@ Features
3840
You can automate the management, provisioning, and configuration of
3941
|service| building blocks like database users and roles, |service|
4042
{+clusters+}, projects and organizations. Additionally, you can automate
41-
temporary access list entries that expire after a user-defined period, and
42-
setting up and managing of additional {+clusters+} resources, including
43+
setting up and managing additional {+clusters+} resources, including
4344
enabling auto-scaling compute and storage, creating and updating
4445
multi-cloud {+clusters+}, monitoring {+cluster+} performance and health,
4546
automating backups and restores, defining backup policies, and many more.
@@ -74,14 +75,8 @@ To learn more, see :ref:`Atlas Go SDK <atlas-admin-sdk>`.
7475

7576
.. _arch-center-iac:
7677

77-
Infrastructure as Code (IaC) Integrations
78-
`````````````````````````````````````````
79-
80-
The integrations with the following :abbr:`IaC (Infrastructure as Code)`
81-
tools automate the deployment of |service| resources.
82-
8378
HashiCorp Terraform MongoDB Atlas Provider
84-
##########################################
79+
``````````````````````````````````````````
8580

8681
Provisions |service| resources across cloud providers (|aws|, |azure|,
8782
|gcp|) in the workflow of your choice. It allows you to integrate
@@ -98,7 +93,7 @@ To learn more, see :ref:`getting-started-terraform` and the
9893
Cluster<arch-center-hierarchy>` examples to get started.
9994

10095
CloudFormation Resources
101-
########################
96+
````````````````````````
10297

10398
Resources to manage |service| include:
10499

@@ -115,8 +110,8 @@ To learn more, see `Deploy MongoDB Atlas with AWS CloudFormation <https://www.mo
115110
{+atlas-cli+}
116111
`````````````
117112

118-
Enables you to create, manage, and automate tasks related to |service|
119-
resources from a unified command line tool.
113+
Enables you to manually or programmatically create, manage, and automate
114+
tasks related to |service| resources from a unified command line tool.
120115

121116
To learn more, see the following resources:
122117

@@ -144,18 +139,21 @@ Recommendations
144139
If you already have an existing tool integrated into your deployment
145140
workflow that you use today, we recommend that you use that tool for
146141
automation. For example, if your developers and operations team are
147-
used to building custom resource definitions for Kubernetes for
148-
deployment, use the |ak8so| and Kubernetes for automation in
149-
{+service+}.
150-
151-
If you don't already have an existing tool integrated into your development workflow, we recommend an :ref:`IaC tool <arch-center-iac>`
152-
because they provide more robust options for infrastructure provisioning and state management.
153-
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
154-
infrastructure provisioning each time to match your needs across
155-
environments.
142+
already deploying to Kubernetes, apply {+service+} configurations through
143+
the same tooling and pipelines and use the |ak8so| to automate updating
144+
{+service+}.
145+
146+
If you don't already have an existing tool integrated into your
147+
development workflow, we recommend an :ref:`IaC tool <arch-center-iac>`
148+
because they provide more robust options for infrastructure provisioning
149+
and state management. If you instead call the {+atlas-admin-api+}
150+
directly or use the GoSDK, which wraps the {+atlas-admin-api+}, you
151+
might need to recreate your infrastructure provisioning each time to
152+
match your needs across environments.
156153

157154
You can also use a combination of multiple tools. For example, use IaC
158-
tool for provisioning and state management, and leverage the {+atlas-admin-api+}, GoSDK, and {+atlas-cli+} for quick administrative
155+
tool for provisioning and state management, and leverage the
156+
{+atlas-admin-api+}, GoSDK, and {+atlas-cli+} for quick administrative
159157
tasks that are ephemeral in nature. The {+atlas-cli+} is great for
160158
local development as well as integration into a suite of tests as part
161159
of your CI/CD pipeline for application development because it improves
-330 KB
Binary file not shown.

source/includes/images/private-link.svg

Lines changed: 1 addition & 0 deletions
Loading
-240 KB
Binary file not shown.

source/includes/images/vpc-vnet-peering.svg

Lines changed: 1 addition & 0 deletions
Loading

source/network-security.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ peer to. {+service+} limits the number of MongoDB instances per |vpc|
126126
based on the |cidr| block. For example, a project with a |cidr| block of
127127
``/24`` is limited to the equivalent of 273-node replica sets.
128128

129-
.. image:: /includes/images/vpc-vnet-peering.png
129+
.. image:: /includes/images/vpc-vnet-peering.svg
130130
:alt: "An image representing how MongoDB Atlas VPC/VNet peering works."
131131
:width: 750px
132132
:align: center
@@ -147,7 +147,7 @@ private endpoints are available:
147147
- :gcp:`Private Service Connect </vpc/docs/private-service-connect>`, for
148148
connections from {+gcp+}
149149

150-
.. image:: /includes/images/private-link.png
150+
.. image:: /includes/images/private-link.svg
151151
:alt: "An image representing how MongoDB Atlas private endpoints work."
152152
:width: 750px
153153
:align: center

0 commit comments

Comments
 (0)