-
Notifications
You must be signed in to change notification settings - Fork 367
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
[Okpy] Remove the authenticator as it is no longer used #691
Conversation
There is exactly one installation of okpy in the world - at https://okpy.org/. It's primarily used only by UC Berkeley, and this authenticator was used for a short period of time at one of the hubs run by UC Berkeley. However, it has *not* been used there for many years, and there are no ongoing plans for it to be used ever again. I can speak reasonably authoritatively on this, given I helped run those hubs from inception until very recently. Given there are not really any other okpy installations in the world, I think it's actually safe to remove this one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @yuvipanda and @minrk!
@yuvipanda @manics @minrk @GeorgianaElena I'd like to conclude how we should version next release of I think in a way this should be a 17.0.0 release, but if we feel confident this is fine to remove, I'd much rather we don't do that and go for 16.1.1. I think z2jh / tljh should major version bump if we bump dependencies directly configured by admins (such as I have two ideas on how to go about this, what do you think?
|
Okpy seems to be open-source https://github.com/okpy . How certain are we that no one is using it privately? |
@manics 99.999% certain! https://github.com/okpy/ok is the serverside code, but I also know it's not all the serverside code (there are non-public components, but mostly because there are secrets embedded in that repo, not for any other reason). So purely based on that, I'd think there aren't any other installations. @consideRatio I would not consider this a breaking change, so (1) seems simplest. I also don't think it necessarily needs released right away - can just be rolled in whenever the next release rolls out. |
👍 on considering this as not breaking then, and release in any kind of next version release. If there is someone using this, they can transition to configuration like this. c.JupyterHub.authenticator_class = "generic"
c.GenericOAuthenticator.authorize_url = "https://okpy.org/oauth/authorize"
c.GenericOAuthenticator.token_url = "https://okpy.org/oauth/token"
c.GenericOAuthenticator.userdata_url = "https://okpy.org/api/v3/user"
c.GenericOAuthenticator.scope = ["email"]
c.GenericOAuthenticator.username_claim = "email"
# userdata_params is configured because otherwise all responses from the API are
# wrapped in an envelope that contains metadata about the response.
# ref: https://okpy.github.io/documentation/ok-api.html
c.GenericOAuthenticator.userdata_params = {"envelope": "false"}
# and other common config
c.OAuthenticator.oauth_callback_url = "https://[your-domain]/hub/oauth_callback"
c.OAuthenticator.client_id = "[your oauth2 application id]"
c.OAuthenticator.client_secret = "[your oauth2 application secret]" |
These were removed in jupyterhub/oauthenticator#691, and now the link checker is not happy.
These were removed in jupyterhub/oauthenticator#691, and now the link checker is not happy.
There is exactly one installation of okpy in the world - at https://okpy.org/. It's used only by UC Berkeley, and this authenticator was used for a short period of time at one of the hubs run by UC Berkeley. However, it has not been used there for many years, and there are no ongoing plans for it to be used ever again. I can speak reasonably authoritatively on this, given I helped run those hubs from inception until very recently.
Given there are not really any other okpy installations in the world, I think it's actually safe to remove this one.