diff --git a/README.rst b/README.rst index 27c556f..fcfe249 100644 --- a/README.rst +++ b/README.rst @@ -41,6 +41,7 @@ Ubuntu 18.04. We have a bunch of tutorials to get you started! servers. - `Digital Ocean `_ + - `OVH `_ - `Google Cloud `_ - `Jetstream `_ - `Amazon Web Services `_ diff --git a/docs/images/providers/ovh/configuration.png b/docs/images/providers/ovh/configuration.png new file mode 100644 index 0000000..71fe1a9 Binary files /dev/null and b/docs/images/providers/ovh/configuration.png differ diff --git a/docs/images/providers/ovh/create-instance.png b/docs/images/providers/ovh/create-instance.png new file mode 100644 index 0000000..61885cb Binary files /dev/null and b/docs/images/providers/ovh/create-instance.png differ diff --git a/docs/images/providers/ovh/create-ovh-stack.png b/docs/images/providers/ovh/create-ovh-stack.png new file mode 100644 index 0000000..a3bbbc2 Binary files /dev/null and b/docs/images/providers/ovh/create-ovh-stack.png differ diff --git a/docs/images/providers/ovh/distribution.png b/docs/images/providers/ovh/distribution.png new file mode 100644 index 0000000..ab44752 Binary files /dev/null and b/docs/images/providers/ovh/distribution.png differ diff --git a/docs/images/providers/ovh/payment.png b/docs/images/providers/ovh/payment.png new file mode 100644 index 0000000..d24f916 Binary files /dev/null and b/docs/images/providers/ovh/payment.png differ diff --git a/docs/images/providers/ovh/project-name.png b/docs/images/providers/ovh/project-name.png new file mode 100644 index 0000000..1afe30b Binary files /dev/null and b/docs/images/providers/ovh/project-name.png differ diff --git a/docs/images/providers/ovh/public-cloud.png b/docs/images/providers/ovh/public-cloud.png new file mode 100644 index 0000000..55a2185 Binary files /dev/null and b/docs/images/providers/ovh/public-cloud.png differ diff --git a/docs/images/providers/ovh/public-ip.png b/docs/images/providers/ovh/public-ip.png new file mode 100644 index 0000000..bbc76ff Binary files /dev/null and b/docs/images/providers/ovh/public-ip.png differ diff --git a/docs/index.rst b/docs/index.rst index 0171f2d..2bb1afc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,6 +30,7 @@ We have a bunch of tutorials to get you started. :caption: Installation install/digitalocean + install/ovh install/jetstream install/google install/amazon diff --git a/docs/install/ovh.rst b/docs/install/ovh.rst new file mode 100644 index 0000000..df010d2 --- /dev/null +++ b/docs/install/ovh.rst @@ -0,0 +1,127 @@ +.. _install/ovh: + +================= +Installing on OVH +================= + +Goal +==== + +By the end of this tutorial, you should have a JupyterHub with some admin +users and a user environment with packages you want installed running on +`OVH `_. + +Pre-requisites +============== + +#. An OVH account. + +Step 1: Installing The Littlest JupyterHub +========================================== + +Let's create the server on which we can run JupyterHub. + +#. Log in to the `OVH Control Panel `_. + +#. Click the **Public Cloud** button in the navigation bar. + + .. image:: ../images/providers/ovh/public-cloud.png + :alt: Public Cloud entry in the navigation bar + +#. If you don't have an OVH Stack, you can create one by clicking on the following button: + + .. image:: ../images/providers/ovh/create-ovh-stack.png + :alt: Button to create an OVH stack + +#. Select a name for the project: + + .. image:: ../images/providers/ovh/project-name.png + :alt: Select a name for the project + +#. If you don't have a payment method yet, select one and click on "Create my project": + + .. image:: ../images/providers/ovh/payment.png + :alt: Select a payment method + +#. Using the **Public Cloud interface**, click on **Create an instance**: + + .. image:: ../images/providers/ovh/create-instance.png + :alt: Create a new instance + +#. **Select a model** for the instance. A good start is the **S1-4** model under **Shared resources** which comes with 4GB RAM, 1 vCores and 20GB SSD. + +#. **Select a region**. + +#. Select **Ubuntu 18.04** as the image: + + .. image:: ../images/providers/ovh/distribution.png + :alt: Select Ubuntu 18.04 as the image + +#. OVH requires setting an SSH key to be able to connect to the instance. + You can create a new SSH by following + `these instructions `_. + Be sure to copy the content of the ``~/.ssh/id_rsa.pub`` file, which corresponds to the **public part** of the SSH key. + +#. Select **Configure your instance**, and select a name for the instance. + Under **Post-installation script**, copy the text below and paste it in the text box. + Replace ```` with the name of the first **admin user** for this + JupyterHub. This admin user can log in after the JupyterHub is set up, and + can configure it to their needs. **Remember to add your username**! + + .. code-block:: bash + + #!/bin/bash + curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py \ + | sudo python3 - \ + --admin + + .. note:: + + See :ref:`topic/installer-actions` if you want to understand exactly what the installer is doing. + :ref:`topic/customizing-installer` documents other options that can be passed to the installer. + + + .. image:: ../images/providers/ovh/configuration.png + :alt: Add post-installation script + +#. Select a billing period: monthly or hourly. + +#. Click the **Create an instane** button! You will be taken to a different screen, + where you can see progress of your server being created. + + .. image:: ../images/providers/ovh/create-instance.png + :alt: Select suitable hostname for your server + +#. In a few seconds your server will be created, and you can see the **public IP** + used to access it. + + .. image:: ../images/providers/ovh/public-ip.png + :alt: Server finished creating, public IP available + +#. The Littlest JupyterHub is now installing in the background on your new server. + It takes around 5-10 minutes for this installation to complete. + +#. Check if the installation is complete by copying the **public ip** + of your server, and trying to access it with a browser. This will fail until + the installation is complete, so be patient. + +#. When the installation is complete, it should give you a JupyterHub login page. + + .. image:: ../images/first-login.png + :alt: JupyterHub log-in page + +#. Login using the **admin user name** you used in step 6, and a password. Use a + strong password & note it down somewhere, since this will be the password for + the admin user account from now on. + +#. Congratulations, you have a running working JupyterHub! + +Step 2: Adding more users +========================== + +.. include:: add_users.txt + +Step 3: Install conda / pip packages for all users +================================================== + +.. include:: add_packages.txt \ No newline at end of file