Skip to content

Commit afbf5d3

Browse files
committed
Add SPAWNERS.md, a list of specific info on spawners
1 parent c320f05 commit afbf5d3

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ This package formerly included WrapSpawner and ProfilesSpawner, which provide me
2424

2525
## Batch Spawners
2626

27+
For information on the specific spawners, see [SPAWNERS.md](SPAWNERS.md).
28+
2729
### Overview
2830

2931
This file contains an abstraction layer for batch job queueing systems (`BatchSpawnerBase`), and implements
@@ -82,6 +84,15 @@ to run Jupyter notebooks on an academic supercomputer cluster.
8284
c.TorqueSpawner.state_exechost_exp = r'int-\1.mesabi.xyz.edu'
8385
```
8486

87+
### Security
88+
89+
Unless otherwise stated for a specific spawner, assume that spawners
90+
*do* evaluate shell environment for users and thus the [security
91+
requriemnts of JupyterHub security for untrusted
92+
users](https://jupyterhub.readthedocs.io/en/stable/reference/websecurity.html)
93+
are not fulfilled.
94+
95+
8596
## Provide different configurations of BatchSpawner
8697

8798
### Overview

SPAWNERS.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Notes on specific spawners
2+
3+
## `TorqueSpawner`
4+
5+
Maintainers:
6+
7+
8+
## `MoabSpawner`
9+
10+
Subclass of TorqueSpawner
11+
12+
Maintainers:
13+
14+
15+
## `SlurmSpawner`
16+
17+
Maintainers: @rkdarst
18+
19+
This spawner enforces the environment if `srun` is used, which is the
20+
default. If you *do* want user environment to be used, set
21+
`req_srun=''`.
22+
23+
24+
## `GridengineSpawner`
25+
26+
Maintainers:
27+
28+
29+
## `CondorSpawner`
30+
31+
Maintainers:
32+
33+
34+
## `LsfSpawner`
35+
36+
Maintainers:
37+
38+
39+
# Checklist for making spawners
40+
41+
- Does your spawner read shell environment before starting?
42+
43+
- Does your spawner send SIGTERM to the jupyterhub-singleuser process
44+
before SIGKILL? It should, so that the process can terminate
45+
gracefully. If you don't see the script end (e.g. you can add `echo
46+
"terminated gracefully"` to the end of your script and see it), you
47+
should check. PR #75 might help here, ask the poster to finalize
48+
it.
49+

0 commit comments

Comments
 (0)