Repository navigation
RS: allow_modules_upload - #4502
Open
kaitlynmichael wants to merge 2 commits into
Open
kaitlynmichael wants to merge 2 commits into
kaitlynmichael wants to merge 2 commits into
Conversation
|
|
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 2df6b68 |
dwdougherty
approved these changes
Nov 6, 2026
dwdougherty
left a comment
dwdougherty
left a comment
Collaborator
There was a problem hiding this comment.
Just the one comment. LGTM otherwise.
| Custom module uploads are disabled by default. Before you use either `POST` endpoint on this page, a user with the admin role must set `allow_modules_upload` to `true` in the [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}}) with a [`PUT /v1/cluster`]({{< relref "/operate/rs/references/rest-api/requests/cluster#put-cluster" >}}) request. While the setting is `false`, both upload endpoints return `403 modules_upload_disabled` regardless of role. | ||
|
|
||
| Enable the setting only while you upload a module, then set it back to `false`. Custom modules run as native code on your cluster nodes, so keep the period during which they can be added as short as possible. | ||
| {{</note>}} |
Collaborator
There was a problem hiding this comment.
Use the new note specification method:
> [!NOTE]
> ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Low Risk
Documentation-only updates describing existing cluster security behavior; no runtime or API contract changes in this PR.
Overview
Documents
allow_modules_upload: user-defined module REST pages now open with a note that uploads are off by default, admins mustPUT /v1/clusterto enable,403(modules_upload_disabled) applies when disabled, and the flag should staytrueonly briefly.Both
POSTupload sections’ status-code tables now list403 Forbiddenfor that case.Recommended security practices adds a cluster-security bullet mirroring that guidance with a link to the user-defined module docs.
No product or code changes—docs alignment with RS 8.2+ behavior.
Reviewed by Cursor Bugbot for commit 2df6b68. Bugbot is set up for automated code reviews on this repo. Configure here.