jupyterhub / binderhub

Run your code in the cloud, with technology so advanced, it feels like magic!
https://binderhub.readthedocs.io
BSD 3-Clause "New" or "Revised" License
2.54k stars 388 forks source link

Additional property auth is not allowed #1625

Closed sebastian-luna-valero closed 1 year ago

sebastian-luna-valero commented 1 year ago

Bug description

Following the docs to add authentication to BinderHub: https://binderhub.readthedocs.io/en/latest/authentication.html

Using values.yaml with:

config:
  BinderHub:
    auth_enabled: true

jupyterhub:
  cull:
    # don't cull authenticated users
    users: False
  hub:
    redirectToServer: false
    config:
      BinderSpawner:
        auth_enabled: true
    services:
      binder:
        oauth_client_id: service-binderhub
        oauth_no_confirm: true
        oauth_redirect_uri: "https://<binderhub_url>/oauth_callback"
    loadRoles:
      user:
        scopes:
          - self
          - "access:services"

  singleuser:
    # to make notebook servers aware of hub
    cmd: jupyterhub-singleuser

  auth: {}

Expected behaviour

It should deploy BinderHub.

Actual behaviour

Running:

sudo helm upgrade binderhub jupyterhub/binderhub --install --cleanup-on-fail --create-namespace --namespace binderhub --version 1.0.0-0.dev.git.3002.h5f189ce --values values.yaml

Returns:

jupyterhub:
- (root): Additional property auth is not allowed

How to reproduce

Run:

sudo helm upgrade binderhub jupyterhub/binderhub --install --cleanup-on-fail --create-namespace --namespace binderhub --version 1.0.0-0.dev.git.3002.h5f189ce --values values.yaml

with:


# [...]

jupyterhub:

# [...]

  auth: {}

Your personal set up

Full environment ``` # paste output of `pip freeze` or `conda list` here ```
Configuration ```python # jupyterhub_config.py ```
Logs ``` # paste relevant logs here, if any ```
welcome[bot] commented 1 year ago

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively. welcome You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:

manics commented 1 year ago

Looks like a mistake, it should be nested under jupyterhub.auth. We should properly test the auth config from that doc.... It's on my todo list!