From 71decec7d2431f88f793496ba0af8662020d0f6b Mon Sep 17 00:00:00 2001 From: Dan Lester Date: Fri, 5 Jul 2019 12:12:16 +0100 Subject: [PATCH 1/3] Create step-zero-local-dev.rst --- doc/source/local/step-zero-local-dev.rst | 25 ++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 doc/source/local/step-zero-local-dev.rst diff --git a/doc/source/local/step-zero-local-dev.rst b/doc/source/local/step-zero-local-dev.rst new file mode 100644 index 0000000000..07d94725e5 --- /dev/null +++ b/doc/source/local/step-zero-local-dev.rst @@ -0,0 +1,25 @@ +.. _local-dev: + +Step Zero: Kubernetes on your local machine (dev/test) +------------------------------------------------------ + +It is possible to set up Kubernetes to run entirely on your laptop or desktop computer for testing or development purposes. + +You need to choose a way to run Kubernetes. Here are some guides for the different operating systems explaining +how you might choose from the options available and how to set them up: + +* Windows: `choices are MiniKube or Docker Desktop `_ +* MacOS: `choices are MiniKube or Docker Desktop `_ +* Linux: `choices are MiniKube or MicroK8s `_ + +You should then be able to proceed with the rest of Zero to JupyterHub, but be aware of some issues if using Kubernetes within Docker Desktop: + +* You may need to increase the amount of memory available to Docker Engine. This can be done in the Advanced tab + of Preferences in the Docker control panel. An appropriate error message should appear if insufficient memory is available. +* The version of Kubernetes that comes with Docker Desktop may be a few versions old, and when you run the ``heml upgrade ...`` + command it may say something like ``Error: Chart requires kubernetesVersion: >=1.11.0-0 which is incompatible with Kubernetes v1.10.11``. + The easiest thing may be to try earliers version numbers of the + `Helm Chart from this table `_ until things work, + although then be aware that the rest of the Zero to JupyterHub instructions might have been targeting the more recent versions. + +Once you have your Kubernetes cluster running, it's time to begin :ref:`creating-your-jupyterhub`. From 44911542dc12a9820f7e2ffadcfffe875f7e0b0c Mon Sep 17 00:00:00 2001 From: Dan Lester Date: Fri, 5 Jul 2019 12:12:46 +0100 Subject: [PATCH 2/3] Update step-zero-local-dev.rst --- doc/source/local/step-zero-local-dev.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/local/step-zero-local-dev.rst b/doc/source/local/step-zero-local-dev.rst index 07d94725e5..c03e00f5e1 100644 --- a/doc/source/local/step-zero-local-dev.rst +++ b/doc/source/local/step-zero-local-dev.rst @@ -16,7 +16,7 @@ You should then be able to proceed with the rest of Zero to JupyterHub, but be a * You may need to increase the amount of memory available to Docker Engine. This can be done in the Advanced tab of Preferences in the Docker control panel. An appropriate error message should appear if insufficient memory is available. -* The version of Kubernetes that comes with Docker Desktop may be a few versions old, and when you run the ``heml upgrade ...`` +* The version of Kubernetes that comes with Docker Desktop may be a few versions old, and when you run the ``helm upgrade ...`` command it may say something like ``Error: Chart requires kubernetesVersion: >=1.11.0-0 which is incompatible with Kubernetes v1.10.11``. The easiest thing may be to try earliers version numbers of the `Helm Chart from this table `_ until things work, From 635c147bd1683e2ba6acb22a04be9ef08af2b72a Mon Sep 17 00:00:00 2001 From: Dan Lester Date: Fri, 5 Jul 2019 12:14:11 +0100 Subject: [PATCH 3/3] Update create-k8-cluster to include local dev instructions --- doc/source/create-k8s-cluster.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/source/create-k8s-cluster.rst b/doc/source/create-k8s-cluster.rst index 0e1cc56c28..0d4746d8ed 100644 --- a/doc/source/create-k8s-cluster.rst +++ b/doc/source/create-k8s-cluster.rst @@ -20,6 +20,7 @@ Choose one option and proceed. redhat/step-zero-openshift ibm/step-zero-ibm digital-ocean/step-zero-digital-ocean + local/step-zero-local-dev .. note::