Skip to content

Commit b9e1fb0

Browse files
Merge pull request #1546 from jvincent-mongodb/DOCSP-33529
DOCSP-33529 -- Clarify 1:1 project to deployment relationship and related ConfigMap requirement
2 parents 9669a58 + ab429e9 commit b9e1fb0

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ content: |
2020
name: my-project
2121
namespace: mongodb
2222
data:
23-
projectName: myProjectName # this is an optional parameter
23+
projectName: myProjectName # this is an optional parameter; when omitted, the Operator creates a project with the resource name
2424
orgId: 5b890e0feacf0b76ff3e7183 # this is a required parameter
2525
baseUrl: https://ops.example.com:8443
2626

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

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Create One Project using a ConfigMap
1212
:depth: 1
1313
:class: singlecol
1414

15-
The |k8s-op-full| uses a |k8s| |k8s-configmap| to link your
15+
The |k8s-op-full| uses a |k8s| |k8s-configmap| to link to a single and unique
1616
|onprem| :opsmgr:`Project </tutorial/manage-projects>`. If the
1717
referenced project doesn't exist, the |k8s-op-short| creates it
1818
according to the ``projectName`` that you provide in the ConfigMap.
@@ -31,10 +31,19 @@ which you can then apply to your Kubernetes environment.
3131
Considerations
3232
--------------
3333

34-
You can deploy only one MongoDB resource per project. This limit
35-
applies because |onprem| supports only one authentication method for
36-
database user access per project. To learn more, see
37-
:ref:`k8s-deploy-mdb-resources`.
34+
1. You can deploy only one MongoDB resource per project. This limit
35+
applies because |onprem| supports only one authentication method for
36+
database user access per project. To learn more, see
37+
:ref:`k8s-deploy-mdb-resources`.
38+
39+
2. You must pair a |k8s-op-full| deployment to a unique
40+
|onprem| :opsmgr:`Project </tutorial/manage-projects>`.
41+
You can either create a distinct ConfigMap for each |k8s-op-full| instance
42+
you deploy, or you can reuse the same ConfigMap for any number of deployments
43+
by omitting the ``data.projectName`` from your ConfigMap, so that
44+
project names align with deployed resource names. Where a project name is
45+
provided in the config map, if that project does not
46+
exist yet it will be created.
3847

3948
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
4049

0 commit comments

Comments
 (0)