Skip to content

Commit

Permalink
Start documentation to use Docker Desktop
Browse files Browse the repository at this point in the history
Related to jupyterhub#3157
  • Loading branch information
rgaiacs committed Jan 7, 2025
1 parent 9a88e71 commit 1760865
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/source/getting_started/docker_desktop.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions docs/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 1760865

Please sign in to comment.