Skip to content

Commit c0ea38b

Browse files
authored
(DOCSP-26486) Updated release notes for 1.17.0 and removed info about upgrading old-style certs, because this support is fully removed in 1.17 (#1130)
* (DOCSP-26486) Updated release notes for 1.17.0 and removed info about upgrading old-style certs, because this support is fully removed in 1.17 * Fixing warnings in the build * Added trailing slashes to all redirects that were missing them * A few edits * Fixed some old relnotes
1 parent 6d2a7b8 commit c0ea38b

File tree

9 files changed

+42
-205
lines changed

9 files changed

+42
-205
lines changed

config/redirects

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,32 @@ symlink: stable -> v1.17
1212
# Base URL
1313
raw: docs/kubernetes-operator/ -> ${base}/stable/
1414

15+
# Add redirects for the complete removal of old-style tls certs and the EOL of MEKO # v1.11 that required special treatment of appdb version:
16+
[v1.17-*]: docs/kubernetes-operator/${version}/tutorial/migrate-to-ent-appdb-version -> ${base}/stable/release-notes/#k8s-op-full-1-11-0/
17+
[v1.17-*]: docs/kubernetes-operator/${version}/tutorial/migrate-to-new-tls-format -> ${base}/stable/release-notes/#k8s-op-full-1-13-0/
18+
1519
# redirect for removal of multi-cluster quick start overview:
16-
[*-v1.12]: docs/kubernetes-operator/${version}/multi-cluster-quick-start-overview -> ${base}/stable/multi-cluster
20+
[*-v1.12]: docs/kubernetes-operator/${version}/multi-cluster-quick-start-overview -> ${base}/stable/multi-cluster/
1721

1822
# Add redirects related to the addition of new topics for multi-cluster
1923
# beta security in the Operator v1.16.x, and single cluster LDAP:
2024

21-
[*-v1.15]: docs/kubernetes-operator/${version}/multi-cluster-secure-client-connections -> ${base}/stable/multi-cluster-secure-client-connections
22-
[*-v1.15]: docs/kubernetes-operator/${version}/multi-cluster-secure-ldap-auth -> ${base}/stable/multi-cluster-secure-ldap-auth
23-
[*-v1.15]: docs/kubernetes-operator/${version}/tutorial/secure-client-connections -> ${base}/stable/tutorial/secure-client-connections
24-
[*-v1.15]: docs/kubernetes-operator/${version}/tutorial/secure-ldap-auth -> ${base}/tutorial/secure-ldap-auth
25+
[*-v1.15]: docs/kubernetes-operator/${version}/multi-cluster-secure-client-connections -> ${base}/stable/multi-cluster-secure-client-connections/
26+
[*-v1.15]: docs/kubernetes-operator/${version}/multi-cluster-secure-ldap-auth -> ${base}/stable/multi-cluster-secure-ldap-auth/
27+
[*-v1.15]: docs/kubernetes-operator/${version}/tutorial/secure-client-connections -> ${base}/stable/tutorial/secure-client-connections/
28+
[*-v1.15]: docs/kubernetes-operator/${version}/tutorial/secure-ldap-auth -> ${base}/tutorial/secure-ldap-auth/
2529

2630
# Add redirects related to the addition of new topics for multi-cluster
2731
# beta in the Operator v1.13.
2832

29-
[*-v1.12]: docs/kubernetes-operator/${version}/multi-cluster -> ${base}/stable/multi-cluster
30-
[*-v1.12]: docs/kubernetes-operator/${version}/multi-cluster-quick-start -> ${base}/stable/multi-cluster
31-
[*-v1.12]: docs/kubernetes-operator/${version}/multi-cluster-arch -> ${base}/stable/multi-cluster
33+
[*-v1.12]: docs/kubernetes-operator/${version}/multi-cluster -> ${base}/stable/multi-cluster/
34+
[*-v1.12]: docs/kubernetes-operator/${version}/multi-cluster-quick-start -> ${base}/stable/multi-cluster/
35+
[*-v1.12]: docs/kubernetes-operator/${version}/multi-cluster-arch -> ${base}/stable/multi-cluster/
3236

3337
# Add redirects related to the removal of
3438
# /tutorial/migrate-to-single-resource. This topic was added initially
3539
# for v1.3 that is now EOL.
36-
[v1.11-*]: docs/kubernetes-operator/${version}/tutorial/migrate-to-single-resource -> ${base}/stable/release-notes/#k8s-op-full-1-11-0
40+
[v1.11-*]: docs/kubernetes-operator/${version}/tutorial/migrate-to-single-resource -> ${base}/stable/release-notes/#k8s-op-full-1-11-0/
3741

3842

3943
# Fix problematic redirects that omitted /stable (DOCSP-4989)

source/includes/facts/fact-appdb-version-specified.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.

source/includes/prereqs/pem-format.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@
33
The |k8s-op-short| uses :k8sdocs:`kubernetes.io/tls
44
</concepts/configuration/secret/#tls-secrets>` secrets
55
to store |tls| certificates and private keys for |onprem| and MongoDB
6-
resources. Starting in |k8s-op-short| version 1.17, the
7-
|k8s-op-short| doesn't support concatenated |pem| files stored as :k8sdocs:`Opaque secrets </concepts/configuration/secret/#opaque-secrets>`.
8-
9-
To migrate your |pem| files stored as Opaque secrets |tls| secrets to :k8sdocs:`kubernetes.io/tls
10-
</concepts/configuration/secret/#tls-secrets>` secrets, see
11-
:ref:`migrate-to-new-tls-format`.
6+
resources. Starting in |k8s-op-short| version 1.17.0, the
7+
|k8s-op-short| doesn't support concatenated |pem| files stored as
8+
:k8sdocs:`Opaque secrets </concepts/configuration/secret/#opaque-secrets>`.
129

1310
.. include:: /includes/fact-broken-appdb.rst

source/release-notes.txt

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -152,12 +152,19 @@ This release:
152152
A migration guide for existing users will be published soon.
153153

154154
- Removes support for |tls| certificates in concatenated |pem| format.
155-
These certificates were deprecated in |k8s-op-short| 1.13.0. Before
156-
upgrading to |k8s-op-short| 1.17.0, migrate your |pem| files stored as
157-
:k8sdocs:`Opaque secrets </concepts/configuration/secret/#opaque-secrets>`
158-
to :k8sdocs:`kubernetes.io/tls </concepts/configuration/secret/#tls-secrets>`
159-
secrets. For detailed instructions, see
160-
:ref:`Upgrade from Kubernetes Operator 1.12 with TLS Enabled <migrate-to-new-tls-format>`.
155+
These certificates were deprecated in |k8s-op-short| 1.13.0.
156+
If you want to use these certificates, the last version to which you
157+
can upgrade is |k8s-op-short| 1.16.4.
158+
159+
Starting with the |k8s-op-short| 1.17.0 release, you must manually
160+
migrate old-style |tls| secrets from opaque to
161+
:k8sdocs:`kubernetes.io/tls </concepts/configuration/secret/#tls-secrets>`
162+
type secrets by creating new secrets that contain the relevant
163+
certificates and signing keys. To learn how to create these secrets,
164+
see the following resources:
165+
166+
- :ref:`secure-tls`
167+
- :ref:`secure-internal-auth`
161168

162169
.. _ent-op-1.16.x:
163170

@@ -187,18 +194,17 @@ MongoDB Resource
187194
MongoDB Resource
188195
````````````````
189196

190-
- Fixed a bug where `securityContext defined at the Pod level wouldn't
191-
be respected as the operator would override it with a
192-
`securityContext` at the container level. See the
193-
`description <https://docs-mongodbcom-staging.corp.mongodb.com/docs-k8s-operator/docsworker-xlarge/DOCSP-23623/reference/k8s-operator-specification.html#spec.persistent>`__
194-
of the `spec.persistent` setting for more information.
197+
- Fixed a bug where ``securityContext`` defined at the Pod level is not
198+
respected as the |k8s-op-short| overrides it with a
199+
``securityContext`` at the container level. To learn more, see the
200+
description of the :setting:`spec.persistent` setting.
195201

196-
- Adds `timeoutMS`, and `userCacheInvalidationInterval` fields to the
197-
`spec.security.authentication.ldap` object.
202+
- Adds ``timeoutMS``, and ``userCacheInvalidationInterval`` fields to the
203+
``spec.security.authentication.ldap`` object.
198204

199-
- Fixes behavior where the `additionalMongodConfig.net.tls.mode` setting
200-
was ignored for `mongos`, `configSrv`, and `shard` objects when
201-
configuring `ShardedCluster` resources.
205+
- Fixes behavior where the ``additionalMongodConfig.net.tls.mode`` setting
206+
was ignored for ``mongos``, ``configSrv``, and ``shard`` objects when
207+
configuring ``ShardedCluster`` resources.
202208

203209
.. _ent_op-1.16.2:
204210

@@ -790,12 +796,12 @@ New Images
790796

791797
- Beginning with this release, you can use any version of MongoDB
792798
for the Application Database. You must specify this version
793-
explicitly when you deploy the ``MongoDBOpsManager`` resource.
794-
795-
.. include:: /includes/facts/fact-which-appdb-version.rst
799+
explicitly when you deploy the ``MongoDBOpsManager`` resource.
796800

797801
- To upgrade the |k8s-op-short|, you must specify the Application
798-
Database's version. For more information, see :ref:`migrate-to-ent-appdb-version`.
802+
Database's version. Check that the :opsmgrkube:`spec.applicationDatabase.version`
803+
has a value in your configuration files for the ``MongoDBOpsManager``
804+
custom resource deployment.
799805

800806
- Each Application Database Pod consists of the following containers
801807
(instead of one container with a bundled MongoDB version, as in previous

source/tutorial/deploy-standalone.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,6 @@ Prerequisites
3232

3333
.. include:: /includes/prereqs-deploy-resource.rst
3434

35-
Considerations
36-
--------------
37-
38-
.. include:: /includes/facts/fact-appdb-version-specified.rst
39-
4035
Procedure
4136
---------
4237

source/tutorial/migrate-to-ent-appdb-version.txt

Lines changed: 0 additions & 63 deletions
This file was deleted.

source/tutorial/migrate-to-new-tls-format.txt

Lines changed: 0 additions & 85 deletions
This file was deleted.

source/tutorial/upgrade-k8s-operator.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,4 @@ to its latest version.
2020

2121
.. include:: /includes/fact-broken-appdb.rst
2222

23-
.. admonition:: Upgrading to version 1.11.0 and later
24-
:class: warning
25-
26-
.. include:: /includes/facts/fact-appdb-version-specified.rst
27-
2823
.. include:: /includes/install/upgrade-k8s-operator.rst

source/upgrade.txt

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,6 @@ Upgrade the |k8s-op-short| from Prior Versions
1717
:ref:`upgrade-k8s-operator`
1818
Upgrade the |k8s-op-short| to its latest version.
1919

20-
:ref:`migrate-to-ent-appdb-version`
21-
Migrate the Application Database to the latest MongoDB version.
22-
23-
:ref:`migrate-to-new-tls-format`
24-
Migrate opaque |tls| secrets from |k8s-op-short| 1.12 or earlier to
25-
secrets of the :k8sdocs:`kubernetes.io/tls
26-
</concepts/configuration/secret/#tls-secrets>` type.
2720

2821
:ref:`migrate-k8s-images`
2922
Migrate your |k8s-op-short| deployments from Ubuntu-based container
@@ -35,6 +28,4 @@ Upgrade the |k8s-op-short| from Prior Versions
3528
:titlesonly:
3629

3730
/tutorial/upgrade-k8s-operator
38-
/tutorial/migrate-to-ent-appdb-version
39-
/tutorial/migrate-to-new-tls-format
4031
/tutorial/migrate-k8s-images

0 commit comments

Comments
 (0)