Expand documentation to cover local test and development #1917
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
when using ingress.
|
The config:
BinderHub:
use_registry: false
image_prefix: gesiscss/binder-
hub_url: http://jupyterhub.10.6.46.141.nip.io
service:
type: ClusterIP
ingress:
enabled: true
annotations:
# use the shared ingress-nginx
kubernetes.io/ingress.class: "nginx"
https:
# This is unsafe! Only se for local development
enabled: false
hosts:
- binderhub.10.6.46.141.nip.io
jupyterhub:
proxy:
service:
type: ClusterIP
ingress:
enabled: true
annotations:
# use the shared ingress-nginx
kubernetes.io/ingress.class: "nginx"
hosts:
- jupyterhub.10.6.46.141.nip.io |
manics
reviewed
Jan 29, 2025
| Exposing JupyterHub | ||
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| By default, JupyterHub is exposed as ``LoadBalancer``. |
There was a problem hiding this comment.
Suggested change
| By default, JupyterHub is exposed as ``LoadBalancer``. | |
| By default, JupyterHub is exposed as a ``LoadBalancer``. |
| ~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| By default, JupyterHub is exposed as ``LoadBalancer``. | ||
| If you want to expose JupyterHub using a ingress controller, |
There was a problem hiding this comment.
Suggested change
| If you want to expose JupyterHub using a ingress controller, | |
| If you want to expose JupyterHub using an ingress controller, |
|
|
||
| The above snippet assumes that you are using `Ingress NGINX Controller <https://kubernetes.github.io/ingress-nginx/>`_ | ||
| and uses `nip.io <https://nip.io/>`_ to provide you with a temporary domain | ||
| to the IPv6 ``XXX.XXX.XXX.XXX``. |
There was a problem hiding this comment.
Suggested change
| to the IPv6 ``XXX.XXX.XXX.XXX``. | |
| to the IP ``XXX.XXX.XXX.XXX``. |
| ingress: | ||
| enabled: true | ||
| annotations: | ||
| # use the shared ingress-nginx |
There was a problem hiding this comment.
Suggested change
| # use the shared ingress-nginx | |
| # replace with your ingress class |
| on the registry you are using. | ||
| Create a file called ``config.yaml``. | ||
|
|
||
| Exposing JupyterHub |
There was a problem hiding this comment.
Rather than repeating yourself I think we could just say JupyterHub and BinderHub are exposed as LoadBalancers by default....., then give both configs and only talk about Nginx ingress once.
| When using ``Ingress`` | ||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| If JupyterHub is exposed using ``Ingress``, |
There was a problem hiding this comment.
Suggested change
| If JupyterHub is exposed using ``Ingress``, | |
| If JupyterHub is exposed using an ``Ingress``, |
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| If JupyterHub is exposed using ``Ingress``, | ||
| you can use any of the domains that JupyterHub is answering. |
There was a problem hiding this comment.
What do you mean by this? Only jupyterhub.XXX.XXX.XXX.XXX.nip.io is configured.
| BinderHub: | ||
| hub_url: http://jupyterhub.XXX.XXX.XXX.XXX.nip.io | ||
|
|
||
| The above snippet `nip.io <https://nip.io/>`_ |
There was a problem hiding this comment.
Suggested change
| The above snippet `nip.io <https://nip.io/>`_ | |
| The above snippet uses `nip.io <https://nip.io/>`_ |
| hub_url: http://jupyterhub.XXX.XXX.XXX.XXX.nip.io | ||
|
|
||
| The above snippet `nip.io <https://nip.io/>`_ | ||
| to provide you with a temporary domain to the IPv6 ``XXX.XXX.XXX.XXX``. |
There was a problem hiding this comment.
Suggested change
| to provide you with a temporary domain to the IPv6 ``XXX.XXX.XXX.XXX``. | |
| to provide you with a temporary domain to the IP ``XXX.XXX.XXX.XXX``. |
|
Suggested changes were addressed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.