[DOCS-14389] Investigate changes in SERVER-55827: Rename security.clusterIpSourceWhitelist to security.clusterIpSourceAllowList Created: 28/Apr/21  Updated: 13/Nov/23  Due: 23/Jul/21  Resolved: 26/Jul/21

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

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Alison Huh
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-55827 Rename security.clusterIpSourceWhitel... Closed
Participants:
Days since reply: 2 years, 28 weeks, 2 days ago
Epic Link: DOCSP-9747
Story Points: 2

 Description   

Description

Downstream Change Summary

This ticket deprecates the `security.clusterIpSourceWhitelist` option and updates it to `security.clusterIpSourceAllowlist`. The deprecated `security.clusterIpSourceWhitelist` still functions as an alias to `security.clusterIpSourceAllowlist`, but the updated terminology should be used wherever possible.
Documentation should replace the description for the `security.clusterIpWhitelist` option with an identical one for `security.clusterIpAllowlist`.

Description of Linked Ticket

This ticket will rename the IDL definition and all instances of security.clusterIpSourceWhitelist to security.clusterIpSourceAllowList. In addition, it will also do the following:

  • Create low-visibility aliases from the deprecated to modern options to ensure backwards compatibility
  • Make existing tests and bundled manual pages use the new configuration option
  • Create a single isolated test to validate correct behaviour of the alias

Scope of changes

Do a grep for "clusterIpSourceWhitelist". (Does not look like a lot of areas of the docs are affected here).

As noted in the downstream change summary, we should replace the description for the `security.clusterIpWhitelist` option with an identical one for `security.clusterIpAllowlist`. We should also update the description to mention the deprecation, so that if users search the page for the outdated option, they can see what they should use instead.

Also we'll need to update the 5.0 compatibility notes.

Impact to Other Docs

MVP (Work and Date)

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



 Comments   
Comment by Githook User [ 26/Jul/21 ]

Author:

{'name': 'alisonjhuh', 'email': 'alison.huh@mongodb.com'}

Message: DOCS-14389 swap deprecated whitelist language for allowlist
Branch: master
https://github.com/mongodb/docs/commit/0be947b9de933f8d69e9f69fc95c97c61de22ac4

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