Document hub.config override behavior for volumes#3815
Draft
sunu wants to merge 2 commits intojupyterhub:mainfrom
Draft
Document hub.config override behavior for volumes#3815sunu wants to merge 2 commits intojupyterhub:mainfrom
sunu wants to merge 2 commits intojupyterhub:mainfrom
Conversation
Addresses confusion from issue jupyterhub#3809 where users might expect hub.config.KubeSpawner.volumes to merge with chart-managed volumes (like the 'home' volume from singleuser.storage.static), but it actually replaces them completely. The documentation now clarifies four distinct behaviors: 1. Helm merges multiple -f files at the values level before templating as long as they are defined as dictionaries. 2. Chart-managed volumes (home, files) are set first 3. singleuser.storage.extraVolumes is merged into existing volumes - can shadow if dict keys match 4. hub.config completely replaces existing volume configuration
for more information, see https://pre-commit.ci
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
1 participant
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.
Addresses confusion from issue #3809 where users might expect
hub.config.KubeSpawner.volumesto merge with chart-managed volumes (like the 'home' volume fromsingleuser.storage.static), but it actually replaces them completely.The documentation now clarifies four distinct behaviors that happens in the following order:
home,files) are set firstsingleuser.storage.extraVolumesis merged into existing volumes - can shadow existing volumes if dict keys matchhub.config.KubeSpawner.volumescompletely replaces existing volume configurationalso addresses the documentation changes mentioned in #3690 (comment)