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.57k stars 390 forks source link

Add documentation for Docker Hub registry usage #902

Closed nuest closed 5 years ago

nuest commented 5 years ago

I hope I'm not missing something, but I think the documentation for using the DockerHub registry is incomplete. Or is docker login all there is needed? I assume not, because I probably need to configure the org-option that is mentioned.

The tests in https://github.com/jupyterhub/binderhub/blob/master/binderhub/tests/test_registry.py use different options (token, usename/password).

Screenshot of https://binderhub.readthedocs.io/en/latest/setup-registry.html#set-up-docker-hub-registry where the "next section" is not what is promised :-)

image

nuest commented 5 years ago

Potentiall related to #205.

Configuration probably goes into https://github.com/jupyterhub/binderhub/blob/cc3db47b59258f427a59ccb001161d00c978095a/helm-chart/binderhub/values.yaml#L21

bitnik commented 5 years ago

These are the parts related to docker hub in the "next section":

These settings are what we use in GESIS binder and should be enough to use docker hub registry.

secret.yaml:

registry:
  username: <docker-id>
  password: <password>

config.yaml:

config:
  BinderHub:
    use_registry: true
    image_prefix: <docker-id OR organization-name>/<prefix>-
nuest commented 5 years ago

Well, then it was just a confusion about what "next" means. I'll prepare a PR that turns "next section" into a link to "3. Set up BinderHub".