Skip to content

Commit fd39bc1

Browse files
(DOCSP-11234)(DOCSP-11122): updated feature control policy steps, oplog db auth, and blockstore db auth (#330)
* (DOCSP-11234)(DOCSP-11122): updated feature control policy steps, oplog db auth, and blockstore db auth * (DOCSP-11234)(DOCSP-11122): fix highlighted lines * (DOCSP-11234): copy review feedback * (DOCSP-11234): feedback from filer * (DOCSP-11234): minor tweaks
1 parent 0be3410 commit fd39bc1

File tree

5 files changed

+49
-12
lines changed

5 files changed

+49
-12
lines changed

source/includes/admonitions/fact-backing-db-auth.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
The Oplog database only supports the ``SCRAM`` authentication mechanism.
2+
You cannot enable other authentication mechanisms.
3+
14
If you enable ``SCRAM`` authentication on the oplog database, you
25
must:
36

source/includes/steps-deploy-k8s-opsmgr-http.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ content: |
212212
* - | ``spec``
213213
| ``.backup``
214214
| ``.opLogStores``
215-
| ``.mongodbRef``
215+
| ``.mongodbResourceRef``
216216
| ``.``:opsmgrkube:`~spec.backup.opLogStores.mongodbResourceRef.name`
217217
- string
218218
- Name of the MongoDB database resource for the oplog store.

source/includes/steps-deploy-k8s-opsmgr-https.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ content: |
271271
* - | ``spec``
272272
| ``.backup``
273273
| ``.opLogStores``
274-
| ``.mongodbRef``
274+
| ``.mongodbResourceRef``
275275
| ``.``:opsmgrkube:`~spec.backup.opLogStores.mongodbResourceRef.name`
276276
- string
277277
- Name of the MongoDB database resource for the oplog store.

source/reference/k8s-operator-om-specification.txt

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,18 @@ Optional |onprem| Resource Settings
352352
blockstore. You must deploy this database resource in the same
353353
namespace as the |onprem| resource.
354354

355-
.. include:: /includes/admonitions/fact-backing-db-auth.rst
355+
The blockstore database only supports the ``SCRAM`` authentication
356+
mechanism. You cannot enable other authentication mechanisms.
357+
358+
If you enable ``SCRAM`` authentication on the blockstore database,
359+
you must:
360+
361+
- Specify a MongoDB version earlier than v4.0 in the blockstore
362+
database resource definition.
363+
- Create a MongoDB user resource to connect |onprem| to the
364+
blockstore database.
365+
- Specify the :opsmgrkube:`~spec.backup.blockStores.mongodbUserRef.name`
366+
of the user in the |onprem| resource definition.
356367

357368
.. include:: /includes/admonitions/watch-backup-resources.rst
358369

source/reference/troubleshooting.txt

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -456,21 +456,30 @@ policy through the :opsmgr:`API </reference/api/controlled-features/update-contr
456456
--include \
457457
--request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/controlledFeature?pretty=true"
458458

459-
.. important::
459+
Save the response that the API returns. After you make changes in
460+
the |onprem| application, you must add these policies back to
461+
the project.
460462

461-
Save the response that the API returns. After you make changes in
462-
the |onprem| application, you must add these policies back to
463-
the project.
463+
.. important::
464+
465+
Note the highlighted fields and values in the following sample
466+
response. You must send these same fields and values in later
467+
steps when you remove and add feature control policies.
464468

465-
Your response should be similar to:
469+
The ``externalManagementSystem.version`` field corresponds to the
470+
|k8s-op-short| version. You must send the exact same field value
471+
in your requests later in this task.
466472

473+
Your response should be similar to:
474+
467475
.. code-block:: json
476+
:emphasize-lines: 3-7
468477

469478
{
470479
"created": "2020-02-25T04:09:42Z",
471480
"externalManagementSystem": {
472481
"name": "mongodb-enterprise-operator",
473-
"systemId": "6d6c139ae5528707b6e8e3b2",
482+
"systemId": null,
474483
"version": "1.4.2"
475484
},
476485
"policies": [
@@ -484,12 +493,19 @@ policy through the :opsmgr:`API </reference/api/controlled-features/update-contr
484493
}
485494
],
486495
"updated": "2020-02-25T04:10:12Z"
487-
}
496+
}
488497

489498
#. :opsmgr:`Update </reference/api/controlled-features/update-controlled-features-for-one-project/>`
490499
the ``policies`` array with an empty list:
491500

501+
.. note::
502+
503+
The values you provide for the ``externalManagementSystem``
504+
object, like the ``externalManagementSystem.version`` field, must
505+
match values that you received in the response in Step 1.
506+
492507
.. code-block:: sh
508+
:emphasize-lines: 8-12
493509

494510
curl --user "{USERNAME}:{APIKEY}" --digest \
495511
--header "Accept: application/json" \
@@ -500,7 +516,7 @@ policy through the :opsmgr:`API </reference/api/controlled-features/update-contr
500516
'{
501517
"externalManagementSystem": {
502518
"name": "mongodb-enterprise-operator",
503-
"systemId": "6d6c139ae5528707b6e8e3b2",
519+
"systemId": null,
504520
"version": "1.4.2"
505521
},
506522
"policies": []
@@ -514,7 +530,14 @@ policy through the :opsmgr:`API </reference/api/controlled-features/update-contr
514530
#. :opsmgr:`Update </reference/api/controlled-features/update-controlled-features-for-one-project/>`
515531
the ``policies`` array with the original feature control policies:
516532

533+
.. note::
534+
535+
The values you provide for the ``externalManagementSystem``
536+
object, like the ``externalManagementSystem.version`` field, must
537+
match values that you received in the response in Step 1.
538+
517539
.. code-block:: sh
540+
:emphasize-lines: 8-12
518541

519542
curl --user "{USERNAME}:{APIKEY}" --digest \
520543
--header "Accept: application/json" \
@@ -525,7 +548,7 @@ policy through the :opsmgr:`API </reference/api/controlled-features/update-contr
525548
'{
526549
"externalManagementSystem": {
527550
"name": "mongodb-enterprise-operator",
528-
"systemId": "6d6c139ae5528707b6e8e3b2",
551+
"systemId": null,
529552
"version": "1.4.2"
530553
},
531554
"policies": [

0 commit comments

Comments
 (0)