Enable ability to not filter kernels in container deployments #1131
Conversation
This file contains 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
bloomsa
reviewed
Jul 13, 2022
bloomsa
reviewed
Jul 17, 2022
Comment on lines
36
to
39
| allowed_kernels_option="--KernelSpecManager.whitelist=[${EG_KERNEL_WHITELIST}]" | ||
| if [ "${EG_KERNEL_WHITELIST}" == 'null' ]; then | ||
| allowed_kernels_option="" | ||
| fi |
There was a problem hiding this comment.
I think it makes more sense to have allowed_kernels_option default to "". Then change the if to check if "${EG_KERNEL_WHITELIST}" != 'null' and set the flag inside the if.
There was a problem hiding this comment.
Good idea. I also switched the default value to null since I found that the docker-compose.yaml script includes the Docker-based kernel specs.
bloomsa
approved these changes
Jul 18, 2022
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.
As discussed in #1127, there is currently no way to easily enable dynamic kernelspec additions to containerized deployments because the deployment scripts always specific kernelspec entries. Since dynamic kernelspec additions are default behaviors (when kernelspecs are not explicitly listed in the configuration), we should enable similar support in containerized deployments. This pull request enables that functionality.
The
start-enterprise-gateway.shthat is theCMDin the enterprise-gateway image has been modified to detect if theEG_KERNEL_WHITELISTenv has a value ofnull. When that value is detected, the--KernelSpecManager.whitelistcommand-line option is omitted, thereby exposing all kernelspecs configured into the image. It is presumed that deployments wishing to dynamically add kernelspec definitions have mounted the/usr/local/share/jupyter/kernelsdirectory (or otherwise made its update available). Updates made to that directory will be automatically picked up when kernelspecs are refreshed.A value of
nullwas used forEG_KERNEL_WHITELISTto make this determination because that is the value Helm will set when thewhitelist:entry of thevalues.yamlhas no entries. This allows operators to easily remove (or comment out) all existing kernelspec entries to enable this functionality.Resolves: #1127