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

Provide setup instructions for installing binderhub-service #72

Merged
merged 9 commits into from
Jan 16, 2024

Conversation

yuvipanda
Copy link
Member

No description provided.

@yuvipanda
Copy link
Member Author

Partial livestream of me trying out and making this PR here: https://www.youtube.com/watch?v=WMymAqFd6mQ

yuvipanda and others added 2 commits December 20, 2023 12:46
Worked through these with @simaattar2003 and made these
changes.

Co-authored-by: simaattar2003 <seema.attar2003@gmail.com>
Copy link
Member

@consideRatio consideRatio left a comment

Choose a reason for hiding this comment

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

Thank you for writing these @yuvipanda!!!

For reference, some related content:

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Comment on lines +158 to +177
10. Let's verify that _image building and pushing_ works. Access the binderhub pod by following the
same instructions as step 3. But this time, you should see a binderhub page very similar to that
on [mybinder.org](https://mybinder.org). You can test build a repository here - I recommend trying
out `binder-examples/requirements`. It might take a while to build, but you should be able to see
logs in the UI. It should succeed at _pushing_ the github image, but will fail to launch. The last
lines in the log in the UI should look like:

```
Successfully pushed europe-west10-docker.pkg.dev/binderhub-service-development/bh-service-test/binderbinder-2dexamples-2drequirements-55ab5c:50533eb470ee6c24e872043d30b2fee463d6943fBuilt image, launching...
Launching server...
Launch attempt 1 failed, retrying...
Launch attempt 2 failed, retrying...
```

You can also go back to the Google Artifact Registry repository you created earlier to verify that the built
image is indeed there.

11. Now that we have verified this is working, we can disable the binderhub UI as we will not be using it.
Remove the `config.BinderHub.enable_api_only_mode` configuration from the binderhub config, and redeploy
using the command from step 9.
Copy link
Member

Choose a reason for hiding this comment

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

This is acceptable as it is. An alternative test can be to do:

# this is the test from the github workflow testing things as well btw
curl http://localhost:8585/build/gh/binderhub-ci-repos/cached-minimal-dockerfile/HEAD?build_only=true

I think I'd favor use of curl as it highlights this is the role of binderhub-service now - API level access to build/push to be consumed by non-binderhub provided UI.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'd like to keep this one as is for now, hope that's ok.

Copy link
Member Author

Choose a reason for hiding this comment

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

I also spent today with Sima working on how to connect a JupyterHub to this, and I believe the GUI check 'flows' much better.

Co-authored-by: Erik Sundell <erik.i.sundell@gmail.com>
@yuvipanda yuvipanda merged commit dc276fe into main Jan 16, 2024
2 checks passed
@yuvipanda
Copy link
Member Author

Thanks, @consideRatio!

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
Status: Done 🎉
Development

Successfully merging this pull request may close these issues.

2 participants