Skip to content

Commit 0c7c0df

Browse files
authored
(DOCSP-17121) Finalize organization of content (#18)
* (DOCSP-17121) Finalize organization of content
1 parent 4a1529b commit 0c7c0df

29 files changed

+423
-239
lines changed

snooty.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ intersphinx = ["https://docs.mongodb.com/manual/objects.inv","https://docs.atlas
55

66
toc_landing_pages = [
77
"/tutorial/getting-started",
8-
"/security"
8+
"/security",
9+
"/clusters",
10+
"/api"
911
]
1012

1113
[constants]
@@ -17,7 +19,7 @@ see-service-docs = "See the Atlas Documentation"
1719
cloudgov = "MongoDB Atlas for Government"
1820
cloudgov-short = "AtlasGov"
1921
aws-fr-high = "AWS GovCloud"
20-
aws-fr-moderate = "AWS US East-West"
22+
aws-fr-moderate = "AWS Standard"
2123
2fa = ":abbr:`2FA (Two Factor Authentication)`"
2224
aki = ":abbr:`AKI (Azure Key Identifier)`"
2325
akv = ":abbr:`AKV (Azure Key Vault)`"

source/api.txt

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
:noprevnext:
22

3+
.. _api:
4+
35
===
46
API
57
===
@@ -9,12 +11,19 @@ API
911
.. contents:: On this page
1012
:local:
1113
:backlinks: none
12-
:depth: 2
14+
:depth: 1
1315
:class: singlecol
1416

17+
1518
The |cloudgov| |api| supports a subset of |service| |api| endpoints.
1619
Some endpoints use a different |url|.
1720

21+
{+gov-considerations+}
22+
-----------------------------------
23+
24+
- |api| users are required to use ``SHA-256`` in the |http| Digest
25+
Access Authentication.
26+
1827
.. toctree::
1928
:titlesonly:
2029

source/atlas-access.txt

Lines changed: 72 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _atlas-access:
1+
.. _cloudgov-access:
22

33
============================
44
|cloudgov-short| User Access
@@ -12,19 +12,79 @@
1212
:depth: 1
1313
:class: singlecol
1414

15-
This page covers |cloudgov| user accounts.
15+
.. note::
1616

17-
{+gov-considerations+}
17+
This page covers |cloudgov| user accounts. |cloudgov-short| users
18+
are separate from database users. Database users can access MongoDB
19+
databases, while |cloudgov-short| users can access the
20+
|cloudgov-short| application itself.
21+
22+
Create an |cloudgov-short| Account
1823
-----------------------------------
1924

20-
Account
21-
~~~~~~~
25+
|cloudgov| is available by invitation only. To create a
26+
|cloudgov-short| account, you must either:
27+
28+
- Purchase a subscription and activate an account, or
29+
30+
- Accept an invitation from an existing user in an existing
31+
organization.
32+
33+
Purchase and Activate a Subscription
34+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35+
36+
To purchase and activate a |cloudgov-short| subscription, see
37+
:ref:`billing`.
38+
39+
Accept an Invitation
40+
~~~~~~~~~~~~~~~~~~~~
41+
42+
|cloudgov-short| invitations are sent by email. To accept an invitation
43+
to an organization, follow the instructions in the |cloudgov-short|
44+
email you receive.
45+
46+
Account Limitations
47+
-------------------
48+
49+
- You cannot register for an |cloudgov-short| account through the login
50+
page or create an |cloudgov-short| account using the |api|. You must
51+
receive an activation code from MongoDB Sales or be invited to an
52+
existing organization.
53+
54+
- You cannot use Google SSO credentials to sign up or log in.
55+
56+
Account Security
57+
----------------
58+
59+
Passwords
60+
~~~~~~~~~
61+
62+
- |cloudgov-short| passwords expire after 60 days.
63+
64+
- You can only change your password once each day.
2265

2366
- When you change your password, you cannot use any of your previous 24
2467
passwords.
2568

26-
- If your account is suspended due to inactivity, reset your password
27-
to unsuspend your account.
69+
- |cloudgov-short| requires that passwords contain:
70+
71+
- At least 15 characters,
72+
- An upper case letter,
73+
- A lower case letter,
74+
- A number, and
75+
- A special character.
76+
77+
Account
78+
~~~~~~~
79+
80+
- After 3 failed login attempts your account is locked for 30 minutes,
81+
preventing further login attempts. You can contact support to unlock
82+
your account.
83+
84+
- Your |cloudgov-short| account is considered inactive and suspended if
85+
you do not log in for 90 consecutive days. If your account is
86+
suspended due to inactivity, reset your password to unsuspend your
87+
account.
2888

2989
User Sessions
3090
~~~~~~~~~~~~~
@@ -33,13 +93,9 @@ User Sessions
3393
inactivity, requiring you to log in again. You are prompted to
3494
continue your current session after 10 minutes of inactivity.
3595

36-
Monitoring and Logging
37-
~~~~~~~~~~~~~~~~~~~~~~
38-
39-
- You must have the :authrole:`Project Owner` role to
40-
configure an integration.
96+
Organizations and Projects
97+
--------------------------
4198

42-
- In addition to :atlas:`standard Atlas logging </mongodb-logs/>`,
43-
|cloudgov-short| logs the username and IP address associated with all
44-
failed login attempts, temporary lockouts and failed |api| digest
45-
authentications.
99+
See the |service| documentation to learn more about using
100+
:atlas:`Organizations and Projects </organizations-projects/#organizations-and-projects>`
101+
to manage |cloudgov-short| user access.

source/atlas-search.txt

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

source/billing.txt

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,42 @@
11
.. _billing:
22

3-
=======
4-
Billing
5-
=======
3+
=========================
4+
Subscriptions and Billing
5+
=========================
66

77
.. default-domain:: mongodb
88

99
.. contents:: On this page
1010
:local:
1111
:backlinks: none
12-
:depth: 2
12+
:depth: 1
1313
:class: singlecol
1414

15+
You must purchase a subscription to pay for |cloudgov|.
16+
17+
Purchase a Subscription
18+
-----------------------
19+
1520
You can purchase a |cloudgov| subscription from the following
1621
sources:
1722

18-
- The AWS marketplace
23+
- The |aws| Marketplace
1924

2025
- :website:`MongoDB Sales </contact/atlas>`
2126

27+
Activate Your Subscription
28+
--------------------------
29+
30+
Activate your subscription by accepting the email invitation sent to
31+
you by the |aws| Marketplace or MongoDB Sales.
32+
33+
When you accept an invitation to register for a new account, your
34+
activation code is applied to the first organization you create.
35+
2236
Limitations
2337
-----------
2438

25-
You cannot use a credit card or PayPal to pay for |cloudgov-short|.
39+
- Elastic invoicing is not available.
40+
41+
- You cannot use a credit card or PayPal to pay for |cloudgov-short|.
42+
Credit card alerts are disabled.
Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _intro-purchase-subscription:
1+
.. _subscriptions:
22

3-
==========================================
4-
Purchase a |cloudgov-short| Subscription
5-
==========================================
3+
=========================
4+
Subscriptions and Billing
5+
=========================
66

77
.. default-domain:: mongodb
88

@@ -12,6 +12,12 @@ Purchase a |cloudgov-short| Subscription
1212
:depth: 1
1313
:class: singlecol
1414

15+
You must purchase a subscription to use |cloudgov|. Elastic invoicing
16+
is not available.
17+
18+
Purchase a Subscription
19+
-----------------------
20+
1521
You can purchase a |cloudgov| subscription from the following
1622
sources:
1723

@@ -22,7 +28,8 @@ sources:
2228
Activate Your Subscription
2329
--------------------------
2430

25-
Placeholder for procedure.
31+
Activate your subscription using the activation code you receive after
32+
purchase.
2633

2734
To learn more about |cloudgov-short| subscriptions, see
2835
:ref:`billing`.

source/clusters.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. _clusters:
2+
3+
========
4+
Clusters
5+
========
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Clusters are |cloudgov|\-managed MongoDB deployments. A cluster can be
16+
either a :term:`replica set` or a :term:`sharded cluster`.
17+
18+
{+gov-considerations+}
19+
-----------------------------------
20+
21+
- When you create a project, you may designate it as a government
22+
region-only project. If you do not, that project is a standard
23+
region-only project. You may only deploy clusters to the type of
24+
region that your project supports.
25+
26+
- You may only create clusters tier ``M20`` and above. Free and shared
27+
tier clusters are not available.
28+
29+
See the |service| documentation to
30+
:atlas:`Configure Clusters </cluster-configuration/>`.
31+
32+
.. toctree::
33+
:titlesonly:
34+
35+
/clusters/monitoring
36+
/clusters/backup-restore-data
Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _backup-restore:
2+
13
===============================
24
Backup and Restore Cluster Data
35
===============================
@@ -14,24 +16,21 @@ Backups are copies of your data that encapsulate the state of your
1416
cluster at a given time. Backups provide a safety measure in the
1517
event of data loss.
1618

17-
.. note::
19+
You must have the :authrole:`Project Owner` role for an
20+
|cloudgov-short| project to manage backups for or to restore a
21+
backup to clusters in that project.
1822

19-
You must have the :authrole:`Project Owner` role for an
20-
|cloudgov-short| project to manage backups for or to restore a
21-
backup to clusters in that project.
23+
.. tip::
2224

23-
{+gov-considerations+}
24-
-----------------------------------
25+
|cloudgov-short| user roles are the same as
26+
:atlas:`Atlas User Roles </reference/user-roles/>`.
2527

26-
Commercial and government cloud provider backups are not compatible
27-
with each other. If you create a backup from a government region-only
28+
Standard and government cloud provider backups are not compatible
29+
with one another. If you create a backup from a government region-only
2830
project, you may only restore that data to a government region-only
29-
project. The same is true for commercial region-only projects.
31+
project. The same is true for standard region-only projects.
3032

3133
For a list of regions by cloud provider, see :ref:`<supported-regions>`.
3234

33-
{+see-service-docs+}
34-
---------------------------
35-
3635
See the |service| documentation to configure
37-
:atlas:`Cloud Backups </backup/cloud-backup/overview/>`.
36+
:atlas:`Cloud Backups </backup/cloud-backup/overview/>`

source/clusters/monitoring.txt

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
.. _monitoring:
2+
3+
==============================
4+
Monitoring, Logging and Alerts
5+
==============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Monitoring
16+
----------
17+
18+
You must have the :authrole:`Project Owner` role to
19+
configure a third-party monitoring integration.
20+
21+
.. tip::
22+
23+
|cloudgov-short| user roles are the same as
24+
:atlas:`Atlas User Roles </reference/user-roles/>`.
25+
26+
See the |service| documentation to
27+
:atlas:`Integrate with Third-Party Monitoring Services </tutorial/third-party-service-integrations/>`
28+
29+
Logging
30+
-------
31+
32+
In addition to the standard Atlas logging,
33+
|cloudgov-short| logs the username and IP address associated with all
34+
failed login attempts, temporary lockouts and failed |api| digest
35+
authentications.
36+
37+
See the |service| documentation to
38+
:atlas:`View and Download MongoDB Logs </mongodb-logs/>`
39+
40+
Alerts and Communications
41+
-------------------------
42+
43+
You receive emails from a different MongoDB account depending on the
44+
region to which your resources are deployed and the type of
45+
communication.
46+
47+
|aws-fr-moderate|
48+
~~~~~~~~~~~~~~~~~
49+
50+
- Alerts come from ``[email protected]``.
51+
- All other emails come from ``[email protected]``.
52+
53+
|aws-fr-high|
54+
~~~~~~~~~~~~~
55+
56+
- Alerts come from ``[email protected]``.
57+
- All other emails come from ``[email protected]``.
58+
59+
See the |service| documentation to
60+
:atlas:`Configure and Resolve Alerts </alerts/>`

0 commit comments

Comments
 (0)