Skip to content

Commit f315226

Browse files
JuliaMongoJuliaMongo
authored
(DOCSP-33200) Release Notes for 1.22 (#1469)
* (DOCSP-33200) Release Notes for 1.22 * Fix build warnings * Fix build warnings * Tech and copy review * edits * Added licenses, version, compatibility * Copy review from John W for relnotes * Updated the lifecycle topic with the EOL date for 1.22 using the 12 months guideline now * Copy review, ready to publish * edits * Remove OM 5.0 from compatibility due to its EOL in July of 2023
1 parent 82d522a commit f315226

13 files changed

+145
-37
lines changed

‎config/redirects

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
# while we work out how to deploy this property.
33

44
define: base https://www.mongodb.com/docs/kubernetes-operator
5-
define: versions v0.8 v0.9 v0.10 v0.11 v0.12 v1.0 v1.1 v1.2 v1.3 v1.4 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11 v1.12 v1.13 v1.14 v1.15 v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 master
6-
symlink: v1.21 -> master
5+
define: versions v0.8 v0.9 v0.10 v0.11 v0.12 v1.0 v1.1 v1.2 v1.3 v1.4 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11 v1.12 v1.13 v1.14 v1.15 v1.16 v1.17 v1.18 v1.19 v1.20 v1.21 v1.22 master
6+
symlink: v1.22 -> master
77
symlink: upcoming -> master
8-
symlink: stable -> v1.21
8+
symlink: stable -> v1.22
99

1010
########
1111

‎source/includes/list-tables/compatibility-om.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@
55
* - |k8s-op-short| Release Series
66
- |onprem| Version
77

8+
* - 1.22.x
9+
- 6.0
10+
811
* - 1.21.x
9-
- 5.0, 6.0
12+
- 6.0
1013

1114
* - 1.20.x
1215
- 5.0, 6.0
@@ -17,4 +20,3 @@
1720
* - 1.18.x
1821
- 5.0, 6.0
1922

20-

‎source/includes/options-k8s-shared.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,9 +206,8 @@ type: boolean
206206
directive: setting
207207
description: |
208208
209-
Flag that indicates whether the |k8s-op-short| stops and terminates the
210-
backup when you delete a MongoDB resource. If
211-
omitted, the default value is ``false``.
209+
Flag that controls whether the |k8s-op-short| stops and terminates the
210+
backup when you delete a MongoDB resource. If omitted, the default value is ``false``.
212211
Setting this flag to ``true`` is useful when you want to delete the
213212
MongoDB custom resource while the :setting:`spec.backup.mode` setting
214213
is set to ``enabled``.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -426,9 +426,9 @@ content: |
426426
427427
status:
428428
applicationDatabase:
429-
lastTransition: "2022-04-01T09:49:22Z"
429+
lastTransition: "2023-04-01T09:49:22Z"
430430
message: AppDB Statefulset is not ready yet
431-
phase: Reconciling
431+
phase: Pending
432432
type: ""
433433
version: ""
434434
backup:
@@ -445,7 +445,7 @@ content: |
445445
The |k8s-op-short| doesn't reconcile a resource until the preceding
446446
one enters the ``Running`` phase.
447447
448-
After the |onprem| resource completes the ``Reconciling`` phase, the
448+
After the |onprem| resource completes the ``Pending`` phase, the
449449
command returns the output similar to the following under the ``status``
450450
field if you enabled backup:
451451
@@ -454,7 +454,7 @@ content: |
454454
455455
status:
456456
applicationDatabase:
457-
lastTransition: "2022-04-01T09:50:20Z"
457+
lastTransition: "2023-04-01T09:50:20Z"
458458
members: 3
459459
phase: Running
460460
type: ReplicaSet

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -575,7 +575,7 @@ content: |
575575
applicationDatabase:
576576
lastTransition: "2022-04-01T09:49:22Z"
577577
message: AppDB Statefulset is not ready yet
578-
phase: Reconciling
578+
phase: Pending
579579
type: ""
580580
version: ""
581581
backup:
@@ -592,7 +592,7 @@ content: |
592592
The |k8s-op-short| doesn't reconcile a resource until the preceding
593593
one enters the ``Running`` phase.
594594
595-
After the |onprem| resource completes the ``Reconciling`` phase, the
595+
After the |onprem| resource completes the ``Pending`` phase, the
596596
command returns output similar to the following under the ``status``
597597
field if you enabled Backup:
598598
@@ -612,7 +612,7 @@ content: |
612612
doesn't exist
613613
phase: Pending
614614
opsManager:
615-
lastTransition: "2022-04-01T09:57:40Z"
615+
lastTransition: "2023-04-01T09:57:40Z"
616616
phase: Running
617617
replicas: 1
618618
url: https://om-svc.cloudqa.svc.cluster.local:8443
@@ -628,7 +628,7 @@ content: |
628628
inside the |k8s| cluster or :ref:`create a project using a
629629
ConfigMap <create-k8s-project>`.
630630
631-
After the resource completes the ``Reconciling`` phase, the command
631+
After the resource completes the ``Pending`` phase, the command
632632
returns output similar to the following under the ``status`` field:
633633
634634
.. code-block:: yaml

‎source/includes/steps-deploy-k8s-opsmgr-local-mode.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ content: |
233233
See :doc:`/reference/troubleshooting` for information about the
234234
resource deployment statuses.
235235
236-
After the |onprem| resource completes the ``Reconciling`` phase, the
236+
After the |onprem| resource completes the ``Pending`` phase, the
237237
command returns output similar to the following:
238238
239239
.. literalinclude:: /reference/k8s/example-status-om-running-local-mode.yaml

‎source/includes/steps-deploy-k8s-opsmgr-remote-mode.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,14 +288,13 @@ content: |
288288
See :doc:`/reference/troubleshooting` for information about the
289289
resource deployment statuses.
290290
291-
After the |onprem| resource completes the ``Reconciling`` phase, the
291+
After the |onprem| resource completes the ``Pending`` phase, the
292292
command returns output similar to the following:
293293
294294
.. literalinclude:: /reference/k8s/example-status-om-running-local-mode.yaml
295295
:language: yaml
296296
:copyable: false
297297
:linenos:
298-
:emphasize-lines: 12,14
299298
300299
Copy the value of the ``status.opsManager.url`` field, which states
301300
the resource's connection |url|. You use this value when you create a

‎source/multi-cluster-prerequisites.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -338,9 +338,9 @@ How Does the |k8s-op-short| Establish Connectivity?
338338
Regardless of the deployment type, a MongoDB deployment in |k8s| must
339339
establish the following connections:
340340

341-
- From the |onprem| Automation Agent in the Pod to its ``mongod`` process,
341+
- From the |onprem| MongoDB Agent in the Pod to its ``mongod`` process,
342342
to enable MongoDB deployment's lifecycle management and monitoring.
343-
- From the |onprem| Automation Agent in the Pod to the |onprem| instance,
343+
- From the |onprem| MongoDB Agent in the Pod to the |onprem| instance,
344344
to enable automation.
345345
- Between all ``mongod`` processes, to allow replication.
346346

@@ -404,7 +404,7 @@ Enable External Connectivity through External Domains and DNS Zones
404404

405405
If you don't use a service mesh, do the following to enable external
406406
connectivity to and between ``mongod`` processes and the
407-
|onprem| Automation Agent:
407+
|onprem| MongoDB Agent:
408408

409409
- When you create a |multi-cluster|, use
410410
the :ref:`spec.clusterSpecList.externalAccess.externalDomain <multi-spec-clusterspeclist-externaldomain>`
@@ -421,7 +421,7 @@ connectivity to and between ``mongod`` processes and the
421421
can't change external domains after you configure a |multi-cluster|.
422422

423423
After you configure an external domain in this way, the |onprem|
424-
Automation Agents and ``mongod`` processes use this domain to connect
424+
MongoDB Agents and ``mongod`` processes use this domain to connect
425425
to each other.
426426

427427
- Customize external services that the |k8s-op-short| creates for each Pod

‎source/reference.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Reference
2424
:ref:`multi-cluster-specification`
2525
Review the |mongodb-multi| object specifications.
2626

27-
:ref:`meko-operator-settings`:
27+
:ref:`meko-operator-settings`
2828
Review the |k8s-op-short| installation settings.
2929

3030
:ref:`k8s-exclusive-settings`
@@ -37,7 +37,7 @@ Reference
3737
Review the available third-party integrations.
3838

3939
:ref:`third-party-licenses`
40-
Open Source licenses that the |k8s-op-short| uses.
40+
Review the list of Open Source licenses that the |k8s-op-short| uses.
4141

4242
.. class:: hidden
4343

‎source/reference/support-lifecycle.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ to change.
2828
* - |k8s-op-short| Version
2929
- End of Life Date
3030

31+
* - 1.22.x
32+
- 2024-09-21
33+
3134
* - 1.21.x
3235
- 2024-08-25
3336

‎source/reference/troubleshooting.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,12 @@ The following key-value pairs describe the resource deployment statuses:
8686
out, the |k8s-op-short| attempts to reconcile the
8787
resource state in 10 seconds.
8888

89-
* - ``Reconciling``
89+
* - ``Pending``
9090
- The |k8s-op-short| is reconciling the resource state.
9191

9292
Resources enter this state after you create or update
9393
them or if the |k8s-op-short| is attempting to reconcile
94-
a resource previously in a ``Pending`` or ``Failed``
95-
state.
94+
a resource previously in a ``Failed`` state.
9695

9796
The |k8s-op-short| attempts to reconcile the resource
9897
state in 10 seconds.

‎source/release-notes.txt

Lines changed: 111 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,112 @@ Release Notes for |k8s-op-full|
1212
:depth: 1
1313
:class: singlecol
1414

15+
.. _ent-op-1.22.x:
16+
17+
|k8s-op-full| 1.22 Series
18+
-------------------------
19+
20+
.. _ent_op-1.22.0:
21+
22+
|k8s-op-full| 1.22.0
23+
~~~~~~~~~~~~~~~~~~~~
24+
25+
*Released 2023-09-21*
26+
27+
Breaking Changes
28+
````````````````
29+
30+
The |k8s-op-short| no longer uses the ``Reconciling`` state for all custom resources.
31+
In most cases this state has been replaced with ``Pending`` and a corresponding
32+
message. If you use monitoring tools with the custom MongoDB resources deployed
33+
with the |k8s-op-short|, you might need to adjust your dashboards and alerting rules
34+
to use the ``Pending`` state name.
35+
36+
MongoDBOpsManager Resource
37+
``````````````````````````
38+
39+
Improvements
40+
++++++++++++
41+
42+
- Adds support for configuring :opsmgr:`logRotate </reference/cluster-configuration/#mongodb-instances>`
43+
on the MongoDB Agent for the Application Database.
44+
- You can now configure the :manual:`systemLog </reference/configuration-options/#systemlog-options>`
45+
to send logs to a custom location other than the default ``/var/log/mongodb-mms-automation`` directory.
46+
47+
- Improves handling of Application Database clusters in |multi-clusters|.
48+
49+
In the last release, to scale down processes, the |k8s-op-short| required
50+
a connection to the |k8s| cluster. This could block the reconciliation
51+
process due to a full-cluster outage.
52+
53+
In this release, the |k8s-op-short| successfully manages the remaining
54+
healthy clusters as long as they have a majority of votes to elect a primary.
55+
The |k8s-op-short| doesn't remove associated processes from the automation
56+
configuration and replica set configuration. The |k8s-op-short| deletes
57+
these processes only if you delete the corresponding cluster from
58+
:opsmgrkube:`spec.applicationDatabase.clusterSpecList <spec.applicationDatabase.clusterSpecList>`
59+
or change the number of the cluster members to zero. When the |k8s-op-short|
60+
deletes these processes, it scales down the replica set by removing
61+
processes tied to that cluster one at a time.
62+
63+
``MongoDB`` Resource
64+
````````````````````
65+
66+
Improvements
67+
++++++++++++
68+
69+
- Adds an automatic recovery mechanism for ``MongoDB``
70+
resources. If a custom resource remains in ``Pending`` or ``Failed`` state
71+
for a longer period of time, the automation configuration is pushed to
72+
|onprem|. This prevents a deadlock when the MongoDB Agent can't push an
73+
updated automation configuration change because the StatefulSet is stuck
74+
in a ``Pending`` state due to a previous push of an invalid automation configuration.
75+
76+
In addition, introduces the following environment variables:
77+
78+
- ``MDB_AUTOMATIC_RECOVERY_ENABLE`` controls automatic recovery for
79+
``MongoDB`` resources per Pod. The default is ``true``.
80+
81+
- ``MDB_AUTOMATIC_RECOVERY_BACKOFF_TIME_S`` controls the time a custom
82+
resource remains in a ``Pending`` or ``Failed`` state. Set this variable
83+
at the |k8s-op-short| Pod spec level. The default is 1200 seconds (20 minutes).
84+
85+
- Allows you to route the audit logs for the ``MongoDB`` resource to the |k8s|
86+
Pod logs. Ensure that you write the ``MongoDB`` resource's audit logs
87+
to the ``/var/log/mongodb-mms-automation/mongodb-audit.log`` file.
88+
The Pod hosting the resource monitors this file and appends its content
89+
to its |k8s| logs.
90+
91+
To send audit logs to the |k8s| Pod logs, use the following example
92+
configuration in the ``MongoDB`` resource:
93+
94+
.. code-block:: yaml
95+
96+
spec:
97+
additionalMongodConfig:
98+
auditLog:
99+
destination: file
100+
format: JSON
101+
path: /var/log/mongodb-mms-automation/mongodb-audit.log
102+
103+
The |k8s-op-short| tags audit log entries with the ``mongodb-audit`` key
104+
in the Pod logs.
105+
106+
To extract audit log entries, use a command similar to the following example:
107+
108+
.. code-block:: yaml
109+
110+
kubectl logs -c mongodb-enterprise-database replica-set-0 | \
111+
jq -r 'select(.logType == "mongodb-audit") | .contents'
112+
113+
Bug Fixes
114+
++++++++++
115+
116+
Fixes an issue where you couldn't set the :setting:`spec.backup.autoTerminateOnDeletion`
117+
setting to ``true`` for sharded clusters. This setting controls whether the
118+
|k8s-op-short| stops and terminates the backup when you delete a MongoDB
119+
resource. If omitted, the default value is ``false``.
120+
15121
.. _ent-op-1.21.x:
16122

17123
|k8s-op-full| 1.21 Series
@@ -410,9 +516,9 @@ Bug Fixes
410516
`````````
411517

412518
- Fixes the issue where you configure a liveness probe and it reports a
413-
positive result when you terminate a MongoDB Agent's process. This
414-
could cause Pods hosting MongoDB resources to run without the
415-
Automation Agent. In addition to this fix, consider configuring
519+
positive result when you terminate a MongoDB Agent's process. This could
520+
cause Pods hosting MongoDB resources to run without the MongoDB Agent.
521+
In addition to this fix, consider configuring
416522
:ref:`readiness probe overrides <readiness-probe-override>`.
417523

418524
- Fixes the startup script in database Pod that might report errors when
@@ -2709,7 +2815,7 @@ This feature is an alpha release. It is not ready for production use.
27092815
project configMap and the credentials secret then performs a rolling
27102816
upgrade for relevant Kubernetes resources.
27112817

2712-
- Added |json| structured logging for Automation Agent pods.
2818+
- Added |json| structured logging for MongoDB Agent Pods.
27132819

27142820
- Support |dns-srv| records for MongoDB access.
27152821

@@ -2738,7 +2844,7 @@ This feature is an alpha release. It is not ready for production use.
27382844

27392845
- Improved database logging by adding a new configuration property
27402846
``logLevel``. This property is set to ``INFO`` by default.
2741-
Automation Agent and MongoDB logs are merged in to a single log
2847+
MongoDB Agent and MongoDB logs are merged in to a single log
27422848
stream.
27432849

27442850
- Added new configuration Operator timeout. It defines waiting time

‎source/third-party-licenses.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,10 @@ License: :tldrl:`TL;DR <apache2>` | :osil:`Full Text <Apache-2.0>`
7373
- v1.16.0
7474

7575
* - :gopkg:`github.com/prometheus/client_model/go </github.com/prometheus/client_model/go>`
76-
- v0.3.0
76+
- v0.4.0
7777

7878
* - :gopkg:`github.com/prometheus/common </github.com/prometheus/common>`
79-
- v0.42.0
79+
- v0.44.0
8080

8181
* - :gopkg:`github.com/prometheus/procfs </github.com/prometheus/procfs>`
8282
- v0.10.1
@@ -210,7 +210,7 @@ License: :tldrl:`TL;DR <bsd3>` | :osil:`Full Text <BSD-3-Clause>`
210210
- v1.0.0
211211

212212
* - :gopkg:`github.com/prometheus/common/internal/bitbucket.org/ww/goautoneg </github.com/prometheus/common/internal/bitbucket.org/ww/goautoneg>`
213-
- v0.42.0
213+
- v0.44.0
214214

215215
* - :gopkg:`github.com/spf13/pflag </github.com/spf13/pflag>`
216216
- v1.0.5
@@ -372,7 +372,7 @@ License: :tldrl:`TL;DR <mpl-2.0>` | :osil:`Full Text <MPL-2.0>`
372372
- v1.4.5
373373

374374
* - :gopkg:`github.com/hashicorp/go-retryablehttp </github.com/hashicorp/go-retryablehttp>`
375-
- v0.7.2
375+
- v0.7.4
376376

377377
* - :gopkg:`github.com/hashicorp/go-rootcerts </github.com/hashicorp/go-rootcerts>`
378378
- v1.0.2

0 commit comments

Comments
 (0)