Skip to content

Commit 4a3797a

Browse files
authored
(DOCSP-26751) Remove spec.security.tls.secretRef setting from the custom resource types (#1150)
* (DOCSP-26751) Remove spec.security.tls.secretRef setting from the custom resource types * Fix build warnings, remove refs to very old 1.3 deprecation notes spotted by chance * Added certsSecretPrefix to examples per review from Raj
1 parent 85baac8 commit 4a3797a

7 files changed

+8
-116
lines changed

source/includes/options-k8s-replica-set.yaml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -545,13 +545,6 @@ inherit:
545545
file: options-k8s-shared.yaml
546546
---
547547
program: k8sRsConf
548-
name: spec.security.tls.secretRef.prefix
549-
inherit:
550-
name: spec.security.tls.secretRef.prefix
551-
program: _shared
552-
file: options-k8s-shared.yaml
553-
---
554-
program: k8sRsConf
555548
name: spec.security.authentication.modes
556549
inherit:
557550
name: spec.security.authentication.modes

source/includes/options-k8s-shared.yaml

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -318,14 +318,6 @@ description: |
318318
319319
.. include:: /includes/admonitions/fact-k8s-operator-manages-configmap.rst
320320
321-
*(Changed in version 1.3)*:
322-
323-
In prior versions of the |k8s-op|, this setting was
324-
``spec.project``. See the
325-
:v1.2:`v1.2 documentation
326-
</reference/k8s-operator-specification/#spec.project>`
327-
for information on the previous setting name.
328-
329321
---
330322
program: _shared
331323
name: spec.cloudManager.configMapRef.name
@@ -605,27 +597,6 @@ description: |
605597
606598
---
607599
program: _shared
608-
name: spec.security.tls.secretRef.prefix
609-
type: string
610-
directive: setting
611-
optional: true
612-
description: |
613-
Text to prefix to the |k8s| |k8s-secrets| that you
614-
created that contain your replica set's or sharded cluster's |tls|
615-
keys and certificates.
616-
617-
.. note::
618-
619-
If set, the value of :setting:`spec.security.tls.secretRef.prefix`
620-
overrides the value of :setting:`spec.security.certsSecretPrefix`.
621-
622-
You must prefix your secrets with ``<prefix>-<metadata.name>``.
623-
624-
To learn more about naming the secrets that contain your |tls|
625-
certificates, see the topic in :ref:`secure-tls` that applies to your
626-
deployment.
627-
---
628-
program: _shared
629600
name: spec.security.certsSecretPrefix
630601
type: string
631602
directive: setting
@@ -636,11 +607,6 @@ description: |
636607
created that contain your replica set's or sharded cluster's |tls|
637608
keys and certificates.
638609
639-
.. note::
640-
641-
If set, the value of the :setting:`spec.security.tls.secretRef.prefix`
642-
overrides the value of :setting:`spec.security.certsSecretPrefix`.
643-
644610
.. include:: /includes/fact-req-secret-prefix.rst
645611
646612
.. include:: /includes/fact-example-secret-prefix-cluster-file.rst
@@ -1265,14 +1231,6 @@ description: |
12651231
After you enable internal cluster authentication, you can't disable
12661232
it.
12671233
1268-
*(Changed in version 1.3)*:
1269-
1270-
In prior versions of the |k8s-op|, this setting was
1271-
``spec.security.clusterAuthenticationMode``. See the
1272-
:v1.2:`v1.2 documentation
1273-
</reference/k8s-operator-specification/#spec.security.clusterAuthenticationMode>`
1274-
for information on the previous setting name.
1275-
12761234
---
12771235
program: _shared
12781236
name: spec.exposedExternally

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

Lines changed: 1 addition & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -221,11 +221,6 @@ Optional |onprem| Resource Settings
221221
created that contains your application database's |tls| key and
222222
certificate.
223223

224-
.. note::
225-
226-
If set, the value of :opsmgrkube:`spec.applicationDatabase.security.tls.secretRef.prefix`
227-
overrides the value of :opsmgrkube:`spec.applicationDatabase.security.certsSecretPrefix`.
228-
229224
You must name your secret ``<prefix>-<metadata.name>-db-cert``.
230225

231226
To learn how to configure your |onprem| instance to run over
@@ -244,29 +239,6 @@ Optional |onprem| Resource Settings
244239
Encrypts communications using |tls| certificates between |onprem| and
245240
the application database.
246241

247-
.. opsmgrkube:: spec.applicationDatabase.security.tls.secretRef.prefix
248-
249-
*Type*: string
250-
251-
.. important::
252-
253-
:opsmgrkube:`spec.applicationDatabase.security.tls.secretRef.prefix`
254-
is deprecated and will be removed in a future release. Use
255-
:opsmgrkube:`spec.applicationDatabase.security.certsSecretPrefix`
256-
instead.
257-
258-
Text to prefix to the |k8s| |k8s-secret| that contain your application database's |tls| key and
259-
certificate.
260-
261-
.. note::
262-
263-
If set, the value of
264-
:opsmgrkube:`spec.applicationDatabase.security.tls.secretRef.prefix`
265-
overrides the value of
266-
:opsmgrkube:`spec.applicationDatabase.security.certsSecretPrefix`.
267-
268-
To learn how to configure your |onprem| instance to run over
269-
|https|, see :ref:`deploy-om-container`.
270242

271243
.. opsmgrkube:: spec.backup.enabled
272244

@@ -766,6 +738,7 @@ Optional |onprem| Resource Settings
766738
</tutorials/services/source-ip/>` in the |k8s| documentation.
767739

768740
.. note::
741+
769742
If you select ``Cluster``, the ``Source-IP`` of your clients are
770743
lost during the network hops that happen at the |k8s|
771744
network boundary.
@@ -811,12 +784,6 @@ Optional |onprem| Resource Settings
811784
Text to prefix to the |k8s| |k8s-secret| that you
812785
created that contain |onprem|\'s |tls| key and certificate.
813786

814-
.. note::
815-
816-
If set, the value of
817-
:opsmgrkube:`spec.security.tls.secretRef.prefix` overrides the
818-
value of :opsmgrkube:`spec.security.certsSecretPrefix`.
819-
820787
You must name your secret ``<prefix>-<metadata.name>-cert``.
821788

822789
To learn how to configure your |onprem| instance to run over
@@ -856,28 +823,6 @@ Optional |onprem| Resource Settings
856823
Encrypts communications using |tls| certificates between clients and
857824
|onprem|.
858825

859-
.. opsmgrkube:: spec.security.tls.secretRef.prefix
860-
861-
.. important::
862-
863-
:opsmgrkube:`spec.security.tls.secretRef.prefix`
864-
is deprecated and will be removed in a future release. Use
865-
:opsmgrkube:`spec.security.certsSecretPrefix`
866-
instead.
867-
868-
Text to prefix to the |k8s| |k8s-secret| that contains the |onprem| |tls| key and
869-
certificate.
870-
871-
.. note::
872-
873-
If set, the value of
874-
:opsmgrkube:`spec.security.tls.secretRef.prefix`
875-
overrides the value of
876-
:opsmgrkube:`spec.security.certsSecretPrefix`.
877-
878-
To learn how to configure your |onprem| instance to run over
879-
|https|, see :ref:`deploy-om-container`.
880-
881826
.. opsmgrkube:: spec.statefulSet.spec
882827

883828
*Type*: collection

source/reference/k8s-operator-specification.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,6 @@ cluster resource types:
347347
.. include:: /includes/option/setting-k8sRsConf-spec.security.tls.enabled.rst
348348
.. include:: /includes/option/setting-k8sRsConf-spec.security.tls.ca.rst
349349
.. include:: /includes/option/setting-k8sRsConf-spec.security.certsSecretPrefix.rst
350-
.. include:: /includes/option/setting-k8sRsConf-spec.security.tls.secretRef.prefix.rst
351350
.. include:: /includes/option/setting-k8sRsConf-spec.security.tls.additionalCertificateDomains.rst
352351
.. include:: /includes/option/setting-k8sRsConf-spec.additionalMongodConfig.net.ssl.mode.rst
353352
.. include:: /includes/option/setting-k8sRsConf-spec.security.authentication.rst

source/reference/k8s/replicasetpodspec.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ metadata:
55
name: my-replica-set
66
spec:
77
members: 3
8-
version: "4.2.2-ent"
8+
version: "4.4.0-ent"
99
service: my-service
1010
opsManager: # Alias of cloudManager
1111
configMapRef:
@@ -57,10 +57,9 @@ spec:
5757
topologyKey: "mykey"
5858
weight: 50
5959
security:
60+
certsSecretPrefix: "prefix"
6061
tls:
61-
enabled: true
62-
secretRef:
63-
prefix: "prefix"
62+
ca: custom-ca
6463
authentication:
6564
enabled: true
6665
modes: ["X509"]

source/reference/k8s/shardedclusterpodspec.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ spec:
88
mongodsPerShardCount: 3
99
mongosCount: 2
1010
configServerCount: 3
11-
version: "4.2.2-ent"
11+
version: "4.4.0-ent"
1212
service: my-service
1313
type: ShardedCluster
1414

@@ -97,10 +97,9 @@ spec:
9797
journal:
9898
commitIntervalMs: 50
9999
security:
100+
certsSecretPrefix: "prefix"
100101
tls:
101-
enabled: true
102-
secretRef:
103-
prefix: "prefix"
102+
ca: custom-ca
104103
authentication:
105104
enabled: true
106105
modes: ["X509"]

source/tutorial/create-project-using-configmap.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ apply to your Kubernetes environment.
2929
Considerations
3030
--------------
3131

32-
Starting in |k8s-op-full| version 1.3.0, you can only deploy one
33-
MongoDB resource per project. See :ref:`k8s-deploy-mdb-resources`.
32+
You can only deploy one MongoDB resource per project. See :ref:`k8s-deploy-mdb-resources`.
3433

3534
.. include:: /includes/admonitions/note-k8s-supported-in-om4.rst
3635

0 commit comments

Comments
 (0)