Skip to content

Commit

Permalink
Merge pull request #118 from choldgraf/when
Browse files Browse the repository at this point in the history
adding when to use tljh page
  • Loading branch information
yuvipanda committed Aug 11, 2018
2 parents 627b8d4 + 54e9cfc commit a98a5c3
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down Expand Up @@ -84,6 +85,7 @@ Topic guides provide in-depth explanations of specific topics.
.. toctree::
:titlesonly:

topic/whentouse
topic/requirements
topic/security
topic/customizing-installer
Expand Down
34 changes: 34 additions & 0 deletions docs/topic/whentouse.rst
Original file line number Diff line number Diff line change
@@ -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**.

0 comments on commit a98a5c3

Please sign in to comment.