From 17608653e4a33e358e6f60606228749c35df87a1 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Tue, 7 Jan 2025 17:00:49 +0100 Subject: [PATCH] Start documentation to use Docker Desktop Related to https://github.com/jupyterhub/mybinder.org-deploy/issues/3157 --- docs/source/getting_started/docker_desktop.md | 24 +++++++++++++++++++ docs/source/getting_started/index.rst | 1 + 2 files changed, 25 insertions(+) create mode 100644 docs/source/getting_started/docker_desktop.md diff --git a/docs/source/getting_started/docker_desktop.md b/docs/source/getting_started/docker_desktop.md new file mode 100644 index 000000000..1abb46ce1 --- /dev/null +++ b/docs/source/getting_started/docker_desktop.md @@ -0,0 +1,24 @@ +# Getting started with local development + +This page contains a starting point for people who want to know more about the BinderHub deployment by playing around with a local development instance running on Kubernetes with [Docker Desktop](https://docs.docker.com/desktop/). + +## Install Docker Desktop + +Install Docker Desktop on [Mac](https://docs.docker.com/desktop/setup/install/mac-install/), [Windows](https://docs.docker.com/desktop/setup/install/windows-install/), or [Linux](https://docs.docker.com/desktop/setup/install/linux/). And [turn on Kubernetes](https://docs.docker.com/desktop/features/kubernetes/#install-and-turn-on-kubernetes). + +## Set up `kubectl` to connect to Docker Desktop + +You can connect `kubectl` with Docker Desktop. +To do so, run the following command: + +``` +kubectl config use-context docker-desktop +``` + +You can test this out by running: + +``` +kubectl get -A pods +``` + +and a list of all running pods should be printed. diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst index f61b55744..a6747dc8c 100644 --- a/docs/source/getting_started/index.rst +++ b/docs/source/getting_started/index.rst @@ -9,6 +9,7 @@ permissions, as well as contextual information about the mybinder.org deployment .. toctree:: :maxdepth: 3 + docker_desktop getting_started production_environment terminology