From 97c72dd779af98910988b931b61717e990c0af4b Mon Sep 17 00:00:00 2001 From: PoorvajaRayas <106921794+PoorvajaRayas@users.noreply.github.com> Date: Tue, 18 Oct 2022 02:01:50 +0530 Subject: [PATCH 1/5] Update troubleshooting.md Improved the documentation to make it clearer --- docs/source/troubleshooting.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index fcbb345d..0edfac41 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -1,22 +1,23 @@ # Troubleshooting -When troubleshooting, you may see unexpected behaviors or receive an error +While troubleshooting, you may see unexpected behaviors or receive an error message. This section provides links for identifying the cause of the problem and how to resolve it. + ## Behavior ### JupyterHub proxy fails to start -If you have tried to start the JupyterHub proxy and it fails to start: +If you have tried to start the JupyterHub proxy and it fails to run: - check if the JupyterHub IP configuration setting is `c.JupyterHub.ip = '*'`; if it is, try `c.JupyterHub.ip = ''` - Try starting with `jupyterhub --ip=0.0.0.0` **Note**: If this occurs on Ubuntu/Debian, check that you are using a -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. +recent version of [Node](https://nodejs.org). Some versions of Ubuntu/Debian come with an older version +of Node and it is necessary to update Node. ### sudospawner fails to run @@ -37,11 +38,11 @@ to the config file, `jupyterhub_config.py`. When nothing is given for these lists, there will be no admins, and all users who can authenticate on the system (i.e. all the Unix users on the server with a password) will be allowed to start a server. The allowed username set lets you limit -this to a particular set of users, and admin_users lets you specify who +this to a particular set of users, and admin_users let you specify who among them may use the admin interface (not necessary, unless you need to do things like inspect other users' servers or modify the user list at runtime). -### JupyterHub Docker container not accessible at localhost +### What to do when JupyterHub Docker container is not accessible at localhost? Even though the command to start your Docker container exposes port 8000 (`docker run -p 8000:8000 -d --name jupyterhub jupyterhub/jupyterhub jupyterhub`), @@ -71,7 +72,7 @@ After successfully logging in to JupyterHub with a compatible authenticator, I g This issue occurs when the authenticator requires a local system user to exist. In these cases, you need to use a spawner that does not require an existing system user account, such as `DockerSpawner` or `KubeSpawner`. -### How can I run JupyterHub with sudo but use my current env vars and virtualenv location? +### How can I run JupyterHub with sudo but use my current environment variables and virtualenv location? When launching JupyterHub with `sudo jupyterhub` I get import errors and my environment variables don't work. @@ -87,7 +88,7 @@ sudo MY_ENV=abc123 \ ### Error 500 after spawning my single-user server -You receive a 500 error when accessing the URL `/user//...`. +You receive an Error 500 while accessing the URL `/user//...`. This is often seen when your single-user server cannot verify your user cookie with the Hub. @@ -100,7 +101,7 @@ There are two likely reasons for this: #### Symptoms The main symptom is a failure to load _any_ page served by the single-user -server, met with a 500 error. This is typically the first page at `/user/` +server, met with an Error 500. This is typically the first page at `/user/` after logging in or clicking "Start my server". When a single-user notebook server receives a request, the notebook server makes an API request to the Hub to check if the cookie corresponds to the right user. This request is logged. @@ -167,7 +168,7 @@ When your whole JupyterHub sits behind an organization proxy (_not_ a reverse pr [JupyterHub services](https://jupyterhub.readthedocs.io/en/stable/reference/services.html) allow processes to interact with JupyterHub's REST API. Example use-cases include: -- **Secure Testing**: provide a canonical Jupyter Notebook for testing production data to reduce the number of entry points into production systems. +- **Secure Testing**: provides a canonical Jupyter Notebook for testing production data to reduce the number of entry points into production systems. - **Grading Assignments**: provide access to shared Jupyter Notebooks that may be used for management tasks such as grading assignments. - **Private Dashboards**: share dashboards with certain group members. @@ -194,7 +195,7 @@ With a docker container, pass in the environment variable with the run command: -e JUPYTERHUB_API_TOKEN=my_secret_token \ jupyter/datascience-notebook:latest -[This example](https://github.com/jupyterhub/jupyterhub/tree/HEAD/examples/service-notebook/external) demonstrates how to combine the use of the `jupyterhub-singleuser` environment variables when launching a Notebook as an externally managed service. +[This example](https://github.com/jupyterhub/jupyterhub/tree/HEAD/examples/service-notebook/external) demonstrates how to combine the use of the `jupyterhub-singleuser` environment variables when launching a Notebook as an externally managed service. ## How do I...? @@ -268,7 +269,7 @@ similar to this one: provides additional information. The [pySpark configuration documentation](https://spark.apache.org/docs/0.9.0/configuration.html) is also helpful for programmatic configuration examples. -### How do I use JupyterLab's prerelease version with JupyterHub? +### How do I use JupyterLab's pre-release version with JupyterHub? While JupyterLab is still under active development, we have had users ask about how to try out JupyterLab with JupyterHub. @@ -294,7 +295,7 @@ notebook servers to default to JupyterLab: ### How do I set up JupyterHub for a workshop (when users are not known ahead of time)? 1. Set up JupyterHub using OAuthenticator for GitHub authentication -2. Configure the admin list to have workshop leaders be listed with administrator privileges. +2. Configure the admin list to have workshop leaders listed with administrator privileges. Users will need a GitHub account to log in and be authenticated by the Hub. @@ -324,7 +325,7 @@ 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 +The Apache Toree kernel will have an issue while running with JupyterHub if the standard HDFS rack awareness script is used. This will materialize in the logs as a repeated WARN: ```bash @@ -371,7 +372,7 @@ You can also tail logs to view them in real-time using the `-f` option: ## Troubleshooting commands The following commands provide additional detail about installed packages, -versions, and system information that may be helpful when troubleshooting +versions, and system information that may be helpful while troubleshooting a JupyterHub deployment. The commands are: - System and deployment information From b890a7486da28cce6a3a82a29b7bc2f43017c6d3 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 17 Oct 2022 20:33:17 +0000 Subject: [PATCH 2/5] [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, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 0edfac41..6950264a 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -4,7 +4,6 @@ While troubleshooting, you may see unexpected behaviors or receive an error message. This section provides links for identifying the cause of the problem and how to resolve it. - ## Behavior ### JupyterHub proxy fails to start @@ -195,7 +194,7 @@ With a docker container, pass in the environment variable with the run command: -e JUPYTERHUB_API_TOKEN=my_secret_token \ jupyter/datascience-notebook:latest -[This example](https://github.com/jupyterhub/jupyterhub/tree/HEAD/examples/service-notebook/external) demonstrates how to combine the use of the `jupyterhub-singleuser` environment variables when launching a Notebook as an externally managed service. +[This example](https://github.com/jupyterhub/jupyterhub/tree/HEAD/examples/service-notebook/external) demonstrates how to combine the use of the `jupyterhub-singleuser` environment variables when launching a Notebook as an externally managed service. ## How do I...? From cd3f37f6a6e237d6a195d5a3bfddb7a8cb72409d Mon Sep 17 00:00:00 2001 From: PoorvajaRayas <106921794+PoorvajaRayas@users.noreply.github.com> Date: Thu, 20 Oct 2022 17:24:55 +0530 Subject: [PATCH 3/5] Update troubleshooting.md --- docs/source/troubleshooting.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 6950264a..5363e295 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -1,6 +1,6 @@ # Troubleshooting -While troubleshooting, you may see unexpected behaviors or receive an error +When troubleshooting, you may see unexpected behaviors or receive an error message. This section provides links for identifying the cause of the problem and how to resolve it. @@ -8,14 +8,14 @@ problem and how to resolve it. ### JupyterHub proxy fails to start -If you have tried to start the JupyterHub proxy and it fails to run: +If you have tried to start the JupyterHub proxy and it fails to start: - check if the JupyterHub IP configuration setting is `c.JupyterHub.ip = '*'`; if it is, try `c.JupyterHub.ip = ''` - Try starting with `jupyterhub --ip=0.0.0.0` **Note**: If this occurs on Ubuntu/Debian, check that you are using a -recent version of [Node](https://nodejs.org). Some versions of Ubuntu/Debian come with an older version +recent version of [Node](https://nodejs.org). Some versions of Ubuntu/Debian come with a very old version of Node and it is necessary to update Node. ### sudospawner fails to run @@ -37,7 +37,7 @@ to the config file, `jupyterhub_config.py`. When nothing is given for these lists, there will be no admins, and all users who can authenticate on the system (i.e. all the Unix users on the server with a password) will be allowed to start a server. The allowed username set lets you limit -this to a particular set of users, and admin_users let you specify who +this to a particular set of users, and admin_users lets you specify who among them may use the admin interface (not necessary, unless you need to do things like inspect other users' servers or modify the user list at runtime). @@ -87,7 +87,7 @@ sudo MY_ENV=abc123 \ ### Error 500 after spawning my single-user server -You receive an Error 500 while accessing the URL `/user//...`. +You receive a 500 error while accessing the URL `/user//...`. This is often seen when your single-user server cannot verify your user cookie with the Hub. @@ -100,7 +100,7 @@ There are two likely reasons for this: #### Symptoms The main symptom is a failure to load _any_ page served by the single-user -server, met with an Error 500. This is typically the first page at `/user/` +server, met with a 500 error. This is typically the first page at `/user/` after logging in or clicking "Start my server". When a single-user notebook server receives a request, the notebook server makes an API request to the Hub to check if the cookie corresponds to the right user. This request is logged. @@ -167,7 +167,7 @@ When your whole JupyterHub sits behind an organization proxy (_not_ a reverse pr [JupyterHub services](https://jupyterhub.readthedocs.io/en/stable/reference/services.html) allow processes to interact with JupyterHub's REST API. Example use-cases include: -- **Secure Testing**: provides a canonical Jupyter Notebook for testing production data to reduce the number of entry points into production systems. +- **Secure Testing**: provide a canonical Jupyter Notebook for testing production data to reduce the number of entry points into production systems. - **Grading Assignments**: provide access to shared Jupyter Notebooks that may be used for management tasks such as grading assignments. - **Private Dashboards**: share dashboards with certain group members. @@ -324,7 +324,7 @@ Or use syslog: ### Toree integration with HDFS rack awareness script -The Apache Toree kernel will have an issue while running with JupyterHub if the standard HDFS +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 @@ -371,7 +371,7 @@ You can also tail logs to view them in real-time using the `-f` option: ## Troubleshooting commands The following commands provide additional detail about installed packages, -versions, and system information that may be helpful while troubleshooting +versions, and system information that may be helpful when troubleshooting a JupyterHub deployment. The commands are: - System and deployment information From 677895c3eb5597a87bebcf7ffb2450403b1f5765 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 11:55:28 +0000 Subject: [PATCH 4/5] [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, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 5363e295..cbbf20c1 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -15,7 +15,7 @@ If you have tried to start the JupyterHub proxy and it fails to start: - Try starting with `jupyterhub --ip=0.0.0.0` **Note**: If this occurs on Ubuntu/Debian, check that you are using a -recent version of [Node](https://nodejs.org). Some versions of Ubuntu/Debian come with a very old version +recent version of [Node](https://nodejs.org). Some versions of Ubuntu/Debian come with a very old version of Node and it is necessary to update Node. ### sudospawner fails to run From dd8259fb469b0a967009bb804cab0773ac128796 Mon Sep 17 00:00:00 2001 From: PoorvajaRayas <106921794+PoorvajaRayas@users.noreply.github.com> Date: Thu, 20 Oct 2022 17:47:13 +0530 Subject: [PATCH 5/5] Updated the document by making necessary changes --- 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 cbbf20c1..e27fe48e 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -41,7 +41,7 @@ this to a particular set of users, and admin_users lets you specify who among them may use the admin interface (not necessary, unless you need to do things like inspect other users' servers or modify the user list at runtime). -### What to do when JupyterHub Docker container is not accessible at localhost? +### JupyterHub Docker container is not accessible at localhost Even though the command to start your Docker container exposes port 8000 (`docker run -p 8000:8000 -d --name jupyterhub jupyterhub/jupyterhub jupyterhub`),