mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
docs: manual formatting fixes following rst to myst conversion
This commit is contained in:
Erik Sundell
@@ -40,7 +40,7 @@ application to your `tljh` configuration.
|
||||
By adding following script to the ec2 instance user data you should be
|
||||
able to configure the instance automatically, replace relevant placeholders:
|
||||
|
||||
```
|
||||
```bash
|
||||
#!/bin/bash
|
||||
##############################################
|
||||
# Ensure tljh is up to date
|
||||
@@ -85,7 +85,7 @@ Using your preferred editor create the config file:
|
||||
|
||||
substituting the relevant variables:
|
||||
|
||||
```
|
||||
```python
|
||||
c.GenericOAuthenticator.client_id = "[your app ID]"
|
||||
c.GenericOAuthenticator.client_secret = "[your app Password]"
|
||||
c.GenericOAuthenticator.oauth_callback_url = "https://[your-jupyterhub-host]/hub/oauth_callback"
|
||||
|
||||
@@ -13,7 +13,7 @@ the default authenticator that ships with TLJH.
|
||||
the FirstUseAuthenticator is enabled by default in TLJH.
|
||||
:::
|
||||
|
||||
1. Enable the authenticator and reload config to apply the configuration:
|
||||
Enable the authenticator and reload config to apply the configuration:
|
||||
|
||||
```bash
|
||||
sudo tljh-config set auth.type firstuseauthenticator.FirstUseAuthenticator
|
||||
|
||||
@@ -30,27 +30,28 @@ your JupyterHub and configuring it, see [The Littlest JupyterHub guide](https://
|
||||
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
|
||||
```
|
||||
```{image} ../images/providers/azure/azure-vms.png
|
||||
:alt: Virtual machines on Azure portal
|
||||
```
|
||||
|
||||
1. Click **+ add** to create a new Virtual Machine
|
||||
3. Click **+ add** to create a new Virtual Machine
|
||||
|
||||
> ```{image} ../images/providers/azure/add-vm.png
|
||||
> :alt: Add a new virtual machine
|
||||
> ```
|
||||
```{image} ../images/providers/azure/add-vm.png
|
||||
:alt: Add a new virtual machine
|
||||
```
|
||||
|
||||
#. Select **Create VM from Marketplace** in the next screen.
|
||||
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
|
||||
> ```
|
||||
```{image} ../images/providers/azure/create-vm.png
|
||||
:alt: Create VM from the marketplace
|
||||
```
|
||||
|
||||
1. **Choose an Ubuntu server for your VM**:
|
||||
: - Click `Ubuntu Server 22.04 LTS.`
|
||||
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**
|
||||
|
||||
@@ -58,9 +59,8 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
||||
:alt: Ubuntu VM
|
||||
```
|
||||
|
||||
2. 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.
|
||||
|
||||
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}
|
||||
@@ -70,7 +70,6 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
||||
```{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".
|
||||
@@ -82,12 +81,11 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
||||
```{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.
|
||||
|
||||
3. 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.
|
||||
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)
|
||||
|
||||
@@ -101,8 +99,8 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
||||
|
||||
- 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)).
|
||||
|
||||
4. 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.
|
||||
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".
|
||||
@@ -115,9 +113,8 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
||||
:alt: Choose a disk size
|
||||
```
|
||||
|
||||
5. Networking
|
||||
: - **Virtual network**. Leave the default values selected.
|
||||
|
||||
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"
|
||||
@@ -127,24 +124,26 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
||||
:alt: Choose networking ports
|
||||
```
|
||||
|
||||
6. Management
|
||||
: - Monitoring
|
||||
: - **Boot diagnostics**. Choose "On". - **OS guest diagnostics**. Choose "Off". - **Diagnostics storage account**. Leave as the default.
|
||||
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".
|
||||
- **Enable auto-shutdown**. Choose "Off".
|
||||
- Backup
|
||||
: - **Backup**. Choose "Off".
|
||||
- System assigned managed identity Select "Off"
|
||||
- **Backup**. Choose "Off".
|
||||
- System assigned managed identity. Select "Off".
|
||||
|
||||
```{image} ../images/providers/azure/backup-vm.png
|
||||
:alt: Choose VM Backup
|
||||
```
|
||||
|
||||
7. Advanced settings
|
||||
: - **Extensions**. Make sure there are no extensions listed
|
||||
|
||||
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
|
||||
@@ -165,9 +164,9 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
||||
[](/topic/customizing-installer) documents other options that can be passed to the installer.
|
||||
:::
|
||||
|
||||
8. Check the summary and confirm the creation of your Virtual Machine.
|
||||
12. Check the summary and confirm the creation of your Virtual Machine.
|
||||
|
||||
9. Check that the creation of your Virtual Machine worked.
|
||||
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:
|
||||
@@ -176,34 +175,31 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
|
||||
:alt: Deployed VM
|
||||
```
|
||||
|
||||
10. Note that the Littlest JupyterHub should be installing in the background on your new server.
|
||||
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.
|
||||
|
||||
11. Click on the **Go to resource button**
|
||||
15. Click on the **Go to resource button**
|
||||
: ```{image} ../images/providers/azure/goto-vm.png
|
||||
:alt: Go to VM
|
||||
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
12. Check if the installation is completed by **copying** the **Public IP address** of your virtual machine, and trying to access it with a browser.
|
||||
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
|
||||
```
|
||||
|
||||
> ```{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.
|
||||
Note that accessing the JupyterHub will fail until the installation is complete, so be patient.
|
||||
|
||||
13. When the installation is complete, it should give you a JupyterHub login page.
|
||||
17. When the installation is complete, it should give you a JupyterHub login page.
|
||||
```{image} ../images/first-login.png
|
||||
:alt: JupyterHub log-in 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.
|
||||
|
||||
14. 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.
|
||||
|
||||
15. Congratulations, you have a running working JupyterHub! 🎉
|
||||
19. Congratulations, you have a running working JupyterHub! 🎉
|
||||
|
||||
## Step 2: Adding more users
|
||||
|
||||
|
||||
@@ -10,14 +10,14 @@ Tutorials to create a new server from scratch on a cloud provider & run TLJH
|
||||
on it. These are **recommended** if you do not have much experience setting up
|
||||
servers.
|
||||
|
||||
> ```{toctree}
|
||||
> :titlesonly: true
|
||||
>
|
||||
> digitalocean
|
||||
> ovh
|
||||
> jetstream
|
||||
> google
|
||||
> amazon
|
||||
> azure
|
||||
> custom-server
|
||||
> ```
|
||||
```{toctree}
|
||||
:titlesonly: true
|
||||
|
||||
digitalocean
|
||||
ovh
|
||||
jetstream
|
||||
google
|
||||
amazon
|
||||
azure
|
||||
custom-server
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user