Skip to content

Commit 3400540

Browse files
authored
(DOCSP-12930) Clarify that Atlas orgs are not supported (#416)
* (DOCSP-12930) Clarify that Atlas orgs are not supported * (DOCSP-12930) Clarify that Atlas orgs are not supported. Included comments from JW. * (DOCSP-12930) Adding information that Atlas orgs are not supported. Also included round 2 of JW's comments: created a new note, reused it, updated info for how to find orgId * (DOCSP-12930) Included third round of JW's comments. Clarify that Atlas orgs are not supported.
1 parent f795e0d commit 3400540

12 files changed

+79
-55
lines changed

source/includes/admonitions/note-k8s-supported-in-om4.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.. admonition:: Cloud Manager and |onprem| 4.0.11 Support MongoDB Resources
2-
:class: note
1+
.. important::
2+
3+
- You can use the |k8s-op-short| to deploy MongoDB resources with
4+
|onprem| version 4.0.11 or later and Cloud Manager.
5+
6+
- You can't use the |k8s-op-short| to deploy MongoDB resources to
7+
|service|.
38

4-
You can use the |k8s-op-short| to deploy MongoDB resources with
5-
|onprem| version 4.0.11 or later and Cloud Manager. At any place in
6-
this guide that says *Ops Manager*, you can substitute
7-
*Cloud Manager*.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. note::
2+
3+
At any place on this page that says *Ops Manager*, you can substitute *Cloud Manager*.

source/includes/list-tables/configmap-keys-curl.rst

Lines changed: 24 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,27 @@
4545

4646
The |k8s-op-short| creates the |mms| project if it does
4747
not exist. If you omit the ``projectName``, the |k8s-op-short|
48-
creates a project with the same name as your |k8s| resource.
48+
creates a project with the same name as your
49+
|k8s| resource.
4950

50-
If you need or want to use an existing project, you can find
51+
To use an existing project in a |com|
52+
organization, locate
5153
the ``projectName`` by clicking the :guilabel:`All Clusters`
52-
link at the top left of the screen, then either search by
53-
name in the :guilabel:`Search` box or scroll to find the
54-
name in the list. Each card in this list represents the
55-
combination of one **Organization** and **Project**.
54+
link at the top left of the |com| page, and
55+
searching by name in the :guilabel:`Search`
56+
box, or scrolling to find the name in the list.
57+
Each card in this list represents the
58+
combination of one |com| **Organization** and **Project**.
5659

5760
- ``Development``
5861

5962
* - ``orgId``
6063
- string
61-
- 24 character hex string that uniquely identifies your
62-
MongoDB :opsmgr:`Organization </tutorial/manage-organizations>`.
64+
- 24 character hex string that uniquely
65+
identifies your
66+
|com| :opsmgr:`Organization </tutorial/manage-organizations>`.
67+
68+
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
6369

6470
Depending on your |k8s-op-short| :ref:`credentials
6571
<create-k8s-credentials>`, this field is:
@@ -75,47 +81,28 @@
7581
You must specify an :ref:`existing Organization
7682
<create-organization>`.
7783

78-
To find the ``orgId`` of your Organization:
79-
80-
1. Click the :guilabel:`Context` menu.
81-
2. Select your Organization.
82-
3. View the current |url| in your browser and copy the
83-
value displayed in the ``<orgId>`` placeholder below:
84-
85-
| ``https://ops.example.com:8443/``
86-
| ``v2#/org/<orgId>/projects``
84+
.. include:: /includes/steps/find-org-id.rst
8785

8886
.. tab:: Organization API Keys
8987
:tabid: org
9088

91-
If specified, the |k8s-op-short| links to the Organization.
89+
If specified, the |k8s-op-short| links to the organization.
9290

93-
You can find the Organization's ``orgId`` in your |onprem|
94-
|url|:
95-
96-
1. Click the :guilabel:`Context` menu.
97-
2. Select your Organization.
98-
3. View the current |url| in your browser and copy the
99-
value displayed in the ``<orgId>`` placeholder below:
91+
To find the ``orgID`` of your organization:
10092

101-
| ``https://ops.example.com:8443/``
102-
| ``v2#/org/<orgId>/projects``
93+
.. include:: /includes/steps/find-org-id.rst
10394

104-
If omitted, |onprem| creates an Organization called
95+
If omitted, |onprem| creates an organization called
10596
``projectName`` that contains a project also called
10697
``projectName``.
107-
98+
10899
You must have the :authrole:`Organization Project Creator`
109100
role to create a new project within an existing
110-
organization.
111-
112-
.. admonition:: Limited to |com| Organizations
113-
:class: important
101+
|com| organization.
102+
103+
- ``5cc9b333dde384a625a6615``
104+
114105

115-
This value must be a |com|
116-
organization. The |k8s-op-short| might not work as
117-
expected when set to an |service| organization.
118106

119-
- | ``5cc9b333dd3e384a625a6615``
120107

121108

source/includes/list-tables/configmap-keys.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,8 @@
7474
role to create a new project
7575
*within an existing organization*.
7676

77-
.. admonition:: Limited to |com| Organizations
77+
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
7878

79-
If you set this value, it can be for a |com|
80-
organization only. If you try to use an Atlas
81-
organization, the |k8s-op-short| may not work as
82-
intended.
8379

8480
- | ``5cc9b333dd3e384a625a6615``
8581

source/includes/steps-deploy-k8s-standalone.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,6 @@ content: |
8080
8181
.. include:: /includes/admonitions/note-namespace-match-configmap.rst
8282
83-
.. include:: /includes/admonitions/fact-k8s-operator-manages-configmap.rst
84-
8583
- ``<myproject>``
8684
8785
* - :setting:`spec.credentials`
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Find the organization's ID."
3+
ref: find-org-id
4+
stepnum: 1
5+
level: 4
6+
content: |
7+
8+
Do one of the following:
9+
10+
a. If you are using |mms| 4.4 or later or
11+
|cloud-short|, click
12+
:guilabel:`Settings` in the left navigation bar.
13+
14+
b. If you are using |mms| 4.2 or earlier, click the
15+
:guilabel:`Context` menu.
16+
17+
---
18+
19+
title: "Copy and paste the orgId into the URL."
20+
ref: paste-id-in-url
21+
stepnum: 2
22+
level: 4
23+
content: |
24+
25+
Select your organization, view the current |url|
26+
in your browser and copy the value displayed in
27+
the ``<orgId>`` placeholder as follows:
28+
29+
``https://ops.example.com:8443/``
30+
``v2#/org/<orgId>/projects``
31+
32+
...

source/reference/k8s-op-exclusive-settings.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ MongoDB |k8s-op-short| Exclusive Settings
1212
:depth: 2
1313
:class: singlecols
1414

15-
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
15+
.. include:: /includes/admonitions/note-substitute-opsm-with-cloudm.rst
1616

1717
Kubernetes Operator Overrides Some Ops Manager Settings
1818
-------------------------------------------------------

source/reference/k8s-operator-specification.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ MongoDB Database Resource Specification
1414
:depth: 2
1515
:class: singlecols
1616

17-
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
17+
.. include:: /includes/admonitions/note-substitute-opsm-with-cloudm.rst
1818

1919
The :gh:`MongoDB Enterprise Kubernetes Operator </mongodb/mongodb-enterprise-kubernetes>`
2020
creates |k8s| |k8s-statefulsets| from specification files that you

source/tutorial/create-project-using-configmap.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ the ConfigMap.
2323
Considerations
2424
--------------
2525

26-
Starting in |k8s-op-full| version 1.3.0, you can only have one MongoDB
27-
resource per project. To learn how to deploy a MongoDB resource
28-
in your project, see :ref:`k8s-deploy-mdb-resources`.
26+
Starting in |k8s-op-full| version 1.3.0, you can only deploy one
27+
MongoDB resource per project. See :ref:`k8s-deploy-mdb-resources`.
28+
29+
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
2930

3031
Prerequisites
3132
-------------

source/tutorial/deploy-replica-set.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Deploy a Replica Set
1414
:depth: 1
1515
:class: singlecol
1616

17+
.. include:: /includes/admonitions/note-substitute-opsm-with-cloudm.rst
18+
1719
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
1820

1921
A :term:`replica set` is a group of MongoDB deployments that maintain

source/tutorial/deploy-sharded-cluster.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Deploy a Sharded Cluster
1414

1515
.. include:: /includes/styles/corrections.rst
1616

17+
.. include:: /includes/admonitions/note-substitute-opsm-with-cloudm.rst
18+
1719
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
1820

1921
:term:`Sharded clusters <sharded cluster>` provide horizontal scaling

source/tutorial/deploy-standalone.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Deploy a Standalone MongoDB Instance
1414

1515
.. include:: /includes/styles/corrections.rst
1616

17+
.. include:: /includes/admonitions/note-substitute-opsm-with-cloudm.rst
18+
1719
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
1820

1921
You can deploy a :term:`standalone` MongoDB instance for |mms| to

0 commit comments

Comments
 (0)