Skip to content

Commit 226f8fd

Browse files
DOCSP-15287 remove multiple key string references (#2824)
* DOCSP-15287 remove multiple key string references * DOCSP-15287 remove multiple key string tab * DOCSP-15287 remove multiple key string tab * DOCSP-15287 nit fix * DOCSP-15287 internal feedback
1 parent f430665 commit 226f8fd

File tree

3 files changed

+11
-50
lines changed

3 files changed

+11
-50
lines changed

source/core/security-internal-authentication.txt

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -73,25 +73,12 @@ For example,
7373
content: |
7474

7575
If the keyfile contains a single key, you can specify the key
76-
string with or without quotes
76+
string with or without quotes:
7777

7878
.. code-block:: yaml
7979

8080
my old secret key1
8181

82-
- id: multiple-key-strings
83-
name: Multiple Key Strings
84-
content: |
85-
86-
You can specify multiple key strings
87-
[#exclude-encryption-keyfile]_ where each key string is
88-
**enclosed in quotes**:
89-
90-
.. code-block:: yaml
91-
92-
'my old secret key1'
93-
'my new secret key2'
94-
9582
- id: multiple-key-sequence
9683
name: Multiple Key Sequence
9784
content: |

source/includes/extracts-4.2-changes.yaml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,11 @@ content: |
8383
8484
Starting in MongoDB 4.2, :ref:`keyfiles for internal membership
8585
authentication <internal-auth-keyfile>` use YAML format to allow for
86-
multiple keys in a keyfile. The YAML format accepts content of:
86+
multiple keys in a keyfile. The YAML format accepts either:
8787
88-
- a single key string (same as in earlier versions),
88+
- A single key string (same as in earlier versions)
8989
90-
- multiple key strings (each string must be enclosed in quotes), or
91-
92-
- sequence of key strings.
90+
- A sequence of key strings
9391
9492
The YAML format is compatible with the existing single-key
9593
keyfiles that use the text file format.

source/tutorial/rotate-key-sharded-cluster.txt

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Rotate Keys for Sharded Clusters
44

55
.. default-domain:: mongodb
66

7-
8-
97
Sharded cluster members can use :ref:`keyfiles <internal-auth-keyfile>`
108
to authenticate each other as memers of the same deployment.
119

@@ -52,9 +50,7 @@ Procedure
5250
1. Modify the Keyfile to Include Old and New Keys
5351
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5452

55-
Modify each member's keyfile to include both the old and new keys. You
56-
can specify multiple keys either as strings enclosed in quotes or as a
57-
sequence of keys.
53+
Modify each member's keyfile to include both the old and new keys.
5854

5955
.. warning::
6056

@@ -63,34 +59,14 @@ sequence of keys.
6359
keyfile using any method you choose (e.g. ``openssl rand -base64
6460
756``, etc.).
6561

66-
.. tabs::
67-
68-
tabs:
69-
70-
- id: multiple-key-strings
71-
name: Multiple Key Strings
72-
content: |
73-
74-
You can specify multiple key strings where each key
75-
string is **enclosed in quotes**
76-
77-
.. figure:: /images/example-multiple-keys1.png
78-
:alt: Image of multiple key strings.
79-
:figwidth: 600px
80-
81-
82-
- id: multiple-key-sequence
83-
name: Multiple Key Sequence
84-
content: |
85-
86-
You can specify multiple key strings as a sequence of key
87-
strings (optionally enclosed in quotes):
62+
You can specify multiple key strings as a sequence of key strings (optionally
63+
enclosed in quotes):
8864

89-
.. figure:: /images/example-multiple-keys2.png
90-
:alt: Image of multiple key string sequence.
91-
:figwidth: 600px
65+
.. figure:: /images/example-multiple-keys2.png
66+
:alt: Image of multiple key string sequence.
67+
:figwidth: 600px
9268

93-
2. Restart Each Member
69+
1. Restart Each Member
9470
~~~~~~~~~~~~~~~~~~~~~~
9571

9672
Once all the keyfiles contain both the old and new keys, restart each

0 commit comments

Comments
 (0)