From db0ddb94fb468619a7fdbf5eb072869d786fca1b Mon Sep 17 00:00:00 2001 From: April Wright Date: Sat, 22 Sep 2018 21:47:40 -0500 Subject: [PATCH] split server resizing instructions --- docs/howto/admin/resize.rst | 55 +++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + docs/install/digitalocean.rst | 38 ++---------------------- docs/topic/tljh-config.rst | 5 +++- 4 files changed, 62 insertions(+), 37 deletions(-) create mode 100644 docs/howto/admin/resize.rst diff --git a/docs/howto/admin/resize.rst b/docs/howto/admin/resize.rst new file mode 100644 index 0000000..6b3d887 --- /dev/null +++ b/docs/howto/admin/resize.rst @@ -0,0 +1,55 @@ +.. _howto/admin/resize: + +================= +Resizing a server +================= + +As you are using your JupyterHub, you may find that you have a need to increase or decrease +the amount of resources allocated to your TLJH install. How resources can be reallocated +will depend on the server interface; consult the installation page for your provider for +more information. + +However, once resources have been relocated, you must tell TLJH to make use of these resources, +and verify that the resources have become available. + +.. _tljhconf: + +Verifying a Resize +================== + +#. You will need to tell the JupyterHub to make use of these new resources. + To accomplish this, you will follow the instructions in :ref:`topic/tljh-config` + to set memory limits and reload the hub. This can be completed using the terminal + in the JupyterHub. It can also be completed through the Digital Ocean console or terminal. + +#. TLJH configuration options can be verified by viewing the tljh-config output. + + .. code-block:: bash + + sudo tljh-config show + + +#. If you have changed your memory availability successfully, this will be reflected + in the `nbresuse `_ extension in the upper-right + when you open a Jupyter notebook on the Hub. + + .. image:: ../../images/nbresuse.png + :alt: nbresuse demonstration + +#. If you have changed the number of cores, this can be verified at the command line. + ``nproc`` displays the number of available cores, and should be equal to the + number of cores you selected in the "Resize Droplet" panel. + + .. code-block:: bash + + nproc --all + + +#. Disk space changes can be verified, as well. The ``df`` command shows how much disk + space is available. The ``-hT`` argument allows us to have this printed in a human readable + format, and condenses the output to show one storage volume. + + .. code-block:: bash + + df -hT /home + diff --git a/docs/index.rst b/docs/index.rst index 7488489..98f1c1f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -81,6 +81,7 @@ Administration and security howto/admin/admin-users howto/admin/resource-estimation + howto/admin/resize howto/admin/nbresuse howto/admin/https diff --git a/docs/install/digitalocean.rst b/docs/install/digitalocean.rst index f79cc52..363f5e2 100644 --- a/docs/install/digitalocean.rst +++ b/docs/install/digitalocean.rst @@ -128,40 +128,6 @@ Step 4: Resizing and editing the droplet .. image:: ../images/providers/digitalocean/resize-droplet.png :alt: Resize panel of digital ocean -#. You will need to tell the JupyterHub to make use of these new resources. - To accomplish this, you will follow the instructions in :ref:`topic/tljh-config` - to set memory limits and reload the hub. This can be completed using the terminal - in the JupyterHub, as in Step 3. It can also be completed through the Digital Ocean - console. - -#. TLJH configuration options can be verified by viewing the tljh-config output. - - .. code-block:: bash - - sudo tljh-config show - - -#. If you have changed your memory availability successfully, this will be reflected - in the `nbresuse `_ extension in the upper-right - when you open a Jupyter notebook on the Hub. - - .. image:: ../images/nbresuse.png - :alt: nbresuse demonstration - -#. If you have changed the number of cores, this can be verified at the command line. - ``nproc`` displays the number of available cores, and should be equal to the - number of cores you selected in the "Resize Droplet" panel. - - .. code-block:: bash - - nproc --all - - -#. Disk space changes can be verified, as well. The ``df`` command shows how much disk - space is available. The ``-hT`` argument allows us to have this printed in a human readable - format, and condenses the output to show one storage volume. - - .. code-block:: bash - - df -hT /home + Further information on making more resources available to TLJH and verifying resource + availability can be found in the How-To :ref:`howto/admin/resize`. diff --git a/docs/topic/tljh-config.rst b/docs/topic/tljh-config.rst index 901ae21..b1e5e82 100644 --- a/docs/topic/tljh-config.rst +++ b/docs/topic/tljh-config.rst @@ -8,7 +8,7 @@ Configuring TLJH with ``tljh-config`` changes to TLJH. Running ``tljh-config`` -======================` +======================= You can run ``tljh-config`` in two ways: @@ -19,6 +19,9 @@ You can run ``tljh-config`` in two ways: logged in to the server via other means (such as SSH). This is an advanced use case, and not covered much in this guide. +.. _topic/tljh-set: + + Set a configuration property ============================