[DOCS-12175] Docs for SERVER-37815: Support multiple keys in the keyfile format Created: 01/Nov/18  Updated: 13/Nov/23  Resolved: 15/Nov/18

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.1.5, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Kay Kim (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-37815 Support multiple keys in the keyfile ... Closed
Participants:
Days since reply: 5 years, 12 weeks, 6 days ago
Epic Link: DOCS: 4.2 Server/Tools

 Description   

Description

Description:

The file specified by the --keyFile or security.keyFile option is now a YAML file instead of a plain text file. This should be fully backwards compatible with old keys and all the same rules about key formats (base64 characters only with whitespace stripped) are still in place, but the underlying file format is YAML now (i.e. you could escape characters or even add comments) . This is in preparation for supporting multiple keys during the keyfile rollover procedure.

Engineering Ticket Description:

As part of the keyfile rollover project we'll need to support loading multiple keys from disk. This ticket changes the format of the keyfile to YAML to support that.

Scope of changes

  • The usual
  • note that keyfile for local key management only accepts one key

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 15/Nov/18 ]

Author:

{'name': 'kay', 'email': 'kay.kim@10gen.com', 'username': 'kay-kim'}

Message: DOCS-12175: 4.2 - keyfile for internal auth use yaml fmt
Branch: master
https://github.com/mongodb/docs/commit/83b39ece08ad5911ee160387261d6fac10da24ff

Generated at Thu Feb 08 08:04:34 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.