From de3210536fb22f5151fffadce0d255a65ab6114b Mon Sep 17 00:00:00 2001 From: Ngobiri Falyne Date: Fri, 14 Oct 2022 04:53:09 +0100 Subject: [PATCH 1/6] Update troubleshooting.md Adjusted the Heading sudospawner - Sudospawner to suite sentence case Under proxy Settings, i adjusted the sentence "a organization to an organization" also singleuser to single-user under Toree intergration, the sentence is not clear so I adjusted to Toree kernel will raise and issue when running with jupyterHub, --- docs/source/troubleshooting.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 0cecb6d9..abc6cde9 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -44,7 +44,7 @@ If you have tried to start the JupyterHub proxy and it fails to start: recent version of node. Some versions of Ubuntu/Debian come with a version of node that is very old, and it is necessary to update node. -### sudospawner fails to run +### Sudospawner fails to run If the sudospawner script is not found in the path, sudospawner will not run. To avoid this, specify sudospawner's absolute path. For example, start @@ -201,7 +201,7 @@ your server again. ##### Proxy settings (403 GET) -When your whole JupyterHub sits behind a organization proxy (_not_ a reverse proxy like NGINX as part of your setup and _not_ the configurable-http-proxy) the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `https_proxy` might be set. This confuses the jupyterhub-singleuser servers: When connecting to the Hub for authorization they connect via the proxy instead of directly connecting to the Hub on localhost. The proxy might deny the request (403 GET). This results in the singleuser server thinking it has a wrong auth token. To circumvent this you should add `,,localhost,127.0.0.1` to the environment variables `NO_PROXY` and `no_proxy`. +When your whole JupyterHub sits behind an organization proxy (_not_ a reverse proxy like NGINX as part of your setup and _not_ the configurable-http-proxy) the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `https_proxy` might be set. This confuses the jupyterhub-singleuser servers: When connecting to the Hub for authorization they connect via the proxy instead of directly connecting to the Hub on localhost. The proxy might deny the request (403 GET). This results in the single-user server thinking it has a wrong auth token. To circumvent this you should add `,,localhost,127.0.0.1` to the environment variables `NO_PROXY` and `no_proxy`. ### Launching Jupyter Notebooks to run as an externally managed JupyterHub service with the `jupyterhub-singleuser` command returns a `JUPYTERHUB_API_TOKEN` error @@ -388,7 +388,7 @@ jupyterhub --debug ### Toree integration with HDFS rack awareness script -The Apache Toree kernel will an issue, when running with JupyterHub, if the standard HDFS +The Apache Toree kernel will raise an issue when running with JupyterHub, if the standard HDFS rack awareness script is used. This will materialize in the logs as a repeated WARN: ```bash @@ -412,8 +412,8 @@ In order to resolve this issue, there are two potential options. Docker images can be found at the [JupyterHub organization on DockerHub](https://hub.docker.com/u/jupyterhub/). The Docker image [jupyterhub/singleuser](https://hub.docker.com/r/jupyterhub/singleuser/) -provides an example single user notebook server for use with DockerSpawner. +provides an example single-user notebook server for use with DockerSpawner. -Additional single user notebook server images can be found at the [Jupyter +Additional single-user notebook server images can be found at the [Jupyter organization on DockerHub](https://hub.docker.com/r/jupyter/) and information about each image at the [jupyter/docker-stacks repo](https://github.com/jupyter/docker-stacks). From 1ea557c999d78e6c8129f590ad1df6497e4296b7 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 20 Oct 2022 08:44:58 +0000 Subject: [PATCH 2/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/troubleshooting.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 60de6613..8e81c7b3 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -161,10 +161,8 @@ your server again. ##### Proxy settings (403 GET) - When your whole JupyterHub sits behind an organization proxy (_not_ a reverse proxy like NGINX as part of your setup and _not_ the configurable-http-proxy) the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `https_proxy` might be set. This confuses the jupyterhub single-user servers: When connecting to the Hub for authorization they connect via the proxy instead of directly connecting to the Hub on localhost. The proxy might deny the request (403 GET). This results in the single-user server thinking it has a wrong auth token. To circumvent this you should add `,,localhost,127.0.0.1` to the environment variables `NO_PROXY` and `no_proxy`. - ### Launching Jupyter Notebooks to run as an externally managed JupyterHub service with the `jupyterhub-singleuser` command returns a `JUPYTERHUB_API_TOKEN` error [JupyterHub services](https://jupyterhub.readthedocs.io/en/stable/reference/services.html) allow processes to interact with JupyterHub's REST API. Example use-cases include: @@ -326,7 +324,6 @@ Or use syslog: ### Toree integration with HDFS rack awareness script - The Apache Toree kernel will have an issue when running with JupyterHub if the standard HDFS rack awareness script is used. This will materialize in the logs as a repeated WARN: ```bash From 439b96978e51666431f96e9bca2b2466234b33f8 Mon Sep 17 00:00:00 2001 From: Ngobiri Falyne Date: Thu, 20 Oct 2022 09:58:37 +0100 Subject: [PATCH 3/6] Update troubleshooting.md --- docs/source/troubleshooting.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 8e81c7b3..29030c71 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -160,7 +160,6 @@ new container. If this was the underlying cause of the issue, you should see your server again. ##### Proxy settings (403 GET) - When your whole JupyterHub sits behind an organization proxy (_not_ a reverse proxy like NGINX as part of your setup and _not_ the configurable-http-proxy) the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `https_proxy` might be set. This confuses the jupyterhub single-user servers: When connecting to the Hub for authorization they connect via the proxy instead of directly connecting to the Hub on localhost. The proxy might deny the request (403 GET). This results in the single-user server thinking it has a wrong auth token. To circumvent this you should add `,,localhost,127.0.0.1` to the environment variables `NO_PROXY` and `no_proxy`. ### Launching Jupyter Notebooks to run as an externally managed JupyterHub service with the `jupyterhub-singleuser` command returns a `JUPYTERHUB_API_TOKEN` error @@ -323,7 +322,6 @@ Or use syslog: jupyterhub | logger -t jupyterhub ### Toree integration with HDFS rack awareness script - The Apache Toree kernel will have an issue when running with JupyterHub if the standard HDFS rack awareness script is used. This will materialize in the logs as a repeated WARN: ```bash From c3da12c19513e5e3b079fc65cb4b627a22ed1c91 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 20 Oct 2022 09:00:33 +0000 Subject: [PATCH 4/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/troubleshooting.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 29030c71..8e81c7b3 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -160,6 +160,7 @@ new container. If this was the underlying cause of the issue, you should see your server again. ##### Proxy settings (403 GET) + When your whole JupyterHub sits behind an organization proxy (_not_ a reverse proxy like NGINX as part of your setup and _not_ the configurable-http-proxy) the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `https_proxy` might be set. This confuses the jupyterhub single-user servers: When connecting to the Hub for authorization they connect via the proxy instead of directly connecting to the Hub on localhost. The proxy might deny the request (403 GET). This results in the single-user server thinking it has a wrong auth token. To circumvent this you should add `,,localhost,127.0.0.1` to the environment variables `NO_PROXY` and `no_proxy`. ### Launching Jupyter Notebooks to run as an externally managed JupyterHub service with the `jupyterhub-singleuser` command returns a `JUPYTERHUB_API_TOKEN` error @@ -322,6 +323,7 @@ Or use syslog: jupyterhub | logger -t jupyterhub ### Toree integration with HDFS rack awareness script + The Apache Toree kernel will have an issue when running with JupyterHub if the standard HDFS rack awareness script is used. This will materialize in the logs as a repeated WARN: ```bash From 141f5ea2b4d3def677bf4897b6253040c8fa5b7f Mon Sep 17 00:00:00 2001 From: Ngobiri Falyne Date: Thu, 20 Oct 2022 10:01:44 +0100 Subject: [PATCH 5/6] Update troubleshooting.md --- docs/source/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 8e81c7b3..66a7512b 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -18,7 +18,7 @@ If you have tried to start the JupyterHub proxy and it fails to start: recent version of [Node](https://nodejs.org). Some versions of Ubuntu/Debian come with a version of Node that is very old, and it is necessary to update Node. -### Sudospawner fails to run +### sudospawner fails to run If the sudospawner script is not found in the path, sudospawner will not run. To avoid this, specify sudospawner's absolute path. For example, start From fc5f55caf9d8b0111c6660462c2ba2ccf0761281 Mon Sep 17 00:00:00 2001 From: Ngobiri Falyne Date: Sat, 22 Oct 2022 06:53:16 +0100 Subject: [PATCH 6/6] Update troubleshooting.md I replaced the comma, adjusted jupyterhub to JuputerHub and the others as adiced --- docs/source/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 66a7512b..532c88d3 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -161,7 +161,7 @@ your server again. ##### Proxy settings (403 GET) -When your whole JupyterHub sits behind an organization proxy (_not_ a reverse proxy like NGINX as part of your setup and _not_ the configurable-http-proxy) the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `https_proxy` might be set. This confuses the jupyterhub single-user servers: When connecting to the Hub for authorization they connect via the proxy instead of directly connecting to the Hub on localhost. The proxy might deny the request (403 GET). This results in the single-user server thinking it has a wrong auth token. To circumvent this you should add `,,localhost,127.0.0.1` to the environment variables `NO_PROXY` and `no_proxy`. +When your whole JupyterHub sits behind an organization proxy (_not_ a reverse proxy like NGINX as part of your setup and _not_ the configurable-http-proxy) the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy`, and `https_proxy` might be set. This confuses the JupyterHub single-user servers: When connecting to the Hub for authorization they connect via the proxy instead of directly connecting to the Hub on localhost. The proxy might deny the request (403 GET). This results in the single-user server thinking it has the wrong auth token. To circumvent this you should add `,,localhost,127.0.0.1` to the environment variables `NO_PROXY` and `no_proxy`. ### Launching Jupyter Notebooks to run as an externally managed JupyterHub service with the `jupyterhub-singleuser` command returns a `JUPYTERHUB_API_TOKEN` error