Skip to content

Commit c238b5d

Browse files
authored
Merge pull request #3055 from manics/self-hosted-k8s
Replace microk8s with generic self-hosted doc
2 parents 06cdc4c + eac19bb commit c238b5d

File tree

5 files changed

+25
-171
lines changed

5 files changed

+25
-171
lines changed

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ def parse_schema(d, md=[], depth=0, pre=""):
215215
"microsoft/step-zero-azure-autoscale": "kubernetes/microsoft/step-zero-azure",
216216
"microsoft/step-zero-azure": "kubernetes/microsoft/step-zero-azure",
217217
"google/step-zero-gcp": "kubernetes/google/step-zero-gcp",
218+
"kubernetes/other-infrastructure/step-zero-microk8s": "kubernetes/other-infrastructure/step-zero-other",
218219
"create-k8s-cluster": "kubernetes/setup-kubernetes",
219220
"turn-off": "jupyterhub/uninstall",
220221
"setup-jupyterhub": "jupyterhub/index",

docs/source/kubernetes/other-infrastructure/.gitkeep

Whitespace-only changes.

docs/source/kubernetes/other-infrastructure/step-zero-microk8s.md

Lines changed: 0 additions & 170 deletions
This file was deleted.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
(self-hosted-k8s)
2+
3+
# Self-hosted Kubernetes
4+
5+
The Zero to JupyterHub guide assumes you're using a managed Kubernetes service with one of the main cloud platforms.
6+
7+
JupyterHub can be deployed on a self-hosted Kubernetes cluster, but this is not officially supported.
8+
However you may be able to get help, and find examples of other self-hosted deployments, on the [Jupyter community forum](https://discourse.jupyter.org/c/jupyterhub/10).
9+
10+
## Kubernetes cluster requirements
11+
12+
Z2JH assumes your Kubernetes cluster has the following features:
13+
14+
- [Dynamic Volume Provisioning](https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/) for persistent storage
15+
- [LoadBalancer](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) or [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) for managing external access to JupyterHub
16+
17+
Z2JH assumes you have full administrator access to the cluster.
18+
19+
In many cases you need to consult your Kubernetes provider's documentation to find out how to enable these features.
20+
Please test all these features with a simple deployment before proceeding with the Zero to JupyterHub guide.
21+
Z2JH has several interacting components which makes it much more difficult to debug Kubernetes problems, so you will save a lot of time by verifying your cluster is working correctly first.
22+
23+
It is possible to deploy Z2JH without some features, for example by [disabling persistent storage](schema_singleuser.storage.type) or using [NodePort](schema_proxy.service.type), but this is only suitable for testing.

docs/source/kubernetes/setup-kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ redhat/step-zero-openshift
1919
ibm/step-zero-ibm
2020
digital-ocean/step-zero-digital-ocean
2121
ovh/step-zero-ovh
22-
other-infrastructure/step-zero-microk8s
22+
other-infrastructure/step-zero-other
2323
```
2424

2525
```{note}

0 commit comments

Comments
 (0)