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

Document how to connect a JupyterHub to a binderhub with jupyterhub-fancy-profiles #3691

Closed
3 tasks
yuvipanda opened this issue Feb 3, 2024 · 3 comments · Fixed by 2i2c-org/binderhub-service#82
Assignees

Comments

@yuvipanda
Copy link
Member

This is part of the work with the GESIS grant, following up on https://2i2c.org/blog/2024/jupyterhub-binderhub-gesis/.

This is a follow-up to 2i2c-org/binderhub-service#72.

Me and @simaattar2003 worked through this in a video session a few weeks ago. I need to encode that in a document, so she can try it out end to end herself. We have a meeting scheduled for Thurdsay Feb 8, so this needs to be done before that.

Things that would need to be documented:

  • How to connect a jupyterhub to the binderhub by setting up the appropriate service entry as well as base_url
  • How to get jupyterhub-fancy-profiles enabled on the hub - this may involve a custom image, or something else. tbd.
  • Set up a sample profile to make sure the setup in imagebuilding-demo is replicatable
@yuvipanda yuvipanda self-assigned this Feb 3, 2024
@yuvipanda
Copy link
Member Author

When we were testing this, we just used the hub image that is built by 2i2c for use in our hubs. However, I don't think this is a good long term plan. So I'm going to autobuild images based on the z2jh hub image but with fancy-profiles setup.

In yuvipanda/jupyterhub-fancy-profiles#12

@yuvipanda
Copy link
Member Author

This went great! Here are some notes on changes to make in the docs

  • Note that you may also use a LoadBalancer instead
  • Turn the paranthetical into a sentence in the paragraph about creating the artifact registry
  • It says 'click next' in the service account, but it's actually a button named 'continue' now
  • Clarify how to indent the service account key correctly
  • Formatting on the sub-bullet points on z2jh service account stuff is not formatted correctly
  • Add that we're going to shared loadbalancer
  • -o name will put service/ in front of the names of services, and we should clarify that
  • Clarify how exactly to find latest version of the helm chart
  • Make a note that you must add a slash at the end of /services/binder
  • Clarify how the latest tag or appropriate tag for z2jh-fancy-profiles is to be set up
  • Note about using quotations in the yaml around tag
  • Remove YAML anchor in the config
  • Note about how folks may validate config?
  • Clarify that the services part should still be there under hub.config - not be replaced
  • Should clarify that you should not go to /services/binder for final test
  • Document that any username & any password will get you in

@yuvipanda
Copy link
Member Author

I've incorporated most of these suggestions into 2i2c-org/binderhub-service#82 now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done 🎉
Development

Successfully merging a pull request may close this issue.

1 participant