Skip to content

Commit 2778592

Browse files
committed
chore: Adjust README
1 parent 8105360 commit 2778592

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,31 @@ Currently, if you want to deploy `Jupyter` notebooks on `Kubernetes` using avail
2828
- `JupyterHub` comes with its own [node-http-proxy](https://github.com/jupyterhub/configurable-http-proxy) for reverse proxying, **but** why not making use of the well-established [Ingress NGINX Controller](https://github.com/kubernetes/ingress-nginx)?
2929
`notebook-on-kube` deploys an `Ingress NGINX` Controller instance and configures it for each notebook via `Ingress` resources.
3030

31-
`notebook-on-kube` re-uses these features and tools that are already there and are tailored to run applications on `Kubernetes` and provides a third, middle ground, approach to managing notebooks on `Kubernetes`!
31+
`notebook-on-kube` re-uses these features and tools that are already there and are tailored to run applications on `Kubernetes` and provides a third, middle ground, easy to maintain and well-integrated approach to managing notebooks on `Kubernetes`!
32+
33+
It provides the following features:
34+
- Authn/authz based on `Kubernetes'`.
35+
- Customize and create notebooks.
36+
- Connect to notebooks.
37+
- Pause/Resume notebooks.
38+
- Get notebooks' events.
39+
- See [next steps](#next-steps).
3240

3341
<p align="center">
3442
<img src="artwork/notebook-on-kube.drawio.png" />
3543
</p>
3644

3745
### How to use?
3846

47+
You need access to a `Kubernetes` cluster with an [OIDC token](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens).
48+
3949
- You can deploy `notebook-on-kube` on a `Kubernetes` cluster using Helm:
4050
```bash
4151
helm repo add notebook-on-kube https://machine424.github.io/notebook-on-kube
4252
helm install nok notebook-on-kube/notebook-on-kube
4353
```
4454
- Or run the docker image directly from [here](https://hub.docker.com/repository/docker/machine424/notebook-on-kube/general).
45-
- Or clone the repo and run:.
55+
- Or clone the repo and run:
4656
```bash
4757
pip install -e .
4858
notebook-on-kube

0 commit comments

Comments
 (0)