Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-14389

Investigate changes in SERVER-55827: Rename security.clusterIpSourceWhitelist to security.clusterIpSourceAllowList

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.0.0-rc0
    • Component/s: manual, Server
    • Labels:
      None

      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.)

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              alison.huh Alison Huh (Inactive)
              Reporter:
              backlog-server-pm Backlog - Core Eng Program Management Team
              Participants:
              Last commenter:
              Alison Huh Alison Huh (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Due:
                Created:
                Updated:
                Resolved:
                Days since reply:
                8 weeks, 3 days ago
                Date of 1st Reply: