mirror of
https://github.com/jupyterhub/the-littlest-jupyterhub.git
synced 2025-12-18 21:54:05 +08:00
Compare commits
74 Commits
2.0.0b1
...
96550b678a
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
96550b678a | ||
|
|
1bbbeacc06 | ||
|
|
d906fe8c5d | ||
|
|
27cf17d68c | ||
|
|
ca25444915 | ||
|
|
5415cc471a | ||
|
|
5891f0456b | ||
|
|
36efbc52f8 | ||
|
|
dbcaf22ae0 | ||
|
|
74b863ce22 | ||
|
|
0b1da67264 | ||
|
|
9802473764 | ||
|
|
9d8c66467c | ||
|
|
c9efb93278 | ||
|
|
596984ccbd | ||
|
|
a2e80cc89d | ||
|
|
f49c59898a | ||
|
|
fb1e1063d2 | ||
|
|
939c2b37fd | ||
|
|
da5a5abafa | ||
|
|
784e237831 | ||
|
|
50a74417f6 | ||
|
|
f13aef7568 | ||
|
|
354a8d47cc | ||
|
|
4263e4c85e | ||
|
|
134ddd9ef6 | ||
|
|
7e929fb78c | ||
|
|
3eeb028f1f | ||
|
|
0384a46720 | ||
|
|
142d22616c | ||
|
|
5ff2c8aa6f | ||
|
|
bba39bdfde | ||
|
|
c1134a5341 | ||
|
|
989f772872 | ||
|
|
d5752b6c76 | ||
|
|
dcdf2dc9b4 | ||
|
|
251099caac | ||
|
|
fa83068cdb | ||
|
|
3ee67e1581 | ||
|
|
a1f1c5e046 | ||
|
|
8e318586c3 | ||
|
|
a099bf647d | ||
|
|
8cb42a9fc1 | ||
|
|
29dda40b33 | ||
|
|
4b066766d9 | ||
|
|
947eb028a9 | ||
|
|
d695d29a6d | ||
|
|
53eceabd11 | ||
|
|
0f7d4f4748 | ||
|
|
0907ca4ad4 | ||
|
|
3397e75dc5 | ||
|
|
cd53b41b49 | ||
|
|
5916407a50 | ||
|
|
e515bcad26 | ||
|
|
5a9cb2b395 | ||
|
|
9ed2a92585 | ||
|
|
e7555ae29c | ||
|
|
73331f28fd | ||
|
|
6531b6b7aa | ||
|
|
c0563ab573 | ||
|
|
a47a171850 | ||
|
|
04e2568fb3 | ||
|
|
145d58f86e | ||
|
|
3ebdbe1d83 | ||
|
|
f573525bf0 | ||
|
|
0370b57b32 | ||
|
|
cbe577e596 | ||
|
|
64790b4c95 | ||
|
|
d2b0fd2c6c | ||
|
|
e581232920 | ||
|
|
7514616e23 | ||
|
|
06d4670512 | ||
|
|
f4538ab06b | ||
|
|
bb17a1b980 |
35
.github/integration-test.py
vendored
35
.github/integration-test.py
vendored
@@ -226,12 +226,35 @@ def main():
|
||||
copy_parser.add_argument("src")
|
||||
copy_parser.add_argument("dest")
|
||||
|
||||
run_test_parser = subparsers.add_parser("run-test")
|
||||
run_test_parser.add_argument("--installer-args", action="append")
|
||||
run_test_parser.add_argument("--upgrade-from", default="")
|
||||
run_test_parser.add_argument("--bootstrap-pip-spec", default="/srv/src")
|
||||
run_test_parser.add_argument("container_name")
|
||||
run_test_parser.add_argument("test_files", nargs="+")
|
||||
run_test_parser = subparsers.add_parser(
|
||||
"run-test",
|
||||
help="Runs the bootstrap script in a container, then executes specified integration tests.",
|
||||
)
|
||||
run_test_parser.add_argument(
|
||||
"--installer-args",
|
||||
action="append",
|
||||
default=[],
|
||||
help="Additional arguments to pass to bootstrap.py during the main installation. Can be used multiple times.",
|
||||
)
|
||||
run_test_parser.add_argument(
|
||||
"--upgrade-from",
|
||||
default="",
|
||||
help="A version/tag (e.g., 'main', 'v0.1.0') to install first, simulating an upgrade to the current source code.",
|
||||
)
|
||||
run_test_parser.add_argument(
|
||||
"--bootstrap-pip-spec",
|
||||
default="/srv/src",
|
||||
help="The pip specification used by the bootstrap script to install TLJH (for example: '--bootstrap-pip-spec=git+https://github.com/your-username/the-littlest-jupyterhub.git@branch-name'). Defaults to the local source code path.",
|
||||
)
|
||||
run_test_parser.add_argument(
|
||||
"container_name",
|
||||
help="An identifier for the container/test run (for example: 'basic-tests').",
|
||||
)
|
||||
run_test_parser.add_argument(
|
||||
"test_files",
|
||||
nargs="+",
|
||||
help="A list of one or more test files under 'integration-tests/' to be executed.",
|
||||
)
|
||||
|
||||
show_logs_parser = subparsers.add_parser("show-logs")
|
||||
show_logs_parser.add_argument("container_name")
|
||||
|
||||
11
.github/workflows/integration-test.yaml
vendored
11
.github/workflows/integration-test.yaml
vendored
@@ -51,16 +51,13 @@ jobs:
|
||||
- name: "Ubuntu 22.04, Py 3.10, from latest"
|
||||
distro_image: "ubuntu:22.04"
|
||||
extra_flags: --upgrade-from=latest
|
||||
- name: "Ubuntu 22.04, Py 3.10, from 0.2.0"
|
||||
distro_image: "ubuntu:22.04"
|
||||
extra_flags: --upgrade-from=0.2.0
|
||||
- name: "Ubuntu 22.04, Py 3.10, from 1.*"
|
||||
distro_image: "ubuntu:22.04"
|
||||
extra_flags: --upgrade-from=1
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v5
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: "3.10"
|
||||
|
||||
@@ -122,8 +119,8 @@ jobs:
|
||||
distro_image: "ubuntu:22.04"
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v5
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: "3.10"
|
||||
cache: pip
|
||||
|
||||
14
.github/workflows/unit-test.yaml
vendored
14
.github/workflows/unit-test.yaml
vendored
@@ -40,9 +40,6 @@ jobs:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- name: "Ubuntu 20.04, Py 3.9"
|
||||
ubuntu_version: "20.04"
|
||||
python_version: "3.9"
|
||||
- name: "Ubuntu 22.04, Py 3.10"
|
||||
ubuntu_version: "22.04"
|
||||
python_version: "3.10"
|
||||
@@ -51,12 +48,12 @@ jobs:
|
||||
python_version: "3.12"
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-python@v5
|
||||
- uses: actions/checkout@v5
|
||||
- uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: "${{ matrix.python_version }}"
|
||||
|
||||
- name: Install venv, git, pip and setup venv
|
||||
- name: Install system dependencies and setup venv
|
||||
run: |
|
||||
export DEBIAN_FRONTEND=noninteractive
|
||||
apt-get update
|
||||
@@ -64,7 +61,8 @@ jobs:
|
||||
python3-venv \
|
||||
python3-pip \
|
||||
bzip2 \
|
||||
git
|
||||
git \
|
||||
curl
|
||||
|
||||
python3 -m venv /srv/venv
|
||||
echo '/srv/venv/bin' >> $GITHUB_PATH
|
||||
@@ -82,4 +80,4 @@ jobs:
|
||||
run: pytest tests
|
||||
timeout-minutes: 15
|
||||
|
||||
- uses: codecov/codecov-action@v4
|
||||
- uses: codecov/codecov-action@v5
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
repos:
|
||||
# Autoformat: Python code, syntax patterns are modernized
|
||||
- repo: https://github.com/asottile/pyupgrade
|
||||
rev: v3.17.0
|
||||
rev: v3.20.0
|
||||
hooks:
|
||||
- id: pyupgrade
|
||||
args:
|
||||
@@ -31,13 +31,13 @@ repos:
|
||||
|
||||
# Autoformat: Python code
|
||||
- repo: https://github.com/pycqa/isort
|
||||
rev: 5.13.2
|
||||
rev: 6.1.0
|
||||
hooks:
|
||||
- id: isort
|
||||
|
||||
# Autoformat: Python code
|
||||
- repo: https://github.com/psf/black
|
||||
rev: 24.8.0
|
||||
- repo: https://github.com/psf/black-pre-commit-mirror
|
||||
rev: 25.9.0
|
||||
hooks:
|
||||
- id: black
|
||||
|
||||
@@ -49,7 +49,7 @@ repos:
|
||||
|
||||
# Misc...
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v4.6.0
|
||||
rev: v6.0.0
|
||||
# ref: https://github.com/pre-commit/pre-commit-hooks#hooks-available
|
||||
hooks:
|
||||
# Autoformat: Makes sure files end in a newline and only a newline.
|
||||
@@ -64,7 +64,7 @@ repos:
|
||||
|
||||
# Lint: Python code
|
||||
- repo: https://github.com/pycqa/flake8
|
||||
rev: "7.1.1"
|
||||
rev: "7.3.0"
|
||||
hooks:
|
||||
- id: flake8
|
||||
|
||||
|
||||
@@ -27,22 +27,15 @@ for information on the different ways of contributing to The Littlest JupyterHub
|
||||
See [this blog post](http://words.yuvi.in/post/the-littlest-jupyterhub/) for
|
||||
more information.
|
||||
|
||||
## Development Status
|
||||
|
||||
This project is currently in **beta** state. Folks have been using installations
|
||||
of TLJH for more than a year now to great success. While we try hard not to, we
|
||||
might still make breaking changes that have no clear upgrade pathway.
|
||||
|
||||
## Installation
|
||||
|
||||
The Littlest JupyterHub (TLJH) can run on any server that is running at least
|
||||
**Ubuntu 20.04**. Earlier versions of Ubuntu are not supported.
|
||||
**Ubuntu 22.04**. Earlier versions of Ubuntu are not supported.
|
||||
We have several tutorials to get you started.
|
||||
|
||||
- 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.
|
||||
|
||||
- [Digital Ocean](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/digitalocean.html)
|
||||
- [OVH](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/ovh.html)
|
||||
- [Google Cloud](https://the-littlest-jupyterhub.readthedocs.io/en/latest/install/google.html)
|
||||
|
||||
@@ -24,6 +24,9 @@ The easiest & safest way to develop & test TLJH is with [Docker](https://www.doc
|
||||
--detach \
|
||||
--name=tljh-dev \
|
||||
--publish 12000:80 \
|
||||
--env TLJH_BOOTSTRAP_DEV=yes \
|
||||
--env TLJH_BOOTSTRAP_PIP_SPEC=/srv/src \
|
||||
--env PATH=/opt/tljh/hub/bin:${PATH} \
|
||||
--mount type=bind,source="$(pwd)",target=/srv/src \
|
||||
tljh-systemd
|
||||
```
|
||||
@@ -58,7 +61,6 @@ The easiest & safest way to develop & test TLJH is with [Docker](https://www.doc
|
||||
|
||||
8. Make some changes to the repository. You can test easily depending on what
|
||||
you changed.
|
||||
|
||||
- If you changed the `bootstrap/bootstrap.py` script or any of its dependencies,
|
||||
you can test it by running `python3 /srv/src/bootstrap/bootstrap.py`.
|
||||
- If you changed the `tljh/installer.py` code (or any of its dependencies),
|
||||
|
||||
@@ -28,17 +28,21 @@ against the same installation of TLJH.
|
||||
|
||||
### Running integration tests locally
|
||||
|
||||
You need `docker` installed and callable by the user running
|
||||
the integration tests without needing sudo.
|
||||
You need `docker` or `podman` installed and callable by the user
|
||||
running the integration tests without needing sudo.
|
||||
|
||||
You can then run the tests with:
|
||||
First build the container with a Ubuntu-based image:
|
||||
|
||||
```bash
|
||||
.github/integration-test.py run-test <name-of-run> <test-file-names>
|
||||
.github/integration-test.py build-image \
|
||||
--build-arg "BASE_IMAGE=ubuntu:22.04"
|
||||
```
|
||||
|
||||
- `<name-of-run>` is an identifier for the tests - you can choose anything you want
|
||||
- `<test-file-names>>` is list of test files (under `integration-tests`) that should be run in one go.
|
||||
Then you can then run the tests with the `run-test` function. For usage run:
|
||||
|
||||
```bash
|
||||
.github/integration-test.py run-test --help
|
||||
```
|
||||
|
||||
For example, to run all the basic tests, you would write:
|
||||
|
||||
@@ -50,13 +54,17 @@ For example, to run all the basic tests, you would write:
|
||||
test_extensions.py
|
||||
```
|
||||
|
||||
This will run the tests in the three files against the same installation
|
||||
This will run the tests in the four files against the same installation
|
||||
of TLJH and report errors.
|
||||
|
||||
If you would like to run the tests with a custom pip spec for the bootstrap script, you can use the `--bootstrap-pip-spec`
|
||||
If you would like to run the tests with a custom `pip` spec for the bootstrap script, you can use the `--bootstrap-pip-spec`
|
||||
parameter:
|
||||
|
||||
```bash
|
||||
.github/integration-test.py run-test <name-of-run> <test-file-names> \
|
||||
.github/integration-test.py run-test custom-pip-spec \
|
||||
test_hub.py \
|
||||
test_proxy.py \
|
||||
test_install.py \
|
||||
test_extensions.py \
|
||||
--bootstrap-pip-spec="git+https://github.com/your-username/the-littlest-jupyterhub.git@branch-name"
|
||||
```
|
||||
|
||||
@@ -82,14 +82,13 @@ renew them for you before they expire.
|
||||
|
||||
## Manual HTTPS with existing key and certificate
|
||||
|
||||
You may already have an SSL key and certificate.
|
||||
You may already have an SSL key and certificate for your domain.
|
||||
If so, you can tell your deployment to use these files:
|
||||
|
||||
```
|
||||
sudo tljh-config set https.enabled true
|
||||
sudo tljh-config set https.tls.key /etc/mycerts/mydomain.key
|
||||
sudo tljh-config set https.tls.cert /etc/mycerts/mydomain.cert
|
||||
sudo tljh-config add-item https.tls.domains yourhub.yourdomain.edu
|
||||
```
|
||||
|
||||
Once you have loaded this, your config should look like:
|
||||
@@ -104,8 +103,6 @@ https:
|
||||
tls:
|
||||
key: /etc/mycerts/mydomain.key
|
||||
cert: /etc/mycerts/mydomain.cert
|
||||
domains:
|
||||
- yourhub.yourdomain.edu
|
||||
```
|
||||
|
||||
Finally, you can reload the proxy to load the new configuration:
|
||||
@@ -114,7 +111,7 @@ Finally, you can reload the proxy to load the new configuration:
|
||||
sudo tljh-config reload proxy
|
||||
```
|
||||
|
||||
and now access your Hub securely at <https://yourhub.yourdomain.edu>.
|
||||
and now access your Hub securely at the domain associated with your certificate.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
@@ -38,6 +38,8 @@ these namespacing settings might be a bit too strict and prevent users from acce
|
||||
|
||||
To override the `jupyterhub` settings, it is possible to provide a custom `/etc/systemd/system/jupyterhub.service.d/override.conf` file.
|
||||
|
||||
You can create this file with `sudo systemctl edit jupyterhub.service`
|
||||
|
||||
Here is an example for the content of the file:
|
||||
|
||||
```bash
|
||||
@@ -72,7 +74,7 @@ The output should look like the following:
|
||||
```
|
||||
|
||||
To override the `traefik` settings, create a new file under `/etc/systemd/system/traefik.service.d/override.conf`
|
||||
and follow the same steps.
|
||||
(or use `sudo systemctl edit traefik.service`) and follow the same steps.
|
||||
|
||||
## References
|
||||
|
||||
|
||||
@@ -24,7 +24,6 @@ application to your `tljh` configuration.
|
||||
1. Create a user pool [Getting Started with User Pool](https://docs.aws.amazon.com/cognito/latest/developerguide/getting-started-with-cognito-user-pools.html).
|
||||
|
||||
When you have completed creating a user pool, app, and domain you should have the following settings available to you:
|
||||
|
||||
- **App client id**: From the App client page
|
||||
|
||||
- **App client secret** From the App client page
|
||||
|
||||
@@ -26,7 +26,6 @@ You'll need a GitHub account in order to complete these steps.
|
||||
## Step 1: Create a GitHub application
|
||||
|
||||
1. Go to the [GitHub OAuth app creation page](https://github.com/settings/applications/new).
|
||||
|
||||
- **Application name**: Choose a descriptive application name (e.g. `tljh`)
|
||||
|
||||
- **Homepage URL**: Use the IP address or URL of your JupyterHub. e.g. `` http(s)://<my-tljh-url>` ``.
|
||||
|
||||
@@ -51,7 +51,6 @@ and create a new project:
|
||||
```
|
||||
|
||||
- You will have to fill a form with:
|
||||
|
||||
- **Application type**: Choose _Web application_
|
||||
|
||||
- **Name**: A descriptive name for your OAuth client ID (e.g. `tljh-client`)
|
||||
|
||||
@@ -7,7 +7,8 @@ be changed with TLJH config `user_environment.default_app` or with the
|
||||
JupyterHub config
|
||||
{external:py:attr}`jupyterhub.spawner.Spawner.default_url` directly.
|
||||
|
||||
The TLJH config supports the options `jupyterlab` and `classic`, which
|
||||
The TLJH config supports the options [`jupyterlab`](https://github.com/jupyterlab/jupyterlab/)
|
||||
and [`classic`](https://github.com/jupyter/notebook), which
|
||||
translates to a `Spawner.default_url` config of `/lab` and `/tree`.
|
||||
|
||||
Both these interfaces are also shipped with TLJH by default. You can try them
|
||||
|
||||
@@ -180,7 +180,6 @@ To upgrade the Python version of the user environment, one can:
|
||||
environment, but you may do so manually.
|
||||
|
||||
**Steps:**
|
||||
|
||||
1. Activate the user environment, if using ssh. If the terminal was
|
||||
started with JupyterHub, this step can be skipped:
|
||||
|
||||
|
||||
@@ -4,12 +4,6 @@ A simple [JupyterHub](https://github.com/jupyterhub/jupyterhub) distribution for
|
||||
a small (0-100) number of users on a single server. We recommend reading
|
||||
[](/topic/whentouse) to determine if this is the right tool for you.
|
||||
|
||||
## Development Status
|
||||
|
||||
This project is currently in **beta** state. Folks have been using installations
|
||||
of TLJH for more than a year now to great success. While we try hard not to, we
|
||||
might still make breaking changes that have no clear upgrade pathway.
|
||||
|
||||
## Installation
|
||||
|
||||
The Littlest JupyterHub (TLJH) can run on any server that is running **Debian 11** or **Ubuntu 20.04** or **22.04** on an amd64 or arm64 CPU architecture.
|
||||
|
||||
@@ -51,7 +51,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
|
||||
```
|
||||
|
||||
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**
|
||||
@@ -61,7 +60,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
@@ -89,7 +87,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
|
||||
- **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)
|
||||
@@ -105,7 +102,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
|
||||
- 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.
|
||||
@@ -120,7 +116,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
|
||||
```
|
||||
|
||||
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.
|
||||
@@ -132,9 +127,7 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
|
||||
```
|
||||
|
||||
10. Management
|
||||
|
||||
- Monitoring
|
||||
|
||||
- **Boot diagnostics**. Choose "On".
|
||||
- **OS guest diagnostics**. Choose "Off".
|
||||
- **Diagnostics storage account**. Leave as the default.
|
||||
@@ -150,7 +143,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
@@ -177,7 +169,6 @@ We start by creating the Virtual Machine in which we can run TLJH (The Littlest
|
||||
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:
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
## 2.0
|
||||
|
||||
### 2.0.0b1 - 2024-09-30
|
||||
### 2.0.0 - 2024-10-21
|
||||
|
||||
This release bundles with the latest available software from the JupyterHub
|
||||
ecosystem.
|
||||
@@ -13,17 +13,17 @@ For instructions on how to make an upgrade, see [](howto-admin-upgrade-tljh).
|
||||
|
||||
#### Breaking changes
|
||||
|
||||
- JupyterHub 4.\* has been upgraded to >=5.1.0,<6
|
||||
- JupyterHub 4.\* has been upgraded to >=5.2.0,<6
|
||||
- Refer to the [JupyterHub changelog] for details and pay attention to the
|
||||
entries for JupyterHub version 5.0.0.
|
||||
- OAuthenticator 16.0.4 has been upgraded to >=17.0.0,<18
|
||||
changelog entry for JupyterHub version 5.0.0.
|
||||
- OAuthenticator 16.0.4 has been upgraded to >=17.1.0,<18
|
||||
- If you are using an OAuthenticator based authenticator class
|
||||
(GitHubOAuthenticator, GoogleOAuthenticator, ...), refer to the
|
||||
[OAuthenticator changelog] for details and pay attention to the entries for
|
||||
JupyterHub version 17.0.0.
|
||||
[OAuthenticator changelog] for details and pay attention to the changelog
|
||||
entry for OAuthenticator version 17.0.0.
|
||||
- LDAPAuthenticator 1.3.2 has been upgraded to >=2.0.0,<3
|
||||
- If you are using this authenticator class, refer to the [LDAPAuthenticator
|
||||
changelog] for details and pay attention to the entries for
|
||||
changelog] for details and pay attention to the changelog entry for
|
||||
LDAPAuthenticator version 2.0.0.
|
||||
- The configured JupyterHub Proxy class `traefik-proxy` and the `traefik` server
|
||||
controlled by JupyterHub via the proxy class has been upgraded to a new major
|
||||
@@ -47,29 +47,29 @@ user environment. The hub environment's dependencies are on the other hand
|
||||
always upgraded to the latest version within the specified version range defined
|
||||
in [tljh/requirements-hub-env.txt] and seen below.
|
||||
|
||||
[tljh/requirements-user-env-extras.txt]: https://github.com/jupyterhub/the-littlest-jupyterhub/blob/2.0.0b1/tljh/requirements-user-env-extras.txt
|
||||
[tljh/requirements-hub-env.txt]: https://github.com/jupyterhub/the-littlest-jupyterhub/blob/2.0.0b1/tljh/requirements-hub-env.txt
|
||||
[tljh/requirements-user-env-extras.txt]: https://github.com/jupyterhub/the-littlest-jupyterhub/blob/2.0.0/tljh/requirements-user-env-extras.txt
|
||||
[tljh/requirements-hub-env.txt]: https://github.com/jupyterhub/the-littlest-jupyterhub/blob/2.0.0/tljh/requirements-hub-env.txt
|
||||
|
||||
The changes in the respective environments between TLJH version 1.0.0 and 2.0.0b1
|
||||
The changes in the respective environments between TLJH version 1.0.0 and 2.0.0
|
||||
are summarized below.
|
||||
|
||||
| Dependency changes in the _hub environment_ | Version in 1.0.0 | Version in 2.0.0b1 | Changelog link | Note |
|
||||
| ------------------------------------------------------------------------------ | ---------------- | ------------------ | ---------------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
||||
| [jupyterhub](https://github.com/jupyterhub/jupyterhub) | >=4.0.2,<5 | >=5.1.0,<6 | [Changelog](https://jupyterhub.readthedocs.io/en/stable/reference/changelog.html) | Running in the `jupyterhub` systemd service |
|
||||
| Dependency changes in the _hub environment_ | Version in 1.0.0 | Version in 2.0.0 | Changelog link | Note |
|
||||
| ------------------------------------------------------------------------------ | ---------------- | ---------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
||||
| [jupyterhub](https://github.com/jupyterhub/jupyterhub) | >=4.0.2,<5 | >=5.2.0,<6 | [Changelog](https://jupyterhub.readthedocs.io/en/stable/reference/changelog.html) | Running in the `jupyterhub` systemd service |
|
||||
| [traefik](https://github.com/traefik/traefik) | 2.10.1 | 3.1.4 | [Changelog](https://github.com/traefik/traefik/blob/master/CHANGELOG.md) | Running in the `traefik` systemd service |
|
||||
| [traefik-proxy](https://github.com/jupyterhub/traefik-proxy) | >=1.1.0,<2 | 2.\* | [Changelog](https://jupyterhub-traefik-proxy.readthedocs.io/en/latest/changelog.html) | Run by jupyterhub, controls `traefik` |
|
||||
| [systemdspawner](https://github.com/jupyterhub/systemdspawner) | >=1.0.1,<2 | >=1.0.1,<2 | [Changelog](https://github.com/jupyterhub/systemdspawner/blob/master/CHANGELOG.md) | Run by jupyterhub, controls user servers via systemd |
|
||||
| [systemdspawner](https://github.com/jupyterhub/systemdspawner) | >=1.0.1,<2 | >=1.0.2,<2 | [Changelog](https://github.com/jupyterhub/systemdspawner/blob/master/CHANGELOG.md) | Run by jupyterhub, controls user servers via systemd |
|
||||
| [jupyterhub-idle-culler](https://github.com/jupyterhub/jupyterhub-idle-culler) | >=1.2.1,<2 | >=1.4.0,<2 | [Changelog](https://github.com/jupyterhub/jupyterhub-idle-culler/blob/main/CHANGELOG.md) | Run by jupyterhub, stops inactivate servers etc. |
|
||||
| [firstuseauthenticator](https://github.com/jupyterhub/firstuseauthenticator) | >=1.0.0,<2 | 1.1.0,<2 | [Changelog](https://oauthenticator.readthedocs.io/en/latest/reference/changelog.html) | An optional way to authenticate users |
|
||||
| [tmpauthenticator](https://github.com/jupyterhub/tmpauthenticator) | >=1.0.0,<2 | 1.0.0,<2 | [Changelog](https://github.com/jupyterhub/tmpauthenticator/blob/HEAD/CHANGELOG.md) | An optional way to authenticate users |
|
||||
| [nativeauthenticator](https://github.com/jupyterhub/nativeauthenticator) | >=1.2.0,<2 | >=1.3.0,<2 | [Changelog](https://github.com/jupyterhub/nativeauthenticator/blob/HEAD/CHANGELOG.md) | An optional way to authenticate users |
|
||||
| [oauthenticator](https://github.com/jupyterhub/oauthenticator) | >=16.0.4,<17 | >=17.0.0,<18 | [Changelog](https://oauthenticator.readthedocs.io/en/latest/reference/changelog.html) | An optional way to authenticate users |
|
||||
| [ldapauthenticator](https://github.com/jupyterhub/ldapauthenticator) | >=1.3.2,<2 | ==2.0.0b2 | [Changelog](https://github.com/jupyterhub/ldapauthenticator/blob/HEAD/CHANGELOG.md) | An optional way to authenticate users |
|
||||
| [oauthenticator](https://github.com/jupyterhub/oauthenticator) | >=16.0.4,<17 | >=17.1.0,<18 | [Changelog](https://oauthenticator.readthedocs.io/en/latest/reference/changelog.html) | An optional way to authenticate users |
|
||||
| [ldapauthenticator](https://github.com/jupyterhub/ldapauthenticator) | >=1.3.2,<2 | ==2.0.0 | [Changelog](https://github.com/jupyterhub/ldapauthenticator/blob/HEAD/CHANGELOG.md) | An optional way to authenticate users |
|
||||
| [pip](https://github.com/pypa/pip) | >=23.1.2 | >=23.1.2 | [Changelog](https://pip.pypa.io/en/stable/news/) | - |
|
||||
|
||||
| Dependency changes in the _user environment_ | Version in 1.0.0 | Version in upgrade to 2.0.0b1 | Version in fresh install of 2.0.0b1 | Changelog link | Note |
|
||||
| -------------------------------------------------------- | ---------------- | ----------------------------- | ----------------------------------- | --------------------------------------------------------------------------------- | ------------------------ |
|
||||
| [jupyterhub](https://github.com/jupyterhub/jupyterhub) | >=4.0.2,<5 | >=5.1.0,<6 | >=5.1.0,<6 | [Changelog](https://jupyterhub.readthedocs.io/en/stable/reference/changelog.html) | Always upgraded. |
|
||||
| Dependency changes in the _user environment_ | Version in 1.0.0 | Version in upgrade to 2.0.0 | Version in fresh install of 2.0.0 | Changelog link | Note |
|
||||
| -------------------------------------------------------- | ---------------- | --------------------------- | --------------------------------- | --------------------------------------------------------------------------------- | ------------------------ |
|
||||
| [jupyterhub](https://github.com/jupyterhub/jupyterhub) | >=4.0.2,<5 | >=5.2.0,<6 | >=5.2.0,<6 | [Changelog](https://jupyterhub.readthedocs.io/en/stable/reference/changelog.html) | Always upgraded. |
|
||||
| [pip](https://github.com/pypa/pip) | >=23.1.2 | >=23.1.2 | >=24.2 | [Changelog](https://pip.pypa.io/en/stable/news/) | Only upgraded if needed. |
|
||||
| [conda](https://docs.conda.io/projects/conda/en/stable/) | >=4.10.0 | >=4.10.0 | ==24.7.1 | [Changelog](https://docs.conda.io/projects/conda/en/stable/release-notes.html) | Only upgraded if needed. |
|
||||
| [mamba](https://mamba.readthedocs.io/en/latest/) | >=0.16.0 | >=0.16.0 | ==1.5.9 | [Changelog](https://github.com/mamba-org/mamba/blob/main/CHANGELOG.md) | Only upgraded if needed. |
|
||||
@@ -82,12 +82,16 @@ are summarized below.
|
||||
|
||||
#### Bugs fixed
|
||||
|
||||
- hub env: avoid installing pycurl using wheel with an issue [#1006](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/1006) ([@consideRatio](https://github.com/consideRatio), [@minrk](https://github.com/minrk))
|
||||
- fix `-m` invocation of jupyterhub [#988](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/988) ([@minrk](https://github.com/minrk), [@manics](https://github.com/manics))
|
||||
- Re-install conda/mamba for every tljh upgrade (doesn't imply upgrade) [#968](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/968) ([@consideRatio](https://github.com/consideRatio), [@minrk](https://github.com/minrk))
|
||||
- Add missing oauthenticator dependency for AzureADOAuthenticator [#959](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/959) ([@consideRatio](https://github.com/consideRatio))
|
||||
|
||||
#### Maintenance and upkeep improvements
|
||||
|
||||
- Update jupyterhub pinning to >=5.2.0,<6 from ==5.1.0 [#1008](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/1008) ([@consideRatio](https://github.com/consideRatio))
|
||||
- hub env: pin to jupyterhub 5.1.0 [#1007](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/1007) ([@consideRatio](https://github.com/consideRatio))
|
||||
- hub env: bump to ldapauthenticator 2.0.0 and other lower bounds [#1004](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/1004) ([@consideRatio](https://github.com/consideRatio))
|
||||
- Bump the requirements-user-env-extras.txt lower version bounds [#1002](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/1002) ([@consideRatio](https://github.com/consideRatio))
|
||||
- Update traefik from 2.10.1 to 3.1.4 [#1001](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/1001) ([@consideRatio](https://github.com/consideRatio))
|
||||
- Update to install miniforge 24.7.1-2 from 24.7.1-0 [#999](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/999) ([@consideRatio](https://github.com/consideRatio))
|
||||
@@ -100,6 +104,7 @@ are summarized below.
|
||||
|
||||
#### Documentation improvements
|
||||
|
||||
- Remove mention about beta state [#1009](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/1009) ([@consideRatio](https://github.com/consideRatio))
|
||||
- Added missing details on how to add custom domain from manual HTTPS configuration [#983](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/983) ([@josedaudi](https://github.com/josedaudi), [@yuvipanda](https://github.com/yuvipanda))
|
||||
- Reword documentation sentence [#970](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/970) ([@davidalber](https://github.com/davidalber), [@consideRatio](https://github.com/consideRatio))
|
||||
- Fix typo and replace word [#969](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/969) ([@davidalber](https://github.com/davidalber), [@consideRatio](https://github.com/consideRatio))
|
||||
@@ -108,6 +113,7 @@ are summarized below.
|
||||
|
||||
#### Continuous integration improvements
|
||||
|
||||
- Test upgrade from 1.\* [#1003](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/1003) ([@manics](https://github.com/manics), [@minrk](https://github.com/minrk), [@consideRatio](https://github.com/consideRatio))
|
||||
- ci: cache pip only when no container is used [#997](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/997) ([@consideRatio](https://github.com/consideRatio))
|
||||
- ci: run unit tests in ubuntu-24.04 github actions environment as well [#993](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/993) ([@consideRatio](https://github.com/consideRatio))
|
||||
- ci: add tests for debian 12 and ubuntu 24.04 [#967](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/967) ([@consideRatio](https://github.com/consideRatio))
|
||||
@@ -116,14 +122,14 @@ are summarized below.
|
||||
- build(deps): bump actions/setup-python from 4 to 5 [#958](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/958) ([@consideRatio](https://github.com/consideRatio))
|
||||
- build(deps): bump actions/checkout from 3 to 4 [#943](https://github.com/jupyterhub/the-littlest-jupyterhub/pull/943) ([@consideRatio](https://github.com/consideRatio))
|
||||
|
||||
#### Contributors to this release
|
||||
## Contributors to this release
|
||||
|
||||
The following people contributed discussions, new ideas, code and documentation contributions, and review.
|
||||
See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).
|
||||
|
||||
([GitHub contributors page for this release](https://github.com/jupyterhub/the-littlest-jupyterhub/graphs/contributors?from=2023-08-11&to=2024-09-30&type=c))
|
||||
([GitHub contributors page for this release](https://github.com/jupyterhub/the-littlest-jupyterhub/graphs/contributors?from=2023-08-11&to=2024-10-21&type=c))
|
||||
|
||||
@consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3AconsideRatio+updated%3A2023-08-11..2024-09-30&type=Issues)) | @davidalber ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Adavidalber+updated%3A2023-08-11..2024-09-30&type=Issues)) | @josedaudi ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Ajosedaudi+updated%3A2023-08-11..2024-09-30&type=Issues)) | @jrdnbradford ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Ajrdnbradford+updated%3A2023-08-11..2024-09-30&type=Issues)) | @kiliansinger ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Akiliansinger+updated%3A2023-08-11..2024-09-30&type=Issues)) | @manics ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Amanics+updated%3A2023-08-11..2024-09-30&type=Issues)) | @minrk ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Aminrk+updated%3A2023-08-11..2024-09-30&type=Issues)) | @MridulS ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3AMridulS+updated%3A2023-08-11..2024-09-30&type=Issues)) | @pdebuyl ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Apdebuyl+updated%3A2023-08-11..2024-09-30&type=Issues)) | @schwebke ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Aschwebke+updated%3A2023-08-11..2024-09-30&type=Issues)) | @yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Ayuvipanda+updated%3A2023-08-11..2024-09-30&type=Issues))
|
||||
@consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3AconsideRatio+updated%3A2023-08-11..2024-10-21&type=Issues)) | @davidalber ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Adavidalber+updated%3A2023-08-11..2024-10-21&type=Issues)) | @josedaudi ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Ajosedaudi+updated%3A2023-08-11..2024-10-21&type=Issues)) | @jrdnbradford ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Ajrdnbradford+updated%3A2023-08-11..2024-10-21&type=Issues)) | @kiliansinger ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Akiliansinger+updated%3A2023-08-11..2024-10-21&type=Issues)) | @manics ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Amanics+updated%3A2023-08-11..2024-10-21&type=Issues)) | @minrk ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Aminrk+updated%3A2023-08-11..2024-10-21&type=Issues)) | @MridulS ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3AMridulS+updated%3A2023-08-11..2024-10-21&type=Issues)) | @pdebuyl ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Apdebuyl+updated%3A2023-08-11..2024-10-21&type=Issues)) | @schwebke ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Aschwebke+updated%3A2023-08-11..2024-10-21&type=Issues)) | @yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fthe-littlest-jupyterhub+involves%3Ayuvipanda+updated%3A2023-08-11..2024-10-21&type=Issues))
|
||||
|
||||
## 1.0
|
||||
|
||||
|
||||
@@ -18,12 +18,12 @@ the idle culler configuration can be extended beyond tljh-config options, using
|
||||
|
||||
## Default settings
|
||||
|
||||
By default, JupyterHub will ping the user notebook servers every 60s to check their
|
||||
status. Every server found to be idle for more than 10 minutes will be culled.
|
||||
By default, JupyterHub will ping the user notebook servers every 10 min to check their
|
||||
status. Every server found to be idle for more than 1 hour will be culled.
|
||||
|
||||
```python
|
||||
services.cull.every = 60
|
||||
services.cull.timeout = 600
|
||||
services.cull.every = 600
|
||||
services.cull.timeout = 3600
|
||||
```
|
||||
|
||||
Because the servers don't have a maximum age set, an active server will not be shut down
|
||||
|
||||
@@ -227,7 +227,7 @@ it after an argument like `remove-item` gives information about this specific co
|
||||
```bash
|
||||
sudo tljh-config --help
|
||||
|
||||
usage: tljh-config [-h] [--config-path CONFIG_PATH] {show,unset,set,add-item,remove-item,reload} ...
|
||||
usage: tljh-config [-h] [--config-path CONFIG_PATH] [--validate] [--no-validate] {show,unset,set,add-item,remove-item,reload} ...
|
||||
|
||||
positional arguments:
|
||||
{show,unset,set,add-item,remove-item,reload}
|
||||
@@ -238,10 +238,12 @@ positional arguments:
|
||||
remove-item Remove a value from a list for a configuration property
|
||||
reload Reload a component to apply configuration change
|
||||
|
||||
optional arguments:
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
--config-path CONFIG_PATH
|
||||
Path to TLJH config.yaml file
|
||||
--validate Validate the TLJH config
|
||||
--no-validate Do not validate the TLJH config
|
||||
```
|
||||
|
||||
```bash
|
||||
|
||||
@@ -22,11 +22,9 @@ container technology in administering user sessions.
|
||||
The choice between TLJH and Z2JH ultimately comes down to only a few questions:
|
||||
|
||||
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**.
|
||||
|
||||
@@ -81,7 +81,6 @@ easier. Here are some very basic tips on effective `journalctl` usage.
|
||||
[less](<https://en.wikipedia.org/wiki/Less_(Unix)>). This allows you to
|
||||
scroll up / down, search for specific words, etc. Some common keyboard shortcuts
|
||||
are:
|
||||
|
||||
- Arrow keys to move up / down / left / right
|
||||
- `G` to navigate to the end of the logs
|
||||
- `g` to navigate to the start of the logs
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Systemd inside a Docker container, for CI only
|
||||
# Systemd inside a Docker container, for CI and local development
|
||||
ARG BASE_IMAGE=ubuntu:22.04
|
||||
FROM $BASE_IMAGE
|
||||
|
||||
@@ -28,9 +28,4 @@ RUN systemctl set-default multi-user.target
|
||||
|
||||
STOPSIGNAL SIGRTMIN+3
|
||||
|
||||
# Uncomment these lines for a development install
|
||||
# ENV TLJH_BOOTSTRAP_DEV=yes
|
||||
# ENV TLJH_BOOTSTRAP_PIP_SPEC=/srv/src
|
||||
# ENV PATH=/opt/tljh/hub/bin:${PATH}
|
||||
|
||||
CMD ["/bin/bash", "-c", "exec /lib/systemd/systemd --log-target=journal 3>&1"]
|
||||
|
||||
@@ -9,9 +9,12 @@ def test_serverextensions():
|
||||
# jupyter-serverextension writes to stdout and stderr weirdly
|
||||
proc = subprocess.run(
|
||||
["/opt/tljh/user/bin/jupyter-server", "extension", "list", "--sys-prefix"],
|
||||
stderr=subprocess.PIPE,
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.STDOUT,
|
||||
)
|
||||
|
||||
output = proc.stdout.decode()
|
||||
|
||||
extensions = [
|
||||
"jupyterlab",
|
||||
"nbgitpuller",
|
||||
@@ -19,7 +22,7 @@ def test_serverextensions():
|
||||
]
|
||||
|
||||
for e in extensions:
|
||||
assert e in proc.stderr.decode()
|
||||
assert e in output, f"'{e}' not found in server extensions: {output}"
|
||||
|
||||
|
||||
def test_labextensions():
|
||||
|
||||
@@ -65,7 +65,7 @@ omit = [
|
||||
github_url = "https://github.com/jupyterhub/the-littlest-jupyterhub"
|
||||
|
||||
[tool.tbump.version]
|
||||
current = "2.0.0b1"
|
||||
current = "2.0.1.dev"
|
||||
regex = '''
|
||||
(?P<major>\d+)
|
||||
\.
|
||||
|
||||
2
setup.py
2
setup.py
@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
|
||||
|
||||
setup(
|
||||
name="the-littlest-jupyterhub",
|
||||
version="2.0.0b1",
|
||||
version="2.0.1.dev",
|
||||
description="A small JupyterHub distribution",
|
||||
url="https://github.com/jupyterhub/the-littlest-jupyterhub",
|
||||
author="Jupyter Development Team",
|
||||
|
||||
@@ -220,7 +220,8 @@ def test_cli_remove_int(tljh_dir):
|
||||
("x", "x"),
|
||||
("1x", "1x"),
|
||||
("1.2x", "1.2x"),
|
||||
(None, None),
|
||||
("None", None),
|
||||
("none", None),
|
||||
("", ""),
|
||||
],
|
||||
)
|
||||
|
||||
13
tests/test_config_schema.py
Normal file
13
tests/test_config_schema.py
Normal file
@@ -0,0 +1,13 @@
|
||||
"""
|
||||
Unit test functions to test JSON Schema validation
|
||||
"""
|
||||
|
||||
import jsonschema
|
||||
|
||||
from tljh.config_schema import config_schema
|
||||
|
||||
|
||||
def test_valid_config_json_schema():
|
||||
"""Validate that the JSON schema fits its $schema specification"""
|
||||
validator_class = jsonschema.validators.validator_for(config_schema)
|
||||
validator_class.check_schema(config_schema)
|
||||
@@ -161,12 +161,6 @@ def _specifier(version):
|
||||
"mamba": ">=1.1.0",
|
||||
},
|
||||
),
|
||||
# too-old Python (3.7), abort
|
||||
(
|
||||
"miniconda",
|
||||
"4.7.10",
|
||||
ValueError,
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_ensure_user_environment(
|
||||
|
||||
@@ -317,8 +317,8 @@ def reload_component(component):
|
||||
|
||||
def parse_value(value_str):
|
||||
"""Parse a value string"""
|
||||
if value_str is None:
|
||||
return value_str
|
||||
if value_str.lower() == "none":
|
||||
return None
|
||||
if re.match(r"^\d+$", value_str):
|
||||
return int(value_str)
|
||||
elif re.match(r"^\d+\.\d*$", value_str):
|
||||
|
||||
@@ -79,7 +79,20 @@ config_schema = {
|
||||
"description": "User CPU and memory limits.",
|
||||
"type": "object",
|
||||
"additionalProperties": False,
|
||||
"properties": {"memory": {"type": "string"}, "cpu": {"type": "integer"}},
|
||||
"properties": {
|
||||
"memory": {
|
||||
"anyOf": [
|
||||
{"type": "string"},
|
||||
{"type": "null"},
|
||||
]
|
||||
},
|
||||
"cpu": {
|
||||
"anyOf": [
|
||||
{"type": "number", "minimum": 0},
|
||||
{"type": "null"},
|
||||
]
|
||||
},
|
||||
},
|
||||
},
|
||||
"UserEnvironment": {
|
||||
"type": "object",
|
||||
|
||||
@@ -5,7 +5,6 @@ Config should never append or mutate, only set. Functions here could
|
||||
be called many times per lifetime of a jupyterhub.
|
||||
|
||||
Traitlets that modify the startup of JupyterHub should not be here.
|
||||
FIXME: A strong feeling that JSON Schema should be involved somehow.
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
@@ -293,12 +293,16 @@ def ensure_user_environment(user_requirements_txt_file):
|
||||
)
|
||||
|
||||
if user_requirements_txt_file:
|
||||
# FIXME: This currently fails hard, should fail soft and not abort installer
|
||||
try:
|
||||
conda.ensure_pip_requirements(
|
||||
USER_ENV_PREFIX,
|
||||
user_requirements_txt_file,
|
||||
upgrade=True,
|
||||
)
|
||||
except Exception as e:
|
||||
logger.warning(
|
||||
f"Failed to install requirements for user env from {user_requirements_txt_file}: {e}"
|
||||
)
|
||||
|
||||
|
||||
def ensure_admins(admin_password_list):
|
||||
@@ -530,7 +534,7 @@ def main():
|
||||
ensure_admins(args.admin)
|
||||
ensure_usergroups()
|
||||
if args.user_requirements_txt_url:
|
||||
logger.info("installing packages from user_requirements_txt_url")
|
||||
logger.info("Installing packages from user_requirements_txt_url")
|
||||
ensure_user_environment(args.user_requirements_txt_url)
|
||||
|
||||
logger.info("Setting up JupyterHub...")
|
||||
|
||||
@@ -8,13 +8,13 @@
|
||||
# If a dependency is bumped to a new major version, we should make a major
|
||||
# version release of tljh.
|
||||
#
|
||||
jupyterhub>=5.1.0,<6
|
||||
jupyterhub-systemdspawner>=1.0.1,<2
|
||||
jupyterhub>=5.2.0,<6
|
||||
jupyterhub-systemdspawner>=1.0.2,<2
|
||||
jupyterhub-firstuseauthenticator>=1.1.0,<2
|
||||
jupyterhub-nativeauthenticator>=1.3.0,<2
|
||||
jupyterhub-ldapauthenticator==2.0.0b2 # FIXME: update to >=2.0.0,<3
|
||||
jupyterhub-ldapauthenticator>=2.0.0,<3
|
||||
jupyterhub-tmpauthenticator>=1.0.0,<2
|
||||
oauthenticator>=17,<18
|
||||
oauthenticator>=17.1.0,<18
|
||||
jupyterhub-idle-culler>=1.4.0,<2
|
||||
|
||||
# pycurl is installed to improve reliability and performance for when JupyterHub
|
||||
@@ -25,4 +25,4 @@ jupyterhub-idle-culler>=1.4.0,<2
|
||||
# ref: https://www.tornadoweb.org/en/stable/httpclient.html#module-tornado.simple_httpclient
|
||||
# ref: https://github.com/jupyterhub/the-littlest-jupyterhub/issues/289
|
||||
#
|
||||
pycurl>=7.45.3,<8
|
||||
pycurl>=7.45.7,<8
|
||||
|
||||
Reference in New Issue
Block a user