From 1eed6df18759fc583b37978dd53393e0dcbcdfda Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Fri, 27 Oct 2023 15:06:27 +0200 Subject: [PATCH 1/4] Add setup for minikube For people that are learning about BinderHub --- .../kubernetes/minikube/step-zero-minikube.md | 46 +++++++++++++++++++ docs/source/kubernetes/setup-kubernetes.md | 1 + 2 files changed, 47 insertions(+) create mode 100644 docs/source/kubernetes/minikube/step-zero-minikube.md diff --git a/docs/source/kubernetes/minikube/step-zero-minikube.md b/docs/source/kubernetes/minikube/step-zero-minikube.md new file mode 100644 index 0000000000..3e987a16be --- /dev/null +++ b/docs/source/kubernetes/minikube/step-zero-minikube.md @@ -0,0 +1,46 @@ +(minikube-k8s) + +# Kubernetes on minikube (for development only) + +[minikube](minikube) is a implementation of Kubernetes as a local cluster primarily target to the development of applications. + +```{important} +The Zero to JupyterHub guide assumes you're using a managed Kubernetes service with one of the main cloud platforms and **[minikube](minikube) is not officially supported**. You may be able to get help on the [Jupyter community forum](https://discourse.jupyter.org/c/jupyterhub/10). +``` + +## Kubernetes cluster requirements + +All the requirements are implemented in minikube >= v1.31.2: + +- [Dynamic Volume Provisioning](https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/) for persistent storage +- [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 + +## minikube installation + +Follow the installation steps in the [minikube's "Get Started!" page](https://minikube.sigs.k8s.io/docs/start/). + +## Kubernetes cluster creation + +From a terminal, run + +```bash +minikube start \ +--kubernetes-version v1.26.1 \ +--nodes 2 \ +--cpus 2 \ +--memory 2000 \ +--cni calico +``` + +To test if your cluster is initialized, run: + +``` +kubectl get node +``` + +The response should list two running nodes (or however many nodes you set with ``--nodes` above). + +Congrats. Now that you have your Kubernetes cluster running, it's time to +begin {ref}`setup-helm`. + +[minikube]: https://minikube.sigs.k8s.io/docs/ \ No newline at end of file diff --git a/docs/source/kubernetes/setup-kubernetes.md b/docs/source/kubernetes/setup-kubernetes.md index c7e00d68d6..3ad79d1169 100644 --- a/docs/source/kubernetes/setup-kubernetes.md +++ b/docs/source/kubernetes/setup-kubernetes.md @@ -11,6 +11,7 @@ Choose one option and proceed. ```{toctree} :titlesonly: +step-zero-minikube google/step-zero-gcp microsoft/step-zero-azure amazon/step-zero-aws From 4487f6ceb63e54e11aa046dabbeaf081c6c095c0 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 27 Oct 2023 13:08:03 +0000 Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/kubernetes/minikube/step-zero-minikube.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/kubernetes/minikube/step-zero-minikube.md b/docs/source/kubernetes/minikube/step-zero-minikube.md index 3e987a16be..95cbe17b18 100644 --- a/docs/source/kubernetes/minikube/step-zero-minikube.md +++ b/docs/source/kubernetes/minikube/step-zero-minikube.md @@ -43,4 +43,4 @@ The response should list two running nodes (or however many nodes you set with ` Congrats. Now that you have your Kubernetes cluster running, it's time to begin {ref}`setup-helm`. -[minikube]: https://minikube.sigs.k8s.io/docs/ \ No newline at end of file +[minikube]: https://minikube.sigs.k8s.io/docs/ From 322d6ae6f286091922e4c25581f2bdc535158b55 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Thu, 23 Nov 2023 13:03:00 +0100 Subject: [PATCH 3/4] Apply suggestions from code review --- docs/source/kubernetes/minikube/step-zero-minikube.md | 6 +++--- docs/source/kubernetes/setup-kubernetes.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/kubernetes/minikube/step-zero-minikube.md b/docs/source/kubernetes/minikube/step-zero-minikube.md index 95cbe17b18..51f878b8a4 100644 --- a/docs/source/kubernetes/minikube/step-zero-minikube.md +++ b/docs/source/kubernetes/minikube/step-zero-minikube.md @@ -1,8 +1,8 @@ (minikube-k8s) -# Kubernetes on minikube (for development only) +# Kubernetes on minikube (for trial and development only) -[minikube](minikube) is a implementation of Kubernetes as a local cluster primarily target to the development of applications. +[minikube](minikube) can setup a Kubernetes cluster on a single computer. Using minikube can be suitable trial for new Kubernetes users and for development purposes, but its not meant to be used for production purposes. ```{important} The Zero to JupyterHub guide assumes you're using a managed Kubernetes service with one of the main cloud platforms and **[minikube](minikube) is not officially supported**. You may be able to get help on the [Jupyter community forum](https://discourse.jupyter.org/c/jupyterhub/10). @@ -25,7 +25,7 @@ From a terminal, run ```bash minikube start \ ---kubernetes-version v1.26.1 \ +--kubernetes-version stable \ --nodes 2 \ --cpus 2 \ --memory 2000 \ diff --git a/docs/source/kubernetes/setup-kubernetes.md b/docs/source/kubernetes/setup-kubernetes.md index 3ad79d1169..3bf7666380 100644 --- a/docs/source/kubernetes/setup-kubernetes.md +++ b/docs/source/kubernetes/setup-kubernetes.md @@ -11,7 +11,7 @@ Choose one option and proceed. ```{toctree} :titlesonly: -step-zero-minikube +minikube/step-zero-minikube google/step-zero-gcp microsoft/step-zero-azure amazon/step-zero-aws From a317c8ad41fd84a83ef9f5650b5cb900b65911b0 Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Thu, 23 Nov 2023 13:10:58 +0100 Subject: [PATCH 4/4] docs: reference learning over trial, and fix broken link issue --- .../source/kubernetes/minikube/step-zero-minikube.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/kubernetes/minikube/step-zero-minikube.md b/docs/source/kubernetes/minikube/step-zero-minikube.md index 51f878b8a4..31f63f0b93 100644 --- a/docs/source/kubernetes/minikube/step-zero-minikube.md +++ b/docs/source/kubernetes/minikube/step-zero-minikube.md @@ -1,13 +1,15 @@ (minikube-k8s) -# Kubernetes on minikube (for trial and development only) +# Kubernetes on minikube (for learning and development only) -[minikube](minikube) can setup a Kubernetes cluster on a single computer. Using minikube can be suitable trial for new Kubernetes users and for development purposes, but its not meant to be used for production purposes. +[minikube] can setup a Kubernetes cluster on a single computer. minikube be suitable in order to learn about Kubernetes and to develop and test changes, but its not meant to be used for production purposes. ```{important} -The Zero to JupyterHub guide assumes you're using a managed Kubernetes service with one of the main cloud platforms and **[minikube](minikube) is not officially supported**. You may be able to get help on the [Jupyter community forum](https://discourse.jupyter.org/c/jupyterhub/10). +The Zero to JupyterHub guide assumes you're using a managed Kubernetes service with one of the main cloud platforms and **[minikube] is not officially supported**. You may be able to get help on the [Jupyter community forum](https://discourse.jupyter.org/c/jupyterhub/10). ``` +[minikube]: https://minikube.sigs.k8s.io/docs/ + ## Kubernetes cluster requirements All the requirements are implemented in minikube >= v1.31.2: @@ -34,7 +36,7 @@ minikube start \ To test if your cluster is initialized, run: -``` +```bash kubectl get node ``` @@ -42,5 +44,3 @@ The response should list two running nodes (or however many nodes you set with ` Congrats. Now that you have your Kubernetes cluster running, it's time to begin {ref}`setup-helm`. - -[minikube]: https://minikube.sigs.k8s.io/docs/