Skip to content

Commit 7d90a44

Browse files
(DOCSP-12580): Global API Keys require OrgID in project ConfigMap
1 parent c11491f commit 7d90a44

File tree

3 files changed

+55
-27
lines changed

3 files changed

+55
-27
lines changed

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

Lines changed: 51 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
.. list-table::
2-
:widths: 20 20 40 20
2+
:widths: 20 10 50 20
33
:header-rows: 1
44

55
* - Key
66
- Type
77
- Description
88
- Example
99

10-
* - ``<configmap-name>``
10+
* - ``configmap-name``
1111
- string
1212
- Name of the |k8s| |k8s-obj|.
1313

@@ -19,7 +19,7 @@
1919
- |k8s| documentation on `names <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>`__.
2020
This name must follow :rfc:`RFC1123 <1123>` naming
2121
conventions, using only lowercase alphanumeric
22-
characters, '-' or '.', and must start and end with an
22+
characters, ``-`` or ``.``, and must start and end with an
2323
alphanumeric character.
2424

2525
- ``myconfigmap``
@@ -60,32 +60,61 @@
6060
- string
6161
- 24 character hex string that uniquely identifies your
6262
MongoDB :opsmgr:`Organization </tutorial/manage-organizations>`.
63-
You can find the ``orgId`` in your |onprem| |url|:
6463

65-
1. Click the :guilabel:`Context` menu.
66-
2. Select your Organization.
67-
3. View the current |url| in your browser and copy the value
68-
displayed in the ``<orgId>`` placeholder below:
64+
Depending on your |k8s-op-short| :ref:`credentials
65+
<create-k8s-credentials>`, this field is:
6966

70-
| ``https://ops.example.com:8443/``
71-
| ``v2#/org/<orgId>/projects``
67+
- *Required* for :opsmgr:`Global Programmatic API Keys </reference/api/global-api-keys/>`.
68+
- *Optional* for :ref:`Organization Programmatic API Keys <create-org-app-api-key>`.
7269

73-
.. important::
70+
.. tabs::
71+
72+
.. tab:: Global API Keys
73+
:tabid: global
7474

75-
This field is *optional*. If you omit the ``orgId``,
76-
|onprem| creates an Organization called ``projectName``
77-
that contains a project also called ``projectName``.
75+
You must specify an :ref:`existing Organization
76+
<create-organization>`.
7877

79-
You must have the :authrole:`Organization project Creator`
80-
role to create a new project
81-
*within an existing organization*.
78+
To find the ``orgId`` of your Organization:
8279

83-
.. admonition:: Limited to |com| Organizations
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:
8484

85-
If you set this value, it can be for a |com|
86-
organization only. If you try to use an Atlas
87-
organization, the |k8s-op-short| may not work as
88-
intended.
85+
| ``https://ops.example.com:8443/``
86+
| ``v2#/org/<orgId>/projects``
87+
88+
.. tab:: Organization API Keys
89+
:tabid: org
90+
91+
If specified, the |k8s-op-short| links to the Organization.
92+
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:
100+
101+
| ``https://ops.example.com:8443/``
102+
| ``v2#/org/<orgId>/projects``
103+
104+
If omitted, |onprem| creates an Organization called
105+
``projectName`` that contains a project also called
106+
``projectName``.
107+
108+
You must have the :authrole:`Organization Project Creator`
109+
role to create a new project within an existing
110+
organization.
111+
112+
.. admonition:: Limited to |com| Organizations
113+
:class: important
114+
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.
89118

90119
- | ``5cc9b333dd3e384a625a6615``
91120

source/includes/steps-create-k8s-configmap.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ content: |
1616
kubectl create configmap <configmap-name> \
1717
--from-literal="baseUrl=<myOpsManagerURL>" \
1818
--from-literal="projectName=<myOpsManagerProjectName>" \ #Optional
19-
--from-literal="orgId=<orgID>" #Optional
19+
--from-literal="orgId=<orgID>" #Required for Global API Keys
2020
2121
.. include:: /includes/list-tables/configmap-keys-curl.rst
2222

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Create One Project using a ConfigMap
55
====================================
66

7+
.. include:: /includes/styles/corrections.rst
8+
79
.. default-domain:: mongodb
810

911
.. contents:: On this page
@@ -14,7 +16,7 @@ Create One Project using a ConfigMap
1416

1517
The |k8s-op-full| uses a |k8s| |k8s-configmap| to create or link your
1618
|onprem| :opsmgr:`Project </tutorial/manage-projects>`. To create a
17-
|k8s-op-short| ConfigMap, you need to edit a few lines of the
19+
|k8s-op-short| ConfigMap, you can edit a few lines of the
1820
:ref:`example ConfigMap <example-k8s-configmap>` |yaml| file and apply
1921
the ConfigMap.
2022

@@ -28,9 +30,6 @@ in your project, see :ref:`k8s-deploy-mdb-resources`.
2830
Prerequisites
2931
-------------
3032

31-
Kubernetes
32-
~~~~~~~~~~
33-
3433
- Kubernetes version 1.11 or later or Openshift version
3534
3.11 or later.
3635
- |k8s-op-full| version 0.11 or later

0 commit comments

Comments
 (0)