Add image of JupyterHub parts to index

This commit is contained in:
Carol Willing
2016-08-18 09:07:54 -07:00
parent 71b35602d7
commit 31f63c737f
3 changed files with 16 additions and 11 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

View File

@@ -8,23 +8,29 @@ Due to its flexibility and customization options, JupyterHub can be used to
serve notebooks to a class of students, a corporate data science group, or a serve notebooks to a class of students, a corporate data science group, or a
scientific research group. scientific research group.
.. image:: images/jhub-parts.png
:alt: JupyterHub subsystems
:width: 40%
:align: right
Three subsystems make up JupyterHub: Three subsystems make up JupyterHub:
- a multi-user **Hub** (tornado process) * a multi-user **Hub** (tornado process)
- a configurable http **proxy** (node-http-proxy) * a **configurable http proxy** (node-http-proxy)
- multiple **single-user Jupyter notebook servers** (Python/IPython/tornado) * multiple **single-user Jupyter notebook servers** (Python/IPython/tornado)
JupyterHub's basic flow of operations includes: JupyterHub's basic flow of operations includes:
- The Hub spawns a proxy - The Hub spawns a proxy
- The proxy forwards all requests to the Hub by default - The proxy forwards all requests to the Hub by default
- The Hub handles user login and spawns single-user servers on demand - The Hub handles user login and spawns single-user servers on demand
- The Hub configures the proxy to forward URL prefixes to the single-user - The Hub configures the proxy to forward URL prefixes to the single-user notebook servers
notebook servers
JupyterHub also provides a For convenient administration of the Hub, its users, and services, JupyterHub
`REST API <http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyterhub/master/docs/rest-api.yml#/default>`_ also provides a
for convenient administration of the Hub, its users, and services. `REST API <http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/jupyterhub/master/docs/rest-api.yml#/default>`_.
Contents Contents
@@ -33,9 +39,9 @@ Contents
**User Guide** **User Guide**
* :doc:`getting-started` * :doc:`getting-started`
* :doc:`rest`
* :doc:`howitworks` * :doc:`howitworks`
* :doc:`websecurity` * :doc:`websecurity`
* :doc:`rest`
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@@ -43,10 +49,9 @@ Contents
:caption: User Guide :caption: User Guide
getting-started getting-started
rest
howitworks howitworks
websecurity websecurity
rest
**Configuration Guide** **Configuration Guide**