Skip to content

Commit 8ca1cfb

Browse files
(DOCSP-18055): -cert to -pem for tls filenames
1 parent 194d249 commit 8ca1cfb

8 files changed

+93
-93
lines changed

source/includes/prereqs/custom-ca-prereqs-naming-conventions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@
1111

1212
- Replace ``<X>`` with the member of a shard or replica set.
1313

14-
- End the files with ``-cert`` and *not* ``.cert``.
14+
- End the files with ``-pem`` and *not* ``.pem``.
1515
These files shouldn't have a file extension.

source/includes/prereqs/custom-ca-prereqs-rs-tls-only.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* - Your custom |certauth|
1010
- ``ca-pem``
1111
* - Each member of your replica set
12-
- ``<metadata.name>-<X>-cert``
12+
- ``<metadata.name>-<X>-pem``
1313

1414
.. include:: /includes/prereqs/pem-file-description.rst
1515

source/includes/prereqs/custom-ca-prereqs-rs-tls-x509-internal.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* - Your custom |certauth|
1010
- ``ca-pem``
1111
* - Each member of your replica set
12-
- ``<metadata.name>-<X>-cert``
12+
- ``<metadata.name>-<X>-pem``
1313
* - Your project's Automation or MongoDB Agent
1414
- ``mms-automation-agent-pem``
1515
* - Your project's Backup Agent (if needed)

source/includes/prereqs/custom-ca-prereqs-sc-tls-only.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
* - Your custom |certauth|
1010
- ``ca-pem``
1111
* - Each shard in your sharded cluster
12-
- ``<metadata.name>-<Y>-<X>-cert``
12+
- ``<metadata.name>-<Y>-<X>-pem``
1313
* - Each member of your config server replica set
14-
- ``<metadata.name>-config-<X>-cert``
14+
- ``<metadata.name>-config-<X>-pem``
1515
* - Each |mongos|
16-
- ``<metadata.name>-mongos-<X>-cert``
16+
- ``<metadata.name>-mongos-<X>-pem``
1717

1818
.. include:: /includes/prereqs/custom-ca-prereqs-naming-conventions.rst

source/includes/prereqs/custom-ca-prereqs-sc-tls-x509-internal.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99
* - Your custom |certauth|
1010
- ``ca-pem``
1111
* - Each shard in your sharded cluster
12-
- ``<metadata.name>-<Y>-<X>-cert``
12+
- ``<metadata.name>-<Y>-<X>-pem``
1313
* - Each member of your config server replica set
14-
- ``<metadata.name>-config-<X>-cert``
14+
- ``<metadata.name>-config-<X>-pem``
1515
* - Each |mongos|
16-
- ``<metadata.name>-mongos-<X>-cert``
16+
- ``<metadata.name>-mongos-<X>-pem``
1717
* - Your project's Automation or MongoDB Agent
1818
- ``mms-automation-agent-pem``
1919
* - Your project's Backup Agent (if needed)

source/includes/prereqs/custom-ca-prereqs.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99
* - Your custom |certauth|
1010
- ``ca-pem``
1111
* - Each member of your replica set
12-
- ``<metadata.name>-<X>-cert``
12+
- ``<metadata.name>-<X>-pem``
1313
* - Your project's Automation or MongoDB Agent
1414
- ``mms-automation-agent-pem``
1515
* - Your project's Backup Agent (if needed)
1616
- ``mms-backup-agent-pem``
1717
* - Your project's Monitoring Agent (if needed)
1818
- ``mms-monitoring-agent-pem``
1919
* - Each shard in your sharded cluster
20-
- ``<metadata.name>-<Y>-<X>-cert``
20+
- ``<metadata.name>-<Y>-<X>-pem``
2121
* - Each member of your config server replica set
22-
- ``<metadata.name>-config-<X>-cert``
22+
- ``<metadata.name>-config-<X>-pem``
2323
* - Each |mongos|
24-
- ``<metadata.name>-mongos-<X>-cert``
24+
- ``<metadata.name>-mongos-<X>-pem``
2525

2626
.. include:: /includes/prereqs/custom-ca-prereqs-naming-conventions.rst

source/includes/steps-source-deploy-k8s-resource.yaml

Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,9 +1023,9 @@ content: |
10231023
.. code-block:: sh
10241024
10251025
kubectl create secret generic <metadata.name>-cert \
1026-
--from-file=<metadata.name>-0-cert \
1027-
--from-file=<metadata.name>-1-cert \
1028-
--from-file=<metadata.name>-2-cert
1026+
--from-file=<metadata.name>-0-pem \
1027+
--from-file=<metadata.name>-1-pem \
1028+
--from-file=<metadata.name>-2-pem
10291029
10301030
This example covers a three-member replica set. If you have more than
10311031
three members, you can add them to the certificate using the
@@ -1044,9 +1044,9 @@ content: |
10441044
.. code-block:: sh
10451045
10461046
kubectl create secret generic <metadata.name>-cert \
1047-
--from-file=<metadata.name>-0-cert \
1048-
--from-file=<metadata.name>-1-cert \
1049-
--from-file=<metadata.name>-2-cert \
1047+
--from-file=<metadata.name>-0-pem \
1048+
--from-file=<metadata.name>-1-pem \
1049+
--from-file=<metadata.name>-2-pem \
10501050
--dry-run=client \
10511051
-o yaml |
10521052
kubectl apply -f -
@@ -1068,9 +1068,9 @@ content: |
10681068
.. code-block:: sh
10691069
10701070
kubectl create secret generic <metadata.name>-clusterfile \
1071-
--from-file=<metadata.name>-0-cert \
1072-
--from-file=<metadata.name>-1-cert \
1073-
--from-file=<metadata.name>-2-cert
1071+
--from-file=<metadata.name>-0-pem \
1072+
--from-file=<metadata.name>-1-pem \
1073+
--from-file=<metadata.name>-2-pem
10741074
10751075
This example covers a three-member replica set. If you have more than
10761076
three members, you can add them to the certificate using the
@@ -1089,9 +1089,9 @@ content: |
10891089
.. code-block:: sh
10901090
10911091
kubectl create secret generic <metadata.name>-clusterfile \
1092-
--from-file=<metadata.name>-0-cert \
1093-
--from-file=<metadata.name>-1-cert \
1094-
--from-file=<metadata.name>-2-cert \
1092+
--from-file=<metadata.name>-0-pem \
1093+
--from-file=<metadata.name>-1-pem \
1094+
--from-file=<metadata.name>-2-pem \
10951095
--dry-run=client \
10961096
-o yaml |
10971097
kubectl apply -f -
@@ -1127,18 +1127,18 @@ content: |
11271127
.. code-block:: sh
11281128
11291129
kubectl -n mongodb create secret generic <metadata.name>-0-cert \
1130-
--from-file=<metadata.name>-0-0-cert \
1131-
--from-file=<metadata.name>-0-1-cert \
1132-
--from-file=<metadata.name>-0-2-cert \
1133-
--from-file=<metadata.name>-0-3-cert \
1134-
--from-file=<metadata.name>-0-4-cert
1130+
--from-file=<metadata.name>-0-0-pem \
1131+
--from-file=<metadata.name>-0-1-pem \
1132+
--from-file=<metadata.name>-0-2-pem \
1133+
--from-file=<metadata.name>-0-3-pem \
1134+
--from-file=<metadata.name>-0-4-pem
11351135
11361136
kubectl -n mongodb create secret generic <metadata.name>-1-cert \
1137-
--from-file=<metadata.name>-1-0-cert \
1138-
--from-file=<metadata.name>-1-1-cert \
1139-
--from-file=<metadata.name>-1-2-cert \
1140-
--from-file=<metadata.name>-1-3-cert \
1141-
--from-file=<metadata.name>-1-4-cert
1137+
--from-file=<metadata.name>-1-0-pem \
1138+
--from-file=<metadata.name>-1-1-pem \
1139+
--from-file=<metadata.name>-1-2-pem \
1140+
--from-file=<metadata.name>-1-3-pem \
1141+
--from-file=<metadata.name>-1-4-pem
11421142
11431143
This example covers a two-shard sharded cluster with five members per
11441144
shard. If you have more than two shards or five members per shard,
@@ -1157,21 +1157,21 @@ content: |
11571157
.. code-block:: sh
11581158
11591159
kubectl -n mongodb create secret generic <metadata.name>-0-cert \
1160-
--from-file=<metadata.name>-0-0-cert \
1161-
--from-file=<metadata.name>-0-1-cert \
1162-
--from-file=<metadata.name>-0-2-cert \
1163-
--from-file=<metadata.name>-0-3-cert \
1164-
--from-file=<metadata.name>-0-4-cert \
1160+
--from-file=<metadata.name>-0-0-pem \
1161+
--from-file=<metadata.name>-0-1-pem \
1162+
--from-file=<metadata.name>-0-2-pem \
1163+
--from-file=<metadata.name>-0-3-pem \
1164+
--from-file=<metadata.name>-0-4-pem \
11651165
--dry-run=client \
11661166
-o yaml |
11671167
kubectl apply -f -
11681168
11691169
kubectl -n mongodb create secret generic <metadata.name>-1-cert \
1170-
--from-file=<metadata.name>-1-0-cert \
1171-
--from-file=<metadata.name>-1-1-cert \
1172-
--from-file=<metadata.name>-1-2-cert \
1173-
--from-file=<metadata.name>-1-3-cert \
1174-
--from-file=<metadata.name>-1-4-cert \
1170+
--from-file=<metadata.name>-1-0-pem \
1171+
--from-file=<metadata.name>-1-1-pem \
1172+
--from-file=<metadata.name>-1-2-pem \
1173+
--from-file=<metadata.name>-1-3-pem \
1174+
--from-file=<metadata.name>-1-4-pem \
11751175
--dry-run=client \
11761176
-o yaml |
11771177
kubectl apply -f -
@@ -1193,9 +1193,9 @@ content: |
11931193
.. code-block:: sh
11941194
11951195
kubectl -n mongodb create secret generic <metadata.name>-config-cert \
1196-
--from-file=<metadata.name>-config-0-cert \
1197-
--from-file=<metadata.name>-config-1-cert \
1198-
--from-file=<metadata.name>-config-2-cert
1196+
--from-file=<metadata.name>-config-0-pem \
1197+
--from-file=<metadata.name>-config-1-pem \
1198+
--from-file=<metadata.name>-config-2-pem
11991199
12001200
---
12011201
title: "Renew the |k8s-secret| for your config server's TLS certificates."
@@ -1210,9 +1210,9 @@ content: |
12101210
.. code-block:: sh
12111211
12121212
kubectl -n mongodb create secret generic <metadata.name>-config-cert \
1213-
--from-file=<metadata.name>-config-0-cert \
1214-
--from-file=<metadata.name>-config-1-cert \
1215-
--from-file=<metadata.name>-config-2-cert \
1213+
--from-file=<metadata.name>-config-0-pem \
1214+
--from-file=<metadata.name>-config-1-pem \
1215+
--from-file=<metadata.name>-config-2-pem \
12161216
--dry-run=client \
12171217
-o yaml |
12181218
kubectl apply -f -
@@ -1230,9 +1230,9 @@ content: |
12301230
.. code-block:: sh
12311231
12321232
kubectl -n mongodb create secret generic <metadata.name>-mongos-cert \
1233-
--from-file=<metadata.name>-mongos-0-cert \
1234-
--from-file=<metadata.name>-mongos-1-cert \
1235-
--from-file=<metadata.name>-mongos-2-cert
1233+
--from-file=<metadata.name>-mongos-0-pem \
1234+
--from-file=<metadata.name>-mongos-1-pem \
1235+
--from-file=<metadata.name>-mongos-2-pem
12361236
12371237
---
12381238
title: "Renew the |k8s-secret| for your mongos server's TLS certificates."
@@ -1247,9 +1247,9 @@ content: |
12471247
.. code-block:: sh
12481248
12491249
kubectl -n mongodb create secret generic <metadata.name>-mongos-cert \
1250-
--from-file=<metadata.name>-mongos-0-cert \
1251-
--from-file=<metadata.name>-mongos-1-cert \
1252-
--from-file=<metadata.name>-mongos-2-cert \
1250+
--from-file=<metadata.name>-mongos-0-pem \
1251+
--from-file=<metadata.name>-mongos-1-pem \
1252+
--from-file=<metadata.name>-mongos-2-pem \
12531253
--dry-run=client \
12541254
-o yaml |
12551255
kubectl apply -f -
@@ -1267,18 +1267,18 @@ content: |
12671267
.. code-block:: sh
12681268
12691269
kubectl -n mongodb create secret generic <metadata.name>-0-clusterfile \
1270-
--from-file=<metadata.name>-0-0-cert \
1271-
--from-file=<metadata.name>-0-1-cert \
1272-
--from-file=<metadata.name>-0-2-cert \
1273-
--from-file=<metadata.name>-0-3-cert \
1274-
--from-file=<metadata.name>-0-4-cert
1270+
--from-file=<metadata.name>-0-0-pem \
1271+
--from-file=<metadata.name>-0-1-pem \
1272+
--from-file=<metadata.name>-0-2-pem \
1273+
--from-file=<metadata.name>-0-3-pem \
1274+
--from-file=<metadata.name>-0-4-pem
12751275
12761276
kubectl -n mongodb create secret generic <metadata.name>-1-clusterfile \
1277-
--from-file=<metadata.name>-1-0-cert \
1278-
--from-file=<metadata.name>-1-1-cert \
1279-
--from-file=<metadata.name>-1-2-cert \
1280-
--from-file=<metadata.name>-1-3-cert \
1281-
--from-file=<metadata.name>-1-4-cert
1277+
--from-file=<metadata.name>-1-0-pem \
1278+
--from-file=<metadata.name>-1-1-pem \
1279+
--from-file=<metadata.name>-1-2-pem \
1280+
--from-file=<metadata.name>-1-3-pem \
1281+
--from-file=<metadata.name>-1-4-pem
12821282
12831283
This example covers a two-shard sharded cluster with five members per
12841284
shard. If you have more than two shards or five members per shard,
@@ -1297,21 +1297,21 @@ content: |
12971297
.. code-block:: sh
12981298
12991299
kubectl -n mongodb create secret generic <metadata.name>-0-clusterfile \
1300-
--from-file=<metadata.name>-0-0-cert \
1301-
--from-file=<metadata.name>-0-1-cert \
1302-
--from-file=<metadata.name>-0-2-cert \
1303-
--from-file=<metadata.name>-0-3-cert \
1304-
--from-file=<metadata.name>-0-4-cert \
1300+
--from-file=<metadata.name>-0-0-pem \
1301+
--from-file=<metadata.name>-0-1-pem \
1302+
--from-file=<metadata.name>-0-2-pem \
1303+
--from-file=<metadata.name>-0-3-pem \
1304+
--from-file=<metadata.name>-0-4-pem \
13051305
--dry-run=client \
13061306
-o yaml |
13071307
kubectl apply -f -
13081308
13091309
kubectl -n mongodb create secret generic <metadata.name>-1-clusterfile \
1310-
--from-file=<metadata.name>-1-0-cert \
1311-
--from-file=<metadata.name>-1-1-cert \
1312-
--from-file=<metadata.name>-1-2-cert \
1313-
--from-file=<metadata.name>-1-3-cert \
1314-
--from-file=<metadata.name>-1-4-cert \
1310+
--from-file=<metadata.name>-1-0-pem \
1311+
--from-file=<metadata.name>-1-1-pem \
1312+
--from-file=<metadata.name>-1-2-pem \
1313+
--from-file=<metadata.name>-1-3-pem \
1314+
--from-file=<metadata.name>-1-4-pem \
13151315
--dry-run=client \
13161316
-o yaml |
13171317
kubectl apply -f -
@@ -1333,9 +1333,9 @@ content: |
13331333
.. code-block:: sh
13341334
13351335
kubectl -n mongodb create secret generic <metadata.name>-config-clusterfile \
1336-
--from-file=<metadata.name>-config-0-cert \
1337-
--from-file=<metadata.name>-config-1-cert \
1338-
--from-file=<metadata.name>-config-2-cert
1336+
--from-file=<metadata.name>-config-0-pem \
1337+
--from-file=<metadata.name>-config-1-pem \
1338+
--from-file=<metadata.name>-config-2-pem
13391339
13401340
---
13411341
title: "Renew the |k8s-secret| for your config server's X.509 certificates."
@@ -1350,9 +1350,9 @@ content: |
13501350
.. code-block:: sh
13511351
13521352
kubectl -n mongodb create secret generic <metadata.name>-config-clusterfile \
1353-
--from-file=<metadata.name>-config-0-cert \
1354-
--from-file=<metadata.name>-config-1-cert \
1355-
--from-file=<metadata.name>-config-2-cert \
1353+
--from-file=<metadata.name>-config-0-pem \
1354+
--from-file=<metadata.name>-config-1-pem \
1355+
--from-file=<metadata.name>-config-2-pem \
13561356
--dry-run=client \
13571357
-o yaml |
13581358
kubectl apply -f -
@@ -1370,9 +1370,9 @@ content: |
13701370
.. code-block:: sh
13711371
13721372
kubectl -n mongodb create secret generic <metadata.name>-mongos-clusterfile \
1373-
--from-file=<metadata.name>-mongos-0-cert \
1374-
--from-file=<metadata.name>-mongos-1-cert \
1375-
--from-file=<metadata.name>-mongos-2-cert
1373+
--from-file=<metadata.name>-mongos-0-pem \
1374+
--from-file=<metadata.name>-mongos-1-pem \
1375+
--from-file=<metadata.name>-mongos-2-pem
13761376
13771377
---
13781378
title: "Renew the |k8s-secret| for your mongos server's X.509 certificates."
@@ -1387,9 +1387,9 @@ content: |
13871387
.. code-block:: sh
13881388
13891389
kubectl -n mongodb create secret generic <metadata.name>-mongos-clusterfile \
1390-
--from-file=<metadata.name>-mongos-0-cert \
1391-
--from-file=<metadata.name>-mongos-1-cert \
1392-
--from-file=<metadata.name>-mongos-2-cert \
1390+
--from-file=<metadata.name>-mongos-0-pem \
1391+
--from-file=<metadata.name>-mongos-1-pem \
1392+
--from-file=<metadata.name>-mongos-2-pem \
13931393
--dry-run=client \
13941394
-o yaml |
13951395
kubectl apply -f -

source/includes/steps-source-deploy-om-resource.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content: |
77
88
Verify that each member of the Replica Set has one |tls| certificate named with the following format:
99
10-
``<resource-name>-db-<index>-cert``
10+
``<resource-name>-db-<index>-pem``
1111
1212
Where ``<index>`` is a 0-based index number to the total amount of
1313
members minus one. (``0`` to ``n-1``)
@@ -24,9 +24,9 @@ content: |
2424
.. code-block:: sh
2525
2626
kubectl create secret generic appdb-cert \
27-
--from-file=om-appdb-tls-enabled-db-0-cert \
28-
--from-file=om-appdb-tls-enabled-db-1-cert \
29-
--from-file=om-appdb-tls-enabled-db-2-cert
27+
--from-file=om-appdb-tls-enabled-db-0-pem \
28+
--from-file=om-appdb-tls-enabled-db-1-pem \
29+
--from-file=om-appdb-tls-enabled-db-2-pem
3030
3131
``kubectl`` creates one Secret containing the three certificates.
3232

0 commit comments

Comments
 (0)