the-littlest-jupyterhub/docs/install/azure.md

(install-azure)=

# Installing on Azure

## Goal

By the end of this tutorial, you should have a JupyterHub with some admin
users and a user environment with packages you want to be installed running on
[Microsoft Azure](https://azure.microsoft.com).

This tutorial leads you step-by-step for you to manually deploy your own JupyterHub on Azure cloud.

:::{note}
✨ The `Deploy to Azure button` project allows you to deploy your own JupyterHub with minimal manual configuration steps. The deploy to Azure button allows you to have a vanilla configuration in just one-click and by assigning some variables.

Check it out at [https://github.com/trallard/TLJH-azure-button](https://github.com/trallard/TLJH-azure-button).
:::

## Prerequisites

- A Microsoft Azure account.
- To get started you can get a free account which includes 150 dollars worth of Azure credits ([get a free account here](https://azure.microsoft.com/en-us/free//?wt.mc_id=TLJH-github-taallard))

These instructions cover how to set up a Virtual Machine
on Microsoft Azure. For subsequent information about creating
your JupyterHub and configuring it, see [The Littlest JupyterHub guide](https://the-littlest-jupyterhub.readthedocs.io/en/latest/).

## Step 1: Installing The Littlest JupyterHub

We start by creating the Virtual Machine in which we can run TLJH (The Littlest JupyterHub).

1.  Go to [Azure portal](https://portal.azure.com/) and login with your Azure account.

2.  Expand the left-hand panel by clicking on the ">>" button on the top left corner of your dashboard. Find the Virtual Machines tab and click on it.

    ```{image} ../images/providers/azure/azure-vms.png
    :alt: Virtual machines on Azure portal
    ```

3.  Click **+ add** to create a new Virtual Machine

    ```{image} ../images/providers/azure/add-vm.png
    :alt: Add a new virtual machine
    ```

4.  Select **Create VM from Marketplace** in the next screen.
    A new screen with all the options for Virtual Machines in Azure will displayed.

    ```{image} ../images/providers/azure/create-vm.png
    :alt: Create VM from the marketplace
    ```

5.  **Choose an Ubuntu server for your VM**:

    - Click `Ubuntu Server 22.04 LTS.`

    - Make sure `Resource Manager` is selected in the next screen and click **Create**

    ```{image} ../images/providers/azure/ubuntu-vm.png
    :alt: Ubuntu VM
    ```

6.  Customise the Virtual Machine basics:

    - **Subscription**. Choose the "Free Trial" if this is what you're using. Otherwise, choose a different plan. This is the billing account that will be charged.
    - **Resource group**. Resource groups let you keep your Azure tools/resources together in an availability region (e.g. WestEurope). If you already have one you'd like to use it select that resource.

    :::{note}
    If you have never created a Resource Group, click on **Create new**
    :::

    ```{image} ../images/providers/azure/new-rg.png
    :alt: Create a new resource group
    ```

    - **Name**. Use a descriptive name for your virtual machine (note that you cannot use spaces or special characters).
    - **Region**. Choose a location near where you expect your users to be located.
    - **Availability options**. Choose "No infrastructure redundancy required".
    - **Image**. Make sure "Ubuntu Server 22.04 LTS" is selected (from the previous step).
    - **Authentication type**. Change authentication type to "password".
    - **Username**. Choose a memorable username, this will be your "root" user, and you'll need it later on.
    - **Password**. Type in a password, this will be used later for admin access so make sure it is something memorable.

      ```{image} ../images/providers/azure/password-vm.png
      :alt: Add password to VM
      ```

    - **Login with Azure Active Directory**. Choose "Off" (usually the default)
    - **Inbound port rules**. Leave the defaults for now, and we will update these later on in the Network configuration step.

7.  Before clicking on "Next" we need to select the RAM size for the image.

    - For this we need to make sure we have enough RAM to accommodate your users. For example, if each user needs 2GB of RAM, and you have 10 total users, you need at least 20GB of RAM on the machine. It's also good to have a few GB of "buffer" RAM beyond what you think you'll need.

    - Click on **Change size** (see image below)

      ```{image} ../images/providers/azure/size-vm.png
      :alt: Choose vm size
      ```

      :::{note}
      For more information about estimating memory, CPU and disk needs check [The memory section in the TLJH documentation](https://tljh.jupyter.org/en/latest/howto/admin/resource-estimation.html)
      :::

    - Select a suitable image (to check available images and prices in your region [click on this link](https://azuremarketplace.microsoft.com/en-gb/marketplace/apps/Canonical.UbuntuServer?tab=PlansAndPrice/?wt.mc_id=TLJH-github-taallard)).

8.  Disks (Storage):

    - **Disk options**: select the OS disk type there are options for SDD and HDD. **SSD persistent disk** gives you a faster but more expensive disk than HDD.

    - **Data disk**. Click on create and attach a new disk. Select an appropriate type and size and click ok.
    - Click "Next".

    ```{image} ../images/providers/azure/create-disk.png
    :alt: Create and attach disk
    ```

    ```{image} ../images/providers/azure/disk-vm.png
    :alt: Choose a disk size
    ```

9.  Networking

    - **Virtual network**. Leave the default values selected.
    - **Subnet**. Leave the default values selected.
    - **Public IP address**.Leave the default values selected. This will make your server accessible from a browser.
    - **Network Security Group**. Choose "Basic"
    - **Public inbound ports**. Check **HTTP**, **HTTPS**, and **SSH**.

    ```{image} ../images/providers/azure/networking-vm.png
    :alt: Choose networking ports
    ```

10. Management

    - Monitoring

      - **Boot diagnostics**. Choose "On".
      - **OS guest diagnostics**. Choose "Off".
      - **Diagnostics storage account**. Leave as the default.

    - Auto-Shutdown
      - **Enable auto-shutdown**. Choose "Off".
    - Backup
      - **Backup**. Choose "Off".
      - System assigned managed identity. Select "Off".

    ```{image} ../images/providers/azure/backup-vm.png
    :alt: Choose VM Backup
    ```

11. Advanced settings

    - **Extensions**. Make sure there are no extensions listed
    - **Cloud init**. We are going to use this section to install TLJH directly into our Virtual Machine.

      Copy the code snippet below:

      ```bash
      #!/bin/bash
      curl -L https://tljh.jupyter.org/bootstrap.py \
        | sudo python3 - \
          --admin <admin-user-name>
      ```

      where the `admin-user-name` is the root username you chose for your Virtual Machine.

      ```{image} ../images/providers/azure/cloudinit-vm.png
      :alt: Install TLJH
      ```

      :::{note}
      See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
      [](/topic/customizing-installer) documents other options that can be passed to the installer.
      :::

12. Check the summary and confirm the creation of your Virtual Machine.

13. Check that the creation of your Virtual Machine worked.

    - Wait for the virtual machine to be created. This might take about 5-10 minutes.

    - After completion, you should see a similar screen to the one below:

    ```{image} ../images/providers/azure/deployed-vm.png
    :alt: Deployed VM
    ```

14. Note that the Littlest JupyterHub should be installing in the background on your new server.
    It takes around 5-10 minutes for this installation to complete.

15. Click on the **Go to resource button**

    ```{image} ../images/providers/azure/goto-vm.png
    :alt: Go to VM
    ```

16. Check if the installation is completed by **copying** the **Public IP address** of your virtual machine, and trying to access it with a browser.

    ```{image} ../images/providers/azure/ip-vm.png
    :alt: Public IP address
    ```

    Note that accessing the JupyterHub will fail until the installation is complete, so be patient.

17. When the installation is complete, it should give you a JupyterHub login page.

    ```{image} ../images/first-login.png
    :alt: JupyterHub log-in page
    ```

18. 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.

19. 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

```