|
1 | 1 | .. list-table:: |
2 | | - :widths: 20 20 40 20 |
| 2 | + :widths: 20 10 50 20 |
3 | 3 | :header-rows: 1 |
4 | 4 |
|
5 | 5 | * - Key |
6 | 6 | - Type |
7 | 7 | - Description |
8 | 8 | - Example |
9 | 9 |
|
10 | | - * - ``<configmap-name>`` |
| 10 | + * - ``configmap-name`` |
11 | 11 | - string |
12 | 12 | - Name of the |k8s| |k8s-obj|. |
13 | 13 |
|
|
19 | 19 | - |k8s| documentation on `names <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/>`__. |
20 | 20 | This name must follow :rfc:`RFC1123 <1123>` naming |
21 | 21 | 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 |
23 | 23 | alphanumeric character. |
24 | 24 |
|
25 | 25 | - ``myconfigmap`` |
|
60 | 60 | - string |
61 | 61 | - 24 character hex string that uniquely identifies your |
62 | 62 | MongoDB :opsmgr:`Organization </tutorial/manage-organizations>`. |
63 | | - You can find the ``orgId`` in your |onprem| |url|: |
64 | 63 |
|
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: |
69 | 66 |
|
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>`. |
72 | 69 |
|
73 | | - .. important:: |
| 70 | + .. tabs:: |
| 71 | + |
| 72 | + .. tab:: Global API Keys |
| 73 | + :tabid: global |
74 | 74 |
|
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>`. |
78 | 77 |
|
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: |
82 | 79 |
|
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: |
84 | 84 |
|
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. |
89 | 118 |
|
90 | 119 | - | ``5cc9b333dd3e384a625a6615`` |
91 | 120 |
|
|
0 commit comments