Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make idle culler settings configurable from the nebari-config.yaml #1689

Merged
merged 3 commits into from
Apr 5, 2023

Conversation

iameskild
Copy link
Member

Reference Issues or PRs

Closes #1283

This PR makes it so users can configure the JupyterLab idle-culler settings directly from their nebari-config.yaml. The pattern that I used to achieve this was with a Terraform templatefile, which is a pattern that I believe we can use to modify other configuration files in the future (this might include the .bashrc and similar files).

I still need to add documentation for this but to change the idle-culler settings, you can add the following to your nebari-config.yaml:

jupyterlab:
  idle_culler:
    server_shutdown_no_activity_timeout: 100
    kernel_cull_connected: true

Any subset of the idle culler settings can be configured like this. By default, the jupyterlab key is not included.

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Any other comments?

@iameskild iameskild added type: enhancement 💅🏼 New feature or request needs: review 👀 This PR is complete and ready for reviewing area: JupyterLab needs: documentation 📖 This item is missing docs labels Mar 31, 2023
@iameskild iameskild added this to the Release 2023.4.1 milestone Mar 31, 2023
@viniciusdc
Copy link
Contributor

Thanks, @iameskild I will have a look in a few minutes

Copy link
Contributor

@viniciusdc viniciusdc left a comment

Choose a reason for hiding this comment

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

LGTM, I will try deploying a local instance to do a quick test.

Copy link
Contributor

@viniciusdc viniciusdc left a comment

Choose a reason for hiding this comment

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

Working as expected, I tested in a local deployment but this should also work for the cloud providers as well

@iameskild iameskild self-assigned this Apr 5, 2023
@iameskild
Copy link
Member Author

Awesome! Thanks @viniciusdc!

For to be sure, I tested these on the GCP as well 👍

@viniciusdc
Copy link
Contributor

Hi @iameskild we both tested and all seams working, I will go ahead and merge this one.

@viniciusdc viniciusdc merged commit eb42385 into develop Apr 5, 2023
@viniciusdc viniciusdc deleted the idle_culler_configurable branch April 5, 2023 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: JupyterLab needs: documentation 📖 This item is missing docs needs: review 👀 This PR is complete and ready for reviewing type: enhancement 💅🏼 New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

[ENH] - Make idle culler settings easily configurable and documented how to change
2 participants