Skip to content

Commit 5e3bddd

Browse files
jwilliams-mongojwilliams-mongo
committed
(DOCSP-14154): fix <db-version> and add missing settings (#498)
* (DOCSP-14154): fix <db-version> and add missing settings * (DOCSP-14154): copy review feedback * (DOCSP-14154): typo fix
1 parent 9c92ee4 commit 5e3bddd

File tree

8 files changed

+215
-44
lines changed

8 files changed

+215
-44
lines changed

‎conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,9 @@
7373
'ops-manager-init-version': '1.0.3',
7474
'database-init-version': '1.0.2',
7575
'mdbtools-version': '100.1.0',
76-
'appdb-agent-version': '10.2.15.5958-1_4.2.11-ent'
76+
'appdb-agent-version': '10.2.15.5958-1_4.2.11-ent',
77+
'mdb-ent-db': "MongoDB Enterprise Database",
78+
'mdb-ent-db-version': "2.0.0"
7779
}
7880

7981
rst_epilog = '\n'.join([

‎snooty.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ ops-manager-init-version = "1.0.3"
1111
database-init-version = "1.0.2"
1212
mdbtools-version = "100.1.0"
1313
appdb-agent-version = "10.2.15.5958-1_4.2.11-ent"
14+
mdb-ent-db = "MongoDB Enterprise Database"
15+
mdb-ent-db-version = "2.0.0"

‎source/includes/install/replace-op-and-om-versions.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@ Replace the following values:
22

33
- ``<op-version>`` with the |k8s-op-short| version you're installing
44
- ``<om-version>`` with the |onprem| version you're installing.
5-
- ``<db-version>`` with the MongoDB Enterprise database version you're
6-
installing.
5+
- ``<db-version>`` with the version of the {+mdb-ent-db+}
6+
image that you want to use.
7+
8+
.. seealso:: :ref:`helm-database-version`

‎source/includes/op-setting-descs/database-version.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Version of the {+mdb-ent-db+} image that the |k8s-op-short|
2+
deploys.

‎source/includes/op-setting-descs/mongodb-enterprise-db-image.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
|url| of the MongoDB Enterprise Database image that the |k8s-op-short|
1+
|url| of the {+mdb-ent-db+} image that the |k8s-op-short|
22
deploys.

‎source/reference/helm-operator-settings.txt

Lines changed: 172 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,163 @@ If the setting that you want to add doesn't exist in the **values**
5555
--values helm_chart/values-openshift.yaml \
5656
--set namespace=<testNamespace>
5757

58+
appDb.name
59+
----------
60+
61+
Name of the Application Database image.
62+
63+
The default value is **mongodb-enterprise-appdb**.
64+
65+
.. example::
66+
67+
.. code-block:: yaml
68+
:emphasize-lines: 2
69+
70+
appDb:
71+
name: mongodb-enterprise-appdb
72+
version: {+appdb-agent-version+}
73+
74+
.. _registry-appdb-version:
75+
76+
appDb.version
77+
-------------
78+
79+
.. include:: /includes/op-setting-descs/appdb-agent-version.rst
80+
81+
.. example::
82+
83+
.. code-block:: yaml
84+
:emphasize-lines: 3
85+
86+
appDb:
87+
name: mongodb-enterprise-appdb
88+
version: {+appdb-agent-version+}
89+
90+
database.name
91+
-------------
92+
93+
Name of the {+mdb-ent-db+} image.
94+
95+
The default value is **mongodb-enterprise-database**.
96+
97+
.. example::
98+
99+
.. code-block:: yaml
100+
:emphasize-lines: 2
101+
102+
database:
103+
name: mongodb-enterprise-database
104+
version: 2.0.0
105+
106+
.. _helm-database-version:
107+
108+
database.version
109+
----------------
110+
111+
.. include:: /includes/op-setting-descs/database-version.rst
112+
113+
.. example::
114+
115+
.. code-block:: yaml
116+
:emphasize-lines: 3
117+
118+
database:
119+
name: mongodb-enterprise-database
120+
version: {+mdb-ent-db-version+}
121+
122+
initAppDb.name
123+
--------------
124+
125+
Name of the ``initContainer`` image that contains the Application
126+
Database start-up scripts and the readiness probe.
127+
128+
The default value is **mongodb-enterprise-init-appdb**.
129+
130+
.. example::
131+
132+
.. code-block:: yaml
133+
:emphasize-lines: 2
134+
135+
database:
136+
name: mongodb-enterprise-init-appdb
137+
version: {+appdb-init-version+}
138+
139+
initAppDb.version
140+
-----------------
141+
142+
.. include:: /includes/op-setting-descs/init-appdb-version.rst
143+
144+
.. example::
145+
146+
.. code-block:: yaml
147+
:emphasize-lines: 3
148+
149+
database:
150+
name: mongodb-enterprise-init-appdb
151+
version: {+appdb-init-version+}
152+
153+
initDatabase.name
154+
-----------------
155+
156+
Name of the ``initContainer`` image that contains the {+mdbagent+}
157+
start-up scripts and the readiness probe.
158+
159+
The default value is **mongodb-enterprise-init-database**.
160+
161+
.. example::
162+
163+
.. code-block:: yaml
164+
:emphasize-lines: 2
165+
166+
database:
167+
name: mongodb-enterprise-init-database
168+
version: {+database-init-version+}
169+
170+
initDatabase.version
171+
--------------------
172+
173+
.. include:: /includes/op-setting-descs/init-database-version.rst
174+
175+
.. example::
176+
177+
.. code-block:: yaml
178+
:emphasize-lines: 3
179+
180+
database:
181+
name: mongodb-enterprise-init-database
182+
version: {+database-init-version+}
183+
184+
initOpsManager.name
185+
-------------------
186+
187+
Version of the ``initContainer`` image that contains the |onprem|
188+
start-up scripts and the readiness probe.
189+
190+
The default value is **mongodb-enterprise-init-ops-manager**.
191+
192+
.. example::
193+
194+
.. code-block:: yaml
195+
:emphasize-lines: 2
196+
197+
database:
198+
name: mongodb-enterprise-init-ops-manager
199+
version: {+ops-manager-init-version+}
200+
201+
initOpsManager.version
202+
----------------------
203+
204+
.. include:: /includes/op-setting-descs/init-ops-manager-version.rst
205+
206+
.. example::
207+
208+
.. code-block:: yaml
209+
:emphasize-lines: 3
210+
211+
database:
212+
name: mongodb-enterprise-init-ops-manager
213+
version: {+ops-manager-init-version+}
214+
58215
managedSecurityContext
59216
----------------------
60217

@@ -147,6 +304,21 @@ operator.watchedResources
147304
- mongodb
148305
- opsmanagers
149306

307+
opsManager.name
308+
---------------
309+
310+
Name of the |onprem| image.
311+
312+
The default value is **mongodb-enterprise-ops-manager**.
313+
314+
.. example::
315+
316+
.. code-block:: yaml
317+
:emphasize-lines: 2
318+
319+
opsManager:
320+
name: mongodb-enterprise-ops-manager
321+
150322
registry.appDb
151323
--------------
152324

@@ -180,39 +352,6 @@ registry.appDb
180352
registry:
181353
appDb: registry.connect.redhat.com/mongodb
182354

183-
.. _registry-appdb-version:
184-
185-
registry.appDb.version
186-
----------------------
187-
188-
.. include:: /includes/op-setting-descs/appdb-agent-version.rst
189-
190-
.. tabs::
191-
192-
.. tab:: Kubernetes
193-
:tabid: k8s
194-
195-
.. example::
196-
197-
.. code-block:: yaml
198-
:emphasize-lines: 3
199-
200-
registry:
201-
appDb: quay.io/mongodb
202-
version: {+appdb-agent-version+}
203-
204-
.. tab:: OpenShift
205-
:tabid: os
206-
207-
.. example::
208-
209-
.. code-block:: yaml
210-
:emphasize-lines: 3
211-
212-
registry:
213-
appDb: registry.connect.redhat.com/mongodb
214-
version: {+appdb-agent-version+}
215-
216355
registry.imagePullSecrets
217356
-------------------------
218357

‎source/reference/kubectl-operator-settings.txt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,31 @@ to a vanilla |k8s| or an OpenShift environment:
127127
- name: APPDB_IMAGE_REPOSITORY
128128
value: registry.connect.redhat.com/mongodb/mongodb-enterprise-appdb
129129

130+
.. _kubectl-database-version:
131+
132+
DATABASE_VERSION
133+
----------------
134+
135+
.. include:: /includes/op-setting-descs/database-version.rst
136+
137+
.. example::
138+
139+
.. code-block:: yaml
140+
:linenos:
141+
:emphasize-lines: 9-11
142+
143+
spec:
144+
template:
145+
spec:
146+
serviceAccountName: mongodb-enterprise-operator
147+
containers:
148+
- name: mongodb-enterprise-operator
149+
image: <operatorVersionUrl>
150+
imagePullPolicy: <policyChoice>
151+
env:
152+
- name: DATABASE_VERSION
153+
value: {+mdb-ent-db-version+}
154+
130155
IMAGE_PULL_POLICY
131156
-----------------
132157

‎source/release-notes.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ New |onprem| Images
282282
For a list of the packages installed and any security vulnerabilities
283283
detected in the build process, see the Quay repository for the
284284
:qr-mdb:`MongoDB Enterprise Operator </mongodb-enterprise-operator?tab=tags>`
285-
and the :qr-mdb:`MongoDB Enterprise Database </mongodb-enterprise-database?tab=tags>`.
285+
and the :qr-mdb:`{+mdb-ent-db+} </mongodb-enterprise-database?tab=tags>`.
286286

287287
.. _ent-op-1.8.0:
288288

@@ -294,11 +294,10 @@ and the :qr-mdb:`MongoDB Enterprise Database </mongodb-enterprise-database?tab=t
294294
.. admonition:: Breaking Changes
295295
:class: warning
296296

297-
The Mongodb Enterprise Database image now requires an init
298-
container. If you are using a private repository, you must set the
299-
``INIT_DATABASE_IMAGE_REPOSITORY`` environment variable in the
300-
Operator deployment, and the new init container must exist inside
301-
this repository.
297+
The {+mdb-ent-db+} image now requires an init container.
298+
If you are using a private repository, you must set the ``INIT_DATABASE_IMAGE_REPOSITORY``
299+
environment variable in the Operator deployment, and the new
300+
init container must exist inside this repository.
302301

303302
MongoDB Resource Changes
304303
````````````````````````
@@ -1399,7 +1398,7 @@ This feature is an alpha release. It is not ready for production use.
13991398

14001399
- :qr-mdb:`MongoDB Enterprise Operator </mongodb-enterprise-operator?tab=tags>`
14011400

1402-
- :qr-mdb:`MongoDB Enterprise Database </mongodb-enterprise-database?tab=tags>`
1401+
- :qr-mdb:`{+mdb-ent-db+} </mongodb-enterprise-database?tab=tags>`
14031402

14041403
.. _ent-op-0.9:
14051404

0 commit comments

Comments
 (0)