Skip to content

RS: clarify reserved_ports also applies to internal shard traffic - #3810

Open
tannersherman-redis wants to merge 2 commits into
mainfrom
feature/tsherman/reserve-ports-clarification
Open

RS: clarify reserved_ports also applies to internal shard traffic#3810
tannersherman-redis wants to merge 2 commits into
mainfrom
feature/tsherman/reserve-ports-clarification

Conversation

@tannersherman-redis

@tannersherman-redis tannersherman-redis commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Update the reserved_ports documentation to make clear that the setting prevents the cluster from assigning ports to internal shard traffic in addition to database endpoints. Adds 20048 to the examples in the rladmin cluster config command and the rladmin/REST API reference tables.


Note

Low Risk
Markdown-only reference updates with no product or runtime changes.

Overview
Documentation-only updates across RS networking and reference pages (versions 7.4, 7.8, 7.22, 8.0, and the main operate/rs tree).

Clarifies that reserved_ports blocks the cluster from using listed ports/ranges for database endpoints and internal shard traffic, not just endpoints. A new note after the port table states that 20000–29999 is fixed for shard traffic and that reserved_ports can still exclude specific ports or ranges inside that band from assignment.

Reserve ports prose, rladmin cluster config parameter text, and the REST cluster object field description are aligned with that behavior. Examples now include 20048 alongside existing samples to show reserving a port in the shard range.

Reviewed by Cursor Bugbot for commit 4d7f716. Bugbot is set up for automated code reviews on this repo. Configure here.

Update the reserved_ports documentation to make clear that the setting
prevents the cluster from assigning ports to internal shard traffic in
addition to database endpoints. Adds 20048 to the examples in the
rladmin cluster config command and the rladmin/REST API reference tables
@github-actions

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.22/networking/port-configurations/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.22/references/cli-utilities/rladmin/cluster/config/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.22/references/rest-api/objects/cluster/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.4/networking/port-configurations/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.4/references/rest-api/objects/cluster/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.8/networking/port-configurations/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.8/references/cli-utilities/rladmin/cluster/config/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/7.8/references/rest-api/objects/cluster/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/8.0/networking/port-configurations/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/8.0/references/cli-utilities/rladmin/cluster/config/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/8.0/references/rest-api/objects/cluster/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/networking/port-configurations/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/references/cli-utilities/rladmin/cluster/config/
https://redis.io/docs/staging/feature/tsherman/reserve-ports-clarification/operate/rs/references/rest-api/objects/cluster/

@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

@dwdougherty dwdougherty added the rs Redis Software label Aug 13, 2026
@kaitlynmichael kaitlynmichael changed the title clarify reserved_ports also applies to internal shard traffic RS: clarify reserved_ports also applies to internal shard traffic Aug 13, 2026

@kaitlynmichael kaitlynmichael left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some wording suggestions for clarity

Comment thread content/operate/rs/7.8/references/cli-utilities/rladmin/cluster/config.md Outdated
Comment thread content/operate/rs/8.0/references/cli-utilities/rladmin/cluster/config.md Outdated
Comment thread content/operate/rs/references/cli-utilities/rladmin/cluster/config.md Outdated
Comment thread content/operate/rs/references/rest-api/objects/cluster/_index.md Outdated
Comment thread content/operate/rs/8.0/references/rest-api/objects/cluster/_index.md Outdated
Comment thread content/operate/rs/7.4/references/cli-utilities/rladmin/cluster/config.md Outdated
Comment thread content/operate/rs/7.8/networking/port-configurations.md Outdated
Comment thread content/operate/rs/8.0/networking/port-configurations.md Outdated
Comment thread content/operate/rs/networking/port-configurations.md Outdated
Comment thread content/operate/rs/7.22/networking/port-configurations.md Outdated
…range behavior with reserved_ports and updated language for better clarity out of review
@CLAassistant

CLAassistant commented Aug 13, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rs Redis Software

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants