Skip to content

Commit daf08a3

Browse files
jvincent-mongodbjwilliams-mongo
authored andcommitted
DOCSP-33529 -- Clarify 1:1 project to deployment relationship and related ConfigMap requirement
1 parent 41b0da8 commit daf08a3

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
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 # optional; omit to generate a random project 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: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,20 @@ 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, 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.
1919

20+
.. note::
21+
22+
As each |k8s-op-full| deployment requires a one to one pairing with
23+
a unique |onprem| :opsmgr:`Project </tutorial/manage-projects>`,
24+
you can either create a distinct ConfigMap for each |k8s-op-full| instance
25+
you deploy, or you can reuse the same ConfigMap for any number of deployments
26+
by omitting the ``data.projectName`` from your ConfigMap, so that
27+
project names will be randomly generated as required.
28+
2029
To create a |k8s-op-short| ConfigMap, you can edit a few lines of the
2130
:ref:`example ConfigMap <example-k8s-configmap>` |yaml| file and apply
2231
the ConfigMap. To view a full example, see the :github:`project.yaml

0 commit comments

Comments
 (0)