Skip to content

Commit ae3919a

Browse files
authored
(DOCSP-39139) Release notes for 1.25, licensing updates and prep for the release (#1706)
* (DOCSP-39139) Release notes for 1.25, licensing updates and prep for the release * Edits, to be continued * Edits * Edits * Changed version to a variable, per comment from Lukasz * Include copy review comments from Sarah
1 parent ea770fc commit ae3919a

11 files changed

+219
-65
lines changed

config/redirects

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
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 v1.22 v1.23 v1.24 master
6-
symlink: v1.25 -> 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 v1.23 v1.24 v1.25 master
6+
symlink: v1.26 -> master
77
symlink: upcoming -> master
88

99
########

source/includes/list-tables/compatibility-k8s-os.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
- OpenShift Version
1010

1111
* - 1.25
12-
- April 24, 2024
13-
- April 24, 2025
12+
- April 30, 2024
13+
- April 30, 2025
1414
- 1.27, 1.28, 1.29
1515
- 4.14
1616

source/includes/list-tables/compatibility-mdb.rst

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,13 @@
1-
.. important::
2-
3-
Starting with the |k8s-op-short| 1.17 release, Ubuntu base images are
4-
deprecated. Ubuntu base images are removed in the |k8s-op-short|
5-
1.19 release. MongoDB continues to support the Red Hat UBI 8 base images.
6-
To provide feedback about this change, use the `MongoDB Feedback Engine
7-
<https://feedback.mongodb.com/forums/924355-ops-tools?category_id=370990>`__.
8-
91
.. list-table::
102
:header-rows: 1
113
:widths: 50 50
124

135
* - |k8s-op-short| Release Series
146
- Base Image
157

8+
* - 1.25.x
9+
- Red Hat UBI 8 Base Image
10+
1611
* - 1.24.x
1712
- Red Hat UBI 8 Base Image
1813

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* - 1.25.x
99
- 6.0, 7.0
1010

11-
* - 1.24.x
11+
* - 1.24.x
1212
- 6.0, 7.0
1313

1414
* - 1.23.x

source/reference/k8s-operator-multi-cluster-specification.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -395,8 +395,7 @@ Optional ``MongoDBMultiCluster`` Resource Settings
395395
Key-value pairs that let you add cloud provider-specific
396396
configuration settings to a specific cluster in your |multi-cluster|. This setting overrides the global
397397
setting, :ref:`spec.externalAccess.externalService.annotations <multi-spec-externalaccess-externalservice-annotations>`.
398-
To learn more, see |k8s-annotations| and
399-
and the documentation for your |k8s| cloud provider.
398+
To learn more, see |k8s-annotations| and the documentation for your |k8s| cloud provider.
400399

401400
.. include:: /includes/list-tables/annotation-placeholders-multi-cluster.rst
402401

source/reference/support-lifecycle.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Considerations
2222

2323
- Versioning of the |k8s-op-short| doesn't follow the semantic versioning
2424
convention. A major version of the |k8s-op-short| is X.X, for example,
25-
1.22 or 1.23.
25+
1.24 or 1.25.
2626

2727
- The End of Life dates in this section might be subject to change.
2828

@@ -33,6 +33,9 @@ Considerations
3333
* - |k8s-op-short| Version
3434
- End of Life Date
3535

36+
* - 1.25.x
37+
- 2025-04-30
38+
3639
* - 1.24.x
3740
- 2024-12-21
3841

source/release-notes.txt

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

15+
.. _ent-op-1.25.x:
16+
17+
|k8s-op-full| 1.25 Series
18+
-------------------------
19+
20+
.. _ent_op-1.25.0:
21+
22+
|k8s-op-full| 1.25.0
23+
~~~~~~~~~~~~~~~~~~~~
24+
25+
*Released 2024-04-30*
26+
27+
Breaking Change
28+
`````````````````
29+
30+
- **``MongoDBOpsManager``** resource. The |k8s-op-short| no longer supports
31+
|onprem| 5.0. Upgrade to a later version of |onprem|. While |onprem| 5.0
32+
may continue to work with the |k8s-op-short|, MongoDB won't test the
33+
|k8s-op-short| against |onprem| 5.0.
34+
35+
New Features
36+
`````````````
37+
38+
- **``MongoDBOpsManager``** resource: Adds support for deploying the |application|
39+
on multiple |k8s| clusters. To learn more, see :ref:`deploy-om-multi-cluster`.
40+
- (Public Preview) **``MongoDB``, ``OpsManager``** resources: Introduces
41+
opt-in :ref:`static-containers` for all types of deployments.
42+
43+
- In this release, use static containers only for testing purposes.
44+
Static containers might become the default in a later release.
45+
- To activate static containers mode, set the ``MDB_DEFAULT_ARCHITECTURE``
46+
environment variable at the |k8s-op-short| level to ``static``.
47+
Alternatively, annotate a specific ``MongoDB`` or ``OpsManager``
48+
custom resource with ``mongodb.com/v1.architecture: "static"``.
49+
- The |k8s-op-short| supports seamless migration between the static and
50+
non-static architectures. To learn more, see:
51+
52+
- :ref:`Use Static Containers <static-containers>`
53+
- :ref:`Migrate to Static Containers <migrate-to-static-containers>`
54+
55+
- **``OpsManager``** resource: Adds the ``spec.internalConnectivity`` field
56+
to allow overrides for the service used by the |k8s-op-short| to ensure
57+
internal connectivity to the ``OpsManager`` resource-hosting Pods.
58+
59+
- **``MongoDB``** resource: You can recover a resource due to a broken
60+
Automation configuration in sharded clusters. In previous releases,
61+
you could recover other types of resources but not sharded clusters.
62+
To learn more, see :ref:`troubleshooting-automatic-recovery`.
63+
64+
- **``MongoDB``, ``MongoDBMultiCluster``** resources: These resources now
65+
allow you to add placeholders in external services.
66+
67+
- You can define |k8s-annotations| for external services managed by the |k8s-op-short|
68+
that contain placeholders which will be automatically replaced by the proper values.
69+
Previously, the |k8s-op-short| configured the same annotations for all
70+
external services created for each Pod. Starting with this release,
71+
you can add placeholders so that the |k8s-op-short| can customize
72+
annotations in each service with values that are relevant and unique
73+
for each particular Pod. To learn more, see:
74+
75+
- ``MongoDB`` resource: :setting:`spec.externalAccess.externalService.annotations`
76+
- ``MongoDBMultiCluster`` resource :ref:`spec.externalAccess.externalService.annotations <multi-spec-externalaccess-externalservice-annotations>`
77+
78+
- The |kubectl-mongodb|: Allows you to print build information when
79+
using the plugin.
80+
- The ``setup`` command of the |kubectl-mongodb|: Adds the
81+
:ref:`registry.imagePullSecrets <imagePullSecrets>` setting.
82+
If specified, created service accounts reference the specified secret on
83+
the ``imagePullSecrets`` field.
84+
- Improves handling of configurations when the |k8s-op-short| watches more
85+
than one namespace, and when you install the |k8s-op-short| in a namespace
86+
that differs from the namespace in which the |k8s-op-short| watches resources.
87+
88+
- Optimizes setting up roles and permissions in member |k8s| clusters
89+
using a single service account per |k8s| cluster with correctly configured
90+
roles and role bindings (no cluster roles are necessary) for each watched
91+
namespace.
92+
93+
- Extends the existing event-based reconciliation process by a time-based
94+
reconciliation that is triggered every 24 hours. This ensures that all
95+
Monitoring Agents are always upgraded in a timely manner.
96+
97+
- OpenShift and OLM Operator: Removes the requirement for cluster-wide
98+
permissions. Previously, the |k8s-op-short| needed these permissions to
99+
configure admission webhooks. Starting with this release, webhooks are
100+
automatically configured by `OLM <https://olm.operatorframework.io/docs/advanced-tasks/adding-admission-and-conversion-webhooks/>`__.
101+
102+
- Adds an optional ``MDB_WEBHOOK_REGISTER_CONFIGURATION`` environment
103+
variable for the |k8s-op-short|. The variable controls whether the |k8s-op-short|
104+
should perform automatic admission webhook configuration. The default is ``true``.
105+
The variable is set to ``false`` for OLM and OpenShift deployments.
106+
107+
Helm Chart Installation Changes
108+
`````````````````````````````````
109+
110+
- Adds a new ``operator.webhook.registerConfiguration`` parameter that
111+
controls whether the |k8s-op-short| should perform an automatic admission
112+
webhook configuration by setting the ``MDB_WEBHOOK_REGISTER_CONFIGURATION``
113+
environment variable for the |k8s-op-short|. The default is ``true``.
114+
The variable is set to ``false`` for OLM and OpenShift deployments.
115+
116+
- Changes the default ``agent.version`` to ``107.0.0.8502-1``. This changes
117+
the default Agent used in |k8s-op-short| deployments that you install using
118+
a Helm chart.
119+
120+
- Adds the ``operator.additionalArguments`` variable with the default of
121+
``[]`` to allow you to pass additional arguments for the |k8s-op-short| binary.
122+
- Adds the ``operator.createResourcesServiceAccountsAndRoles`` variable
123+
with the default of ``true`` to control whether to install roles and
124+
service accounts for ``MongoDB`` and ``OpsManager`` resources. When you
125+
use the |kubectl-mongodb| to configure the |k8s-op-short| for
126+
a multi-|k8s| cluster deployment, the plugin installs all necessary
127+
roles and service accounts. Therefore, to avoid clashes, in some cases
128+
don't install those roles using the |k8s-op-short| Helm chart.
129+
130+
Bug Fixes
131+
```````````
132+
133+
- **``MongoDBMultiCluster``** resource: Fixes an issue where the |k8s-op-short|
134+
reported that ``spec.externalAccess.externalDomain`` and
135+
``spec.clusterSpecList[*].externalAccess.externalDomains`` fields were
136+
required even though they weren't used. The |k8s-op-short| prematurely
137+
triggered a validation for these fields in cases where the custom resources
138+
contained a defined ``spec.externalAccess`` structure. Starting with this
139+
release, the |k8s-op-short| checks for uniqueness of external domains only
140+
when you define the external domains in ``spec.externalAccess.externalDomain``
141+
or ``spec.clusterSpecList[*].externalAccess.externalDomains`` settings.
142+
143+
- **``MongoDB``** resource: Fixes a bug where upon deleting a ``MongoDB`` resource,
144+
the ``controlledFeature`` policies remained set on the related |onprem| or
145+
|cloud-short| instance, making cleanup in the UI impossible in the case
146+
of losing the |k8s-op-short|.
147+
148+
- **``OpsManager``** resource: Fixes an issue where the ``admin-key`` secret
149+
was deleted when you removed the ``OpsManager`` custom resource.
150+
Fixing the ``admin-key`` secret deletion enables easier re-installation of |onprem|.
151+
152+
- **MongoDB Readiness Probe**: Fixes a misleading error message for the
153+
readiness probe: ``"... kubelet Readiness probe failed:..."``. This affects
154+
all MongoDB deployments.
155+
156+
- **Operator**: Fixes cases where in some instances, while communicating with
157+
the ``OpsManager`` custom resource, the |k8s-op-short| skipped TLS verification,
158+
even if you enabled TLS.
159+
160+
Improvements
161+
```````````````
162+
163+
- **Kubectl plugin**: The released |kubectl-mongodb| binaries are now signed, and the
164+
signatures are published with the `release assets <https://github.com/mongodb/mongodb-enterprise-kubernetes/releases>`__.
165+
The public key is available at `this address <https://cosign.mongodb.com/mongodb-enterprise-kubernetes-operator.pem>`__.
166+
The released |kubectl-mongodb| binaries are also notarized for MacOS.
167+
168+
- **Released Images signed**: All container images published for the |k8s-op-short|
169+
are cryptographically signed. This is visible in the MongoDB |quay| registry.
170+
You can verify the signatures using the MongoDB public key. Released images
171+
are available at `this address <https://cosign.mongodb.com/mongodb-enterprise-kubernetes-operator.pem>`__.
172+
15173
.. _ent-op-1.24.x:
16174

17175
|k8s-op-full| 1.24 Series

0 commit comments

Comments
 (0)