[FSTORE-2086] Add support for disabling Uploads to Hopsworks - #632
Draft
manu-sj wants to merge 1 commit into
Draft
[FSTORE-2086] Add support for disabling Uploads to Hopsworks#632manu-sj wants to merge 1 commit into
manu-sj wants to merge 1 commit into
Conversation
https://hopsworks.atlassian.net/browse/FSTORE-2086 Documents the upload_policy configuration on the Cluster Configuration page: the three values, that the backend enforces the policy so it covers the Python API as well as the UI, and that the two ways of setting it interact, since a value from the Helm chart is reapplied on every upgrade and overrides a change made from the Configuration page. States the limits explicitly, because "uploads disabled" reads as stronger than it is. The policy governs uploading new files only, so it does not stop a library being installed from a requirements file already in a project, and it does not remove files uploaded earlier. No nav entry is needed; the section is added to an existing page. Signed-off-by: Manu Sathyarajan Joseph <manu.joseph@logicalclocks.com> Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Part of FSTORE-2086. Backend PR: logicalclocks/hopsworks-ee#3224
What
Documents the new
upload_policycluster configuration on the Cluster Configuration page: the three values (enabled,admins_only,disabled), that the backend enforces the policy so it covers the Python API as well as the UI, and that a refused upload returns HTTP 403 while the UI disables the controls instead.Why these particular points are called out
enabled. Documented so an operator who mistypes the value does not assume uploads are blocked when they are not.Placement
Added as a section on
setup_installation/admin/variables.mdrather than a new page. That page is the Cluster Configuration reference, and no page in the repo documents individual variables, so there was no per-variable reference to extend. Nomkdocs.ymlnav change is needed for a section on an existing page.Follows the repo conventions: one sentence per line, and no restriction stated without its reason.
Testing
npx markdownlint-cli2 docs/setup_installation/admin/variables.md— 0 errors.The full
mkdocs build -swas not run; it needs the uv environment plus thehopsworks-apiinstall for the API docs section, and this change adds no new page, link, or nav entry that a build would newly validate.Ticket: https://hopsworks.atlassian.net/browse/FSTORE-2086