Skip to content

Commit 0715eed

Browse files
authored
(DOCSP-13246) First draft of preview docs (#4)
1 parent 62a34b6 commit 0715eed

34 files changed

+603
-259
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ epoch-time-ms = "timestamp in the number of milliseconds that have elapsed since
4444
Epoch-time = "Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
4545
epoch-time = "timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
4646
fcv = ":abbr:`FCV (Feature Compatibility Version)`"
47+
fedramp = "`FedRAMP <https://www.fedramp.gov/>`__"
4748
fqdn = ":abbr:`FQDN (fully qualified domain name)`"
4849
fts = "Atlas Search"
4950
gcp = ":abbr:`GCP (Google Cloud Platform)`"

source/getting-started.txt

Lines changed: 15 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,19 @@ Getting Started
1414
:depth: 1
1515
:class: singlecol
1616

17-
Overview
18-
--------
19-
20-
|govcloud| provides a FedRAMP Moderate-compliant |service| environment
21-
to host and manage your data in the cloud. This tutorial guides you
22-
through creating an |govcloud-short| cluster, connecting to it,
23-
inserting data, and querying data.
24-
25-
Table of Contents
26-
-----------------
27-
28-
- **Part 1:** :doc:`Create a MongoDB GovCloud Account </tutorial/create-account>`.
29-
- **Part 2:** :doc:`Deploy a Cluster </tutorial/deploy-cluster>`.
30-
- **Part 3:** :doc:`Allow Your Connection IP Address
31-
</tutorial/allow-connection-ip-address>`.
32-
- **Part 4:** :doc:`Create a Database User for Your Cluster
33-
</tutorial/create-mongodb-user-for-cluster>`.
34-
- **Part 5:** :doc:`Connect to Your Cluster </tutorial/connect-to-your-cluster>`.
35-
- **Part 6:** :doc:`Insert and View Data in Your Cluster
36-
</tutorial/insert-data-into-your-cluster>`.
37-
38-
39-
.. class:: hidden
40-
41-
.. toctree::
42-
:titlesonly:
43-
44-
/tutorial/create-account
45-
/tutorial/deploy-cluster
46-
/tutorial/allow-connection-ip-address
47-
/tutorial/create-mongodb-user-for-cluster
48-
/tutorial/connect-to-your-cluster
49-
/tutorial/insert-data-into-your-cluster
17+
|govcloud| provides an |service| environment for the U.S. government
18+
(federal agencies and state, local, and education (SLED) entities)
19+
to host and manage data in the cloud.
20+
21+
This tutorial guides you through creating a |govcloud-short| account,
22+
organization and cluster.
23+
24+
.. toctree::
25+
:titlesonly:
26+
27+
/tutorial/create-account
28+
/tutorial/create-cluster
29+
/tutorial/allow-ip
30+
/tutorial/create-mongodb-user-for-cluster
31+
/tutorial/connect-to-your-cluster
5032

source/images/cloudgov-indicator.png

8.49 KB
Loading

source/includes/admonitions/no-commercial-region.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

source/includes/admonitions/no-free-tier.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.

source/includes/admonitions/require-scram-sha256.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
|govcloud| clusters support :ref:`Cluster Auto-Scaling
2+
<cluster-autoscaling>`. When auto-scaling is enabled, |service|
3+
automatically scales your cluster tier, storage capacity, or both in
4+
response to cluster usage. Consider enabling auto-scaling to allow your
5+
cluster to adapt to your current workload and reduce the need to make
6+
manual optimizations.
7+
8+
- :ref:`Cluster storage scaling <howitworks-scale-cluster-storage>`
9+
automatically increases your cluster storage capacity when 90% of disk
10+
capacity is used. This setting is on by default to help ensure that
11+
your cluster can always support sudden influxes of data.
12+
13+
- :ref:`Cluster tier scaling <howitworks-scale-cluster-tier>`
14+
automatically scales your cluster tier up or down in response to
15+
various cluster metrics. You must manually opt-in to cluster tier
16+
scaling.
17+
18+
When you enable cluster tier scaling, you set:
19+
20+
- A maximum cluster tier to which your cluster can automatically
21+
scale up, and
22+
- *(Optional)* A minimum tier to which your cluster can scale down.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. [#data-bearing]
2+
3+
For replica sets, the data-bearing servers are the servers hosting
4+
the replica set nodes. For sharded clusters, the data-bearing
5+
servers are the servers hosting the shards. For sharded clusters,
6+
|service| also deploys servers for the
7+
:ref:`config servers <sharding-config-server>`; these are charged at
8+
a rate separate from the cluster costs.

source/includes/steps-allow-ip.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
title: "Click :guilabel:`Connect`."
2+
ref: getting-started-ip-connect
3+
stepnum: 1
4+
level: 4
5+
content: |
6+
In the :guilabel:`Clusters` view, click :guilabel:`Connect` for the
7+
cluster to which you want to connect.
8+
9+
Atlas highlights the :guilabel:`Setup connection security` step.
10+
11+
---
12+
title: "Click :guilabel:`Add Your Current IP Address`."
13+
ref: getting-started-ip-add
14+
stepnum: 2
15+
level: 4
16+
content: |
17+
To secure your |govcloud-short| cluster, limit access to specified IP addresses.
18+
19+
The menu expands to show the :guilabel:`Add a connection IP address`
20+
modal.
21+
22+
---
23+
title: "Click :guilabel:`Add IP Address`."
24+
ref: getting-started-ip-confirm
25+
stepnum: 3
26+
level: 4
27+
28+
...
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
title: "Accept the email offer to create a |govcloud| account."
2+
level: 4
3+
ref: getting-started-accept-invite
4+
stepnum: 1
5+
6+
---
7+
title: "Provide information about yourself."
8+
ref: getting-started-user-info
9+
level: 4
10+
stepnum: 2
11+
content: |
12+
13+
Provide the following information about yourself:
14+
15+
- :guilabel:`Email Address`
16+
- :guilabel:`First Name`
17+
- :guilabel:`Last Name`
18+
- :guilabel:`Password`
19+
- :guilabel:`Country`
20+
21+
---
22+
title: "Review and accept the |govcloud| :guilabel:`Privacy Policy` and
23+
the :guilabel:`Terms of Service`."
24+
ref: getting-started-tos
25+
level: 4
26+
stepnum: 3
27+
28+
---
29+
title: "Click :guilabel:`Sign Up` to create your account."
30+
ref: getting-started-sign-up
31+
level: 4
32+
stepnum: 4
33+
content: |
34+
.. important::
35+
36+
You cannot change the email address that you use to log in to your
37+
|govcloud-short| account after registering.
38+
...

0 commit comments

Comments
 (0)