Skip to content

Commit 9b66acc

Browse files
JuliaMongojwilliams-mongo
authored andcommitted
(DOCSP-29609) Moved the orgID required to breaking changes in the 1.1.9 Release Notes (#1322)
* (DOCSP-29609) Moved the orgID required to breaking changes in the 1.19.1 release notes * Tech review. Searched for orgId and made sure it is specified as required in all places and examples where it is mentioned. Thank you, Nam
1 parent b817df1 commit 9b66acc

File tree

8 files changed

+21
-16
lines changed

8 files changed

+21
-16
lines changed

source/includes/code-examples/yaml-files/configmaps/example-configmap-tls-full.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ metadata:
55
name: <my-configmap>
66
namespace: <my-namespace>
77
data:
8-
projectName: <my-ops-manager-project-name>
9-
orgId: <org-id>
8+
projectName: <my-ops-manager-project-name> # this is an optional parameter
9+
orgId: <org-id> # this is a required parameter
1010
baseUrl: https://<my-ops-manager-URL>
1111

1212
sslMMSCAConfigMap: <root-ca-configmap-name>

source/includes/code-examples/yaml-files/configmaps/example-configmap-tls-upper.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
name: <my-configmap>
66
namespace: <my-namespace>
77
data:
8-
projectName: <my-ops-manager-project-name>
9-
orgId: <org-id>
8+
projectName: <my-ops-manager-project-name> # this is an optional parameter
9+
orgId: <org-id> # this is a required parameter
1010
baseUrl: https://<my-ops-manager-URL>
1111

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ content: |
2121
namespace: mongodb
2222
data:
2323
projectName: myProjectName # this is an optional parameter
24-
orgId: 5b890e0feacf0b76ff3e7183 # this is an optional parameter
24+
orgId: 5b890e0feacf0b76ff3e7183 # this is a required parameter
2525
baseUrl: https://ops.example.com:8443
2626
2727
EOF

source/includes/steps-kind-quick-start.yaml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,8 @@ content: |
7979
data:
8080
baseUrl: https://cloud.mongodb.com
8181
82-
# Optional Parameters
83-
# projectName: My Ops/Cloud Manager Project
84-
85-
orgId: 5ecd252f8c1a75033c74106c
82+
projectName: my-project # this is an optional parameter
83+
orgId: 5ecd252f8c1a75033c74106c # this is a required parameter
8684
8785
To learn more, see the :doc:`parameter descriptions
8886
</tutorial/create-project-using-configmap>`.

source/includes/steps-openshift-airgapped-env-tutorial.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ content: |
210210
namespace: mongodb
211211
data:
212212
projectName: myProjectName # this is an optional parameter
213-
orgId: 5b890e0feacf0b76ff3e7183
213+
orgId: 5b890e0feacf0b76ff3e7183 # this is a required parameter
214214
baseUrl: https://ops.example.com:8443
215215
EOF
216216

source/reference/k8s/example-configmap.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ kind: ConfigMap
44
metadata:
55
name: <myconfigmap>
66
data:
7-
projectName: <myOpsManagerProjectName> # Optional
8-
orgId: <orgId>
7+
projectName: <myOpsManagerProjectName> # this is an optional parameter
8+
orgId: <orgId> # this is a required parameter
99
baseUrl: https://<myOpsManagerURL>
1010
...

source/release-notes.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ Release Notes for |k8s-op-full|
2727
This release fixes an issue that prevented upgrading the |k8s-op-short| to 1.19.0.
2828
Upgrade to this release.
2929

30+
Breaking Changes
31+
`````````````````
32+
33+
Makes the ``data.orgId`` field required for the ConfigMap of the |k8s-mdbrscs|.
34+
If you provide an empty ``orgId``, as in: ``orgId = ""``, |onprem|
35+
creates an organization with the project name.
36+
3037
Improvements
3138
````````````
3239

@@ -46,7 +53,6 @@ Improvements
4653

4754
- Renames the "multi-cluster CLI" tool to the "|kubectl-mongodb|".
4855
To learn more, see the :ref:`kubectl-plugin-ref`.
49-
- Adds documentation for the :ref:`multi-cluster-specification`.
5056
- Removes the unnecessary intermediate object ``clusterSpecs`` from the
5157
``clusterSpecList`` in the |mongodb-multi| specification. For a valid
5258
example of a |mongodb-multi| configuration file, see the
@@ -60,7 +66,7 @@ Improvements
6066
- Makes the ``data.orgId`` field required for the ConfigMap of the |k8s-mdbrscs|.
6167
If you provide an empty ``orgId``, as in: ``orgId = " "``, |onprem|
6268
creates an organization with the project name.
63-
- Makes the :setting:`spec.members` setting required for replica set deployments.
69+
- Adds documentation for the :ref:`multi-cluster-specification`.
6470
- Adds the :ref:`k8s-faq` for the |k8s-op-short| to the documentation.
6571
- Adds documentation for :ref:`configuring file system backup stores <configure-file-store>`
6672
in the |k8s-op-short| MongoDB deployments.

source/tutorial/mdb-resources-arch.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,10 +208,11 @@ performs the following actions to reconcile the changes:
208208

209209
3. The |k8s-op-short| connects to |com| and performs the following actions:
210210

211-
- Reads the organization from the ``orgId`` field in the ConfigMap.
211+
- Reads the organization from the ``orgId`` field in the ConfigMap. You must provide a value in the ``orgId`` field.
212212

213213
- Reads a project name specified in the ``projectName`` field in the
214-
ConfigMap, or creates this project in |com| if it doesn't exist.
214+
ConfigMap, or, if you din't specify a value for this optional field,
215+
creates this project in |com| if it doesn't exist.
215216

216217
- Checks that the ``<project-id>-group-secret`` secret
217218
created by the |k8s-op-short| for the {+mdbagent+} exists.

0 commit comments

Comments
 (0)