Skip to content

Commit 341b017

Browse files
sarahsimpersjwilliams-mongo
authored andcommitted
(DOCSP-25520) Adds TLS steps to deploy RS and deploy sharded page (#1070)
* (DOCSP-25520) Adds TLS steps to deploy RS page * Refactors sharded cluster page, finishes RS, cleanup * Updates X509 pages * Fixes incorrect numbering * Includes change from tech review
1 parent 741299a commit 341b017

22 files changed

+454
-469
lines changed

config/redirects

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,4 @@ raw: docs/kubernetes-operator/release-notes -> ${base}/stable/release-notes/
9191
# All Versions
9292

9393
[*]: docs/kubernetes-operator/${version}/tutorial/secure-om-with-tls -> ${base}/${version}/tutorial/deploy-om-container
94+
[*]: docs/kubernetes-operator/${version}/tutorial/secure-tls -> ${base}/${version}/tutorial/deploy-replica-set
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
After you encrypt your database resource with |tls|, you can secure the
2+
following:
3+
4+
- :ref:`Client authentication with LDAP <secure-ldap-auth>`
5+
- :ref:`Client authentication with X.509 <secure-x509-auth>`
6+
- :ref:`Internal authentication with X.509 <secure-internal-auth>`

source/includes/facts/ldap-considerations.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
The procedures in this section describe the required settings and
66
provide examples of LDAP configuration.
77

8-
- To improve security, consider :ref:`configuring TLS <secure-tls>`.
8+
- To improve security, consider deploying a
9+
:ref:`TLS-encrypted replica set <tls-for-replica-set>` or a
10+
:ref:`TLS-encrypted sharded cluster <tls-for-sharded-cluster>`.
911
Encryption with |tls| is optional. By default, |ldap| traffic is sent
1012
as plain text. This means that username and password are exposed to
1113
network threats. Many modern directory services, such as Microsoft

source/includes/list-tables/ldap-settings.rst

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,9 @@
5959
| :setting:`.authentication.ldap.transportSecurity<spec.security.authentication.ldap.transportSecurity>`
6060
- | string,
6161
| optional
62-
- Set to ``tls`` to use LDAPS (LDAP over |tls|). Leave blank if your
63-
LDAP server doesn't accept TLS.
62+
- Set to ``tls`` to use LDAPS (LDAP over |tls|). Leave blank if
63+
your LDAP server doesn't accept TLS. You must enable TLS when you
64+
deploy the database resource to use this setting.
6465
- ``tls``
6566

6667
* - | ``spec.security``
@@ -84,21 +85,3 @@
8485
| required
8586
- Set to ``LDAP`` to enable authentication through LDAP.
8687
- ``LDAP``
87-
88-
* - | ``spec.security``
89-
| :setting:`.certsSecretPrefix<spec.security.certsSecretPrefix>`
90-
- | string,
91-
| optional
92-
- Add the ``<prefix>`` of the secret name that contains your
93-
MongoDB deployment's |tls| certificates.
94-
95-
.. include:: /includes/fact-example-secret-prefix-cluster-file.rst
96-
- ``devDb``
97-
98-
* - | ``spec.security``
99-
| :setting:`.tls.ca<spec.security.tls.ca>`
100-
- | string,
101-
| optional
102-
- Add the |k8s-configmap|\'s name that stores the custom |certauth|
103-
that you used to sign your deployment's |tls| certificates.
104-
- ``<custom-ca>``

source/includes/steps-deploy-k8s-replica-set-ldap.yaml

Lines changed: 7 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,5 @@
11
---
2-
ref: configure-kubectl-repl-ldap
32
stepnum: 1
4-
inherit:
5-
file: steps-configure-kubectl-namespace.yaml
6-
ref: configure-kubectl-namespace
7-
---
8-
stepnum: 2
9-
ref: create-k8s-rs-tls-secret
10-
source:
11-
file: steps-source-deploy-k8s-resource.yaml
12-
ref: create-rs-tls-secret
13-
---
14-
stepnum: 3
15-
ref: create-k8s-rs-agent-secret
16-
source:
17-
file: steps-source-deploy-k8s-resource.yaml
18-
ref: create-agent-tls-secret
19-
---
20-
stepnum: 4
21-
ref: create-k8s-rs-tls-configmap
22-
source:
23-
file: steps-source-deploy-k8s-resource.yaml
24-
ref: create-rs-tls-configmap
25-
26-
---
27-
stepnum: 5
283
ref: copy-k8s-example-rs-ldap
294
source:
305
file: steps-source-deploy-k8s-resource.yaml
@@ -47,18 +22,18 @@ replacement:
4722
:linenos:
4823
:lineno-start: 16
4924
:start-after: START-tls-replset-lower-custom
50-
:end-before: END-tls-replset-lower-custom
25+
:end-before: tls
5126
5227
---
53-
stepnum: 6
28+
stepnum: 2
5429
ref: paste-k8s-example-rs-ldap
5530
source:
5631
file: steps-source-deploy-k8s-resource.yaml
5732
ref: paste-k8s-example-resource-section
5833
replacement:
5934
k8sResource: :term:`replica set`
6035
---
61-
stepnum: 7
36+
stepnum: 3
6237
ref: k8s-add-rs-ldap
6338
source:
6439
file: steps-source-deploy-k8s-resource.yaml
@@ -67,7 +42,7 @@ replacement:
6742
k8sResource: :term:`replica set`
6843

6944
---
70-
stepnum: 8
45+
stepnum: 4
7146
ref: k8s-add-rs-ldap-agent
7247
source:
7348
file: steps-source-deploy-k8s-resource.yaml
@@ -76,15 +51,15 @@ replacement:
7651
k8sResource: :term:`replica set`
7752

7853
---
79-
stepnum: 9
54+
stepnum: 5
8055
ref: save-object-spec-rs-ldap
8156
source:
8257
file: steps-source-deploy-k8s-resource.yaml
8358
ref: save-object-spec-update
8459
replacement:
8560
k8sResource: :term:`replica set`
8661
---
87-
stepnum: 10
62+
stepnum: 6
8863
ref: start-k8s-deployment-rs-ldap
8964
source:
9065
file: steps-source-deploy-k8s-resource.yaml
@@ -93,7 +68,7 @@ replacement:
9368
k8sResource: :term:`replica set`
9469
k8sResourceType: replica-set
9570
---
96-
stepnum: 11
71+
stepnum: 7
9772
title: "Track the status of your deployment."
9873
level: 4
9974
ref: track-k8s-deployment-basic-rs-ldap
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
ref: configure-kubectl-repl
3+
stepnum: 1
4+
inherit:
5+
file: steps-configure-kubectl-namespace.yaml
6+
ref: configure-kubectl-namespace
7+
---
8+
stepnum: 2
9+
ref: create-k8s-rs-tls-secret
10+
source:
11+
file: steps-source-deploy-k8s-resource.yaml
12+
ref: create-rs-tls-secret
13+
---
14+
stepnum: 3
15+
ref: create-k8s-rs-agent-secret
16+
source:
17+
file: steps-source-deploy-k8s-resource.yaml
18+
ref: create-agent-tls-secret
19+
---
20+
stepnum: 4
21+
ref: create-k8s-rs-tls-configmap
22+
source:
23+
file: steps-source-deploy-k8s-resource.yaml
24+
ref: create-rs-tls-configmap
25+
---
26+
stepnum: 5
27+
ref: copy-k8s-example-rs
28+
source:
29+
file: steps-source-deploy-k8s-resource.yaml
30+
ref: copy-k8s-example-resource
31+
replacement:
32+
k8sResource: :term:`replica set`
33+
k8sExampleFileName: example-replica-set.yaml
34+
k8sResourceType: replica-set
35+
k8sExample: |
36+
37+
.. literalinclude:: /includes/code-examples/yaml-files/example-replica-set.yaml
38+
:language: yaml
39+
:linenos:
40+
:start-after: START-regular-replset
41+
:end-before: ...
42+
43+
.. literalinclude:: /includes/code-examples/yaml-files/example-replica-set.yaml
44+
:language: yaml
45+
:linenos:
46+
:lineno-start: 16
47+
:start-after: START-tls-replset-lower-custom
48+
:end-before: END-tls-replset-lower-custom
49+
---
50+
stepnum: 6
51+
ref: paste-k8s-example-rs
52+
source:
53+
file: steps-source-deploy-k8s-resource.yaml
54+
ref: paste-new-k8s-example-resource
55+
replacement:
56+
k8sResource: :term:`replica set`
57+
---
58+
stepnum: 7
59+
ref: change-k8s-example-rs
60+
source:
61+
file: steps-source-deploy-k8s-resource.yaml
62+
ref: change-k8s-rs-values
63+
replacement:
64+
k8sResource: :term:`replica set`
65+
---
66+
stepnum: 8
67+
ref: k8s-add-rs-tls
68+
source:
69+
file: steps-source-deploy-k8s-resource.yaml
70+
ref: add-tls-settings-custom-ca
71+
replacement:
72+
k8sResource: :term:`replica set`
73+
---
74+
stepnum: 9
75+
ref: add-other-spec-rs
76+
source:
77+
file: steps-source-deploy-k8s-resource.yaml
78+
ref: add-k8s-rs-values
79+
replacement:
80+
k8sResource: :term:`replica set`
81+
---
82+
stepnum: 10
83+
ref: save-object-spec-rs
84+
source:
85+
file: steps-source-deploy-k8s-resource.yaml
86+
ref: save-object-spec
87+
replacement:
88+
k8sResource: :term:`replica set`
89+
---
90+
stepnum: 11
91+
ref: start-k8s-deployment-rs
92+
source:
93+
file: steps-source-deploy-k8s-resource.yaml
94+
ref: start-k8s-deployment
95+
replacement:
96+
k8sResource: :term:`replica set`
97+
k8sResourceType: replica-set
98+
---
99+
stepnum: 12
100+
ref: track-k8s-deployment-rs
101+
source:
102+
file: steps-source-deploy-k8s-resource.yaml
103+
ref: track-k8s-deployment-basic
104+
replacement:
105+
k8sResource: :term:`replica set`
106+
...

source/includes/steps-deploy-k8s-replica-set-x509-custom.yaml

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,4 @@
11
---
2-
ref: configure-kubectl-repl-x509
3-
stepnum: 1
4-
inherit:
5-
file: steps-configure-kubectl-namespace.yaml
6-
ref: configure-kubectl-namespace
7-
---
8-
stepnum: 2
9-
ref: create-k8s-rs-tls-secret
10-
source:
11-
file: steps-source-deploy-k8s-resource.yaml
12-
ref: create-rs-tls-secret
13-
---
14-
stepnum: 3
15-
ref: create-k8s-rs-agent-secret
16-
source:
17-
file: steps-source-deploy-k8s-resource.yaml
18-
ref: create-agent-tls-secret
19-
---
20-
stepnum: 4
21-
ref: create-k8s-rs-tls-configmap
22-
source:
23-
file: steps-source-deploy-k8s-resource.yaml
24-
ref: create-rs-tls-configmap
25-
---
262
stepnum: 5
273
ref: copy-k8s-example-rs-x509
284
source:
@@ -58,30 +34,22 @@ replacement:
5834
k8sResource: :term:`replica set`
5935
---
6036
stepnum: 7
61-
ref: k8s-add-rs-tls
62-
source:
63-
file: steps-source-deploy-k8s-resource.yaml
64-
ref: add-tls-settings-custom-ca
65-
replacement:
66-
k8sResource: :term:`replica set`
67-
---
68-
stepnum: 8
6937
ref: k8s-add-rs-x509
7038
source:
7139
file: steps-source-deploy-k8s-resource.yaml
7240
ref: add-client-x509-settings
7341
replacement:
7442
k8sResource: :term:`replica set`
7543
---
76-
stepnum: 9
44+
stepnum: 8
7745
ref: save-object-spec-rs-x509
7846
source:
7947
file: steps-source-deploy-k8s-resource.yaml
8048
ref: save-object-spec-update
8149
replacement:
8250
k8sResource: :term:`replica set`
8351
---
84-
stepnum: 10
52+
stepnum: 9
8553
ref: start-k8s-deployment-rs-x509
8654
source:
8755
file: steps-source-deploy-k8s-resource.yaml
@@ -91,7 +59,7 @@ replacement:
9159
k8sResourceType: replica-set
9260
---
9361
title: "Track the status of your deployment."
94-
stepnum: 11
62+
stepnum: 10
9563
level: 4
9664
ref: track-k8s-deployment-rs-x509
9765
content: |

0 commit comments

Comments
 (0)