zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #118 from choldgraf/when

Browse Source 
adding when to use tljh page
This commit is contained in:
Yuvi Panda
2018-08-10 19:47:43 -07:00
committed by GitHub
parent 627b8d45d4 54e9cfc93f
commit a98a5c322b
2 changed files with 37 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/index.rst
View File

@@ -3,7 +3,8 @@ The Littlest JupyterHub
=======================
A simple `JupyterHub <https://github.com/jupyterhub/jupyterhub>`_ distribution for
a small (0-100) number of users on a single server.
a small (0-100) number of users on a single server. We recommend reading
:ref:`topic/whentouse` to determine if this is the right tool for you.
Development Status
==================
@@ -84,6 +85,7 @@ Topic guides provide in-depth explanations of specific topics.
.. toctree::
:titlesonly:
topic/whentouse
topic/requirements
topic/security
topic/customizing-installer

34
docs/topic/whentouse.rst Normal file
View File

@@ -0,0 +1,34 @@
.. _topic/whentouse:
===================================
When to use The Littlest JupyterHub
===================================
This page is a brief guide to determining whether to use The Littlest JupyterHub
(TLJH) or `Zero to JupyterHub for Kubernetes <https://zero-to-jupyterhub.readthedocs.io/en/latest/>`_ (Z2JH).
Many of these ideas were first laid out in a
`blog post announcing TLJH <http://words.yuvi.in/post/the-littlest-jupyterhub/>`_.
**The Littlest JupyterHub (TLJH)** (`link <https://the-littlest-jupyterhub.readthedocs.io/en/latest/>`_) is an opinionated and pre-configured distribution
to deploy a JupyterHub on a **single machine** (in the cloud or on your own hardware).
It is designed to be a more lightweight and maintainable solution
for use-cases where size, scalability, and cost-savings are not a huge concern.
**Zero to JupyterHub on Kubernetes** (`link <https://zero-to-jupyterhub.readthedocs.io/en/latest/>`_) allows you
to deploy JupyterHub on **Kubernetes**. This allows JupyterHub to scale to many thousands
of users, to flexibly grow/shrink the size of resources it needs, and to use
container technology in administering user sessions.
When to use TLJH vs. Z2JH
=========================
The choice between TLJH and Z2JH ultimately comes down to only a few questoins:
1. Do you want your hub and all users to live on a **single, larger machine** vs. spreading users on a **cluster of smaller machines** that are scaled up or down?
* If you can use a single machine, we recommend **The Littlest JupyterHub**.
* If you wish to use multiple machines, we recommend **Zero to JupyterHub for Kubernetes**.
2. Do you **need to use container technology**?
* If no, we recommend **The Littlest JupyterHub**.
* If yes, we recommend **Zero to JupyterHub for Kubernetes**.