Skip to content

Commit eb0fcf8

Browse files
zach-carrzach-carr
authored
(DOCSP-17184) Review feedback (#21)
* Feedback, single-source emails * Remove email table * Start API * Clarify VPC peering and privatelink
1 parent cfb98f0 commit eb0fcf8

File tree

9 files changed

+83
-49
lines changed

9 files changed

+83
-49
lines changed

‎README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ the following command:
1414

1515
.. code-block:: sh
1616
17-
git clone https://github.com/10gen/govcloud-docs.git
18-
cd govcloud-docs/
17+
git clone https://github.com/10gen/cloudgov-docs.git
18+
cd cloudgov-docs/
1919
make build
2020
2121
View ``build/master/html/index.html`` to view your current build of the

‎source/api.txt

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,55 @@ API
1414
:depth: 1
1515
:class: singlecol
1616

17-
18-
The |cloudgov| |api| supports a subset of |service| |api| endpoints.
19-
Some endpoints use a different |url|.
17+
The |cloudgov| |api| functions in the same way as the |service| |api|.
18+
To learn more about using the |api|, see the
19+
:atlas:`Atlas API </api/>` documentation.
2020

2121
{+gov-considerations+}
2222
-----------------------------------
2323

24-
- |api| users are required to use ``SHA-256`` in the |http| Digest
25-
Access Authentication.
24+
Many of the commercial |service| |api| resources are limited or
25+
unavailable.
26+
27+
You must authenticate |api| requests with ``SHA-256`` in the
28+
|http| Digest Access Authentication.
29+
30+
Security
31+
~~~~~~~~
32+
33+
- You cannot create |cloudgov-short| users.
34+
35+
- |api| keys generated in standard region-only projects cannot be used
36+
to make requests to government region-only projects.
37+
38+
Features
39+
~~~~~~~~
40+
41+
The following MongoDB products and features are unavailable:
42+
43+
- Cloud Manager
44+
45+
- Charts
46+
47+
- Realm
48+
49+
- Atlas Data Lake
50+
51+
- Online Archives
52+
53+
- Atlas Triggers
54+
55+
Configuration Options
56+
~~~~~~~~~~~~~~~~~~~~~
57+
58+
- Free, shared, and ``M10`` clusters unavailable.
59+
60+
- The |azure| and |gcp| cloud providers are unavailable.
61+
62+
Alerts
63+
~~~~~~~
64+
65+
- Alerts related to payment methods are not available.
2666

2767
.. toctree::
2868
:titlesonly:

‎source/api/configure.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ Configure |cloudgov-short| API Access
1010
:depth: 1
1111
:class: singlecol
1212

13-
Placeholder for configuration page.
13+
See the |service| documentation to
14+
:atlas:`Configure API Access </configure-api-access/>`.

‎source/clusters/monitoring.txt

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,7 @@ You receive emails from a different MongoDB account depending on the
4444
region to which your resources are deployed and the type of
4545
communication.
4646

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]``.
47+
.. include:: /includes/facts/mongodb-email-addresses.rst
5848

5949
See the |service| documentation to
6050
:atlas:`Configure and Resolve Alerts </alerts/>`

‎source/getting-started.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:noprevnext:
22

3-
.. _govcloud-getting-started:
3+
.. _cloudgov-getting-started:
44

55
===============
66
Getting Started

‎source/includes/facts/mongodb-email-addresses.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
|aws-fr-high|
2+
~~~~~~~~~~~~~
3+
4+
- Alerts come from ``[email protected]``.
5+
- All other emails come from ``[email protected]``.
6+
7+
|aws-fr-moderate|
8+
~~~~~~~~~~~~~~~~~
9+
10+
- Alerts come from ``[email protected]``.
11+
- All other emails come from ``[email protected]``.

‎source/overview/atlasgov-considerations.txt

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -102,17 +102,7 @@ You receive emails from a different MongoDB account depending on the
102102
region to which your resources are deployed and the type of
103103
communication.
104104

105-
|aws-fr-moderate|
106-
~~~~~~~~~~~~~~~~~
107-
108-
- Alerts come from ``[email protected]``.
109-
- All other emails come from ``[email protected]``.
110-
111-
|aws-fr-high|
112-
~~~~~~~~~~~~~
113-
114-
- Alerts come from ``[email protected]``.
115-
- All other emails come from ``[email protected]``.
105+
.. include:: /includes/facts/mongodb-email-addresses.rst
116106

117107
Support
118108
-------

‎source/overview/supported-regions.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,6 @@ Supported Cloud Providers and Regions
1414

1515
.. include:: /includes/considerations/gov-commercial-regions.rst
1616

17-
AWS Standard
18-
------------
19-
20-
You can deploy an |cloudgov-short| cluster in the following
21-
|aws| |fedramp| Moderate standard regions:
22-
23-
- Northern Virginia (``us-east-1``)
24-
25-
- Ohio (``us-east-2``)
26-
27-
- Northern California (``us-west-1``)
28-
29-
- Oregon (``us-west-2``)
30-
3117
AWS GovCloud
3218
------------
3319

@@ -42,6 +28,20 @@ regions:
4228

4329
- Eastern US (``us-gov-east-1``)
4430

31+
AWS Standard
32+
------------
33+
34+
You can deploy an |cloudgov-short| cluster in the following
35+
|aws| |fedramp| Moderate standard regions:
36+
37+
- Northern Virginia (``us-east-1``)
38+
39+
- Ohio (``us-east-2``)
40+
41+
- Northern California (``us-west-1``)
42+
43+
- Oregon (``us-west-2``)
44+
4545
.. seealso:: |service| documentation
4646

4747
Learn more about :atlas:`Cloud Providers and Regions </cloud-providers-regions>`

‎source/security.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,9 @@ See the |service| documentation to configure
5151
|vpc| Peering
5252
~~~~~~~~~~~~~~
5353

54-
- You may only peer government regions with other government regions.
55-
You may only peer standard regions with other standard regions.
54+
- You may only peer |aws-fr-high| regions with other |aws-fr-high|
55+
regions. You may only peer |aws-fr-moderate| regions with other
56+
|aws-fr-moderate| regions.
5657

5758
- |aws| is the only supported cloud provider.
5859

@@ -62,8 +63,9 @@ See the |service| documentation to
6263
Private Endpoints
6364
~~~~~~~~~~~~~~~~~
6465

65-
- You may only link government regions with other government regions.
66-
You may only link standard regions with other standard regions.
66+
- You may only link |aws-fr-high| regions with other |aws-fr-high|
67+
regions. You may only link |aws-fr-moderate| regions with other
68+
|aws-fr-moderate| regions.
6769

6870
- |aws| is the only supported cloud provider for |cloudgov-short|.
6971

0 commit comments

Comments
 (0)