Skip to content

Commit cbc3696

Browse files
authored
Adds more guidance missed from Orgs page (#27)
1 parent c55807b commit cbc3696

File tree

2 files changed

+60
-5
lines changed

2 files changed

+60
-5
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ azure = "Microsoft Azure"
4747
az-bs = "Azure Blob Storage"
4848
az-pl = "Azure Private Link"
4949
bcp = "Backup Compliance Policy"
50+
BU = ":abbr:`BU (Business Unit)`"
5051
c2c-version = "6.0.13"
5152
c2c-version-7 = "7.0.8"
5253
mdb-tools-version = "100.10.0"

source/hierarchy.txt

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ security settings and governance for your {+service+} enterprise estate:
5050
* - Organization
5151
- Invoicing aggregates and generates at the organization level.
5252
Line items go to cluster level and below. An organization often
53-
maps to a business unit (BU) or application.
53+
maps to a {+BU+} or application.
5454

5555
* - Project
5656
- Security configuration for the data plane (including database
@@ -69,6 +69,44 @@ security settings and governance for your {+service+} enterprise estate:
6969
Recommendations
7070
~~~~~~~~~~~~~~~
7171

72+
Development, Testing, Staging, and Production Environments
73+
``````````````````````````````````````````````````````````
74+
75+
We recommend that you use the following four environments to isolate
76+
your sandbox and test projects and {+clusters+} from your application
77+
projects and {+clusters+}:
78+
79+
.. list-table::
80+
:header-rows: 1
81+
:widths: 15 85
82+
83+
* - Environment
84+
- Description
85+
86+
* - Development (Dev)
87+
- Allow developers to freely try new things in a safe sandbox
88+
environment.
89+
90+
* - Testing (Test)
91+
- Test specific components or functions created in the dev
92+
environment.
93+
94+
* - Staging
95+
- Stage all components and
96+
functions together to make sure the entire application works
97+
as expected before deploying to production. Staging is similar to
98+
the test environment, but ensures that new components work well
99+
with existing components.
100+
101+
* - Production (Prod)
102+
- The back end for your application that is live for your
103+
end users.
104+
105+
For your dev and test environments, you can develop {+service+}
106+
{+clusters+} locally with the {+atlas-cli+}. To learn more, see
107+
:atlascli:`Create a Local {+service+} Deployment
108+
<atlas-cli-deploy-local>`.
109+
72110
Org and Project Hierarchies
73111
````````````````````````````
74112

@@ -78,7 +116,7 @@ Recommended Hierarchy 1: Fewer Atlas Organizations
78116
##################################################
79117

80118
Consider the following hierarchy for an example enterprise.
81-
This hierarchy, which creates fewer |service| organizations, might be useful if you have common teams and permissions across the business unit, and less than the raiseable limit of 250 projects per organization.
119+
This hierarchy, which creates fewer |service| organizations, might be useful if you have common teams and permissions across the {+BU+}, and less than the raiseable limit of 250 projects per organization.
82120

83121
**DIAGRAM TO REPLACE TEXT**
84122

@@ -93,7 +131,7 @@ This hierarchy, which creates fewer |service| organizations, might be useful if
93131
- Project: Product Mgmt App - Test
94132
- Project: Product Mgmt App - Dev
95133

96-
- Atlas Org: Corporate Products BU
134+
- Atlas Org: Corporate Products {+BU+}
97135

98136
.. _project-hierarchy-2:
99137

@@ -103,7 +141,7 @@ Recommended Hierarchy 2: More Atlas Organizations
103141
Consider the following hierarchy for a different enterprise.
104142
This hierarchy creates a relatively large number of |service|
105143
organizations: one per application or scrum team. This hierarchy might
106-
be useful if each of your teams is fairly independent, they don't share people or permissions within a business unit, or they want to buy credits themselves through the cloud provider marketplace. There is
144+
be useful if each of your teams is fairly independent, they don't share people or permissions within a {+BU+}, or they want to buy credits themselves through the cloud provider marketplace. There is
107145
no paying organization in this hierarchy.
108146

109147
**DIAGRAM TO REPLACE TEXT**
@@ -147,6 +185,22 @@ sub-organizations' databases.
147185

148186
DIAGRAM
149187

188+
{+Cluster+} Tagging
189+
```````````````````
190+
191+
We recommend that you tag {+clusters+} with the following details to
192+
enable easy data parsing for reports:
193+
194+
- {+BU+}
195+
- Team name
196+
- Application name
197+
- Environment
198+
- Version
199+
- Email contact
200+
201+
To learn more about parsing billing data using tags, see
202+
:ref:`arch-center-billing-data`.
203+
150204
.. _arch-center-cluster-size-guide:
151205

152206
{+service+} {+Cluster+} Size Guide
@@ -268,7 +322,7 @@ These examples also apply other recommended configurations, including:
268322
Create the Organizations
269323
~~~~~~~~~~~~~~~~~~~~~~~~
270324

271-
Run the following command for each business unit. Change
325+
Run the following command for each {+BU+}. Change
272326
the IDs and names to use your actual values:
273327

274328
.. code-block::

0 commit comments

Comments
 (0)