Skip to content

Commit a40f61b

Browse files
committed
Support other local Kubernetes in addition to Docker Desktop
1 parent 4b5208d commit a40f61b

File tree

3 files changed

+21
-11
lines changed

3 files changed

+21
-11
lines changed
File renamed without changes.

deploy.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ def main():
437437
"release",
438438
help="Release to deploy",
439439
choices=[
440-
"docker-desktop",
440+
"localhost",
441441
"staging",
442442
"prod",
443443
"ovh",
@@ -480,7 +480,7 @@ def main():
480480

481481
args = argparser.parse_args()
482482

483-
if args.release == "docker-desktop":
483+
if args.release == "localhost":
484484
args.local = True
485485

486486
# if one argument given make cluster == release
@@ -524,7 +524,7 @@ def main():
524524
setup_auth_gcloud(args.release, cluster, args.dry_run)
525525
elif cluster in AWS_DEPLOYMENTS:
526526
setup_auth_aws(cluster, args.dry_run)
527-
elif cluster == "docker-desktop":
527+
elif cluster == "localhost":
528528
pass
529529
else:
530530
raise Exception("Cloud cluster not recognised!")

docs/source/getting_started/local_environment.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
# Getting started with local development
22

3-
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/).
3+
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.
44

5-
## Install Docker Desktop
5+
## Local Kubernetes
6+
7+
You will need a local Kubernetes cluster. A few options are
8+
9+
- [Kubernetes with Docker Desktop](https://docs.docker.com/desktop/features/kubernetes/) (recommended)
10+
- [minikube](https://minikube.sigs.k8s.io/docs/)
11+
- [k3d](https://k3d.io/stable/)
12+
- [kind](https://kind.sigs.k8s.io/)
13+
14+
### Install Docker Desktop
615

716
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).
817

9-
## Set up `kubectl` to connect to Docker Desktop
18+
## Set up `kubectl`
1019

11-
You can connect `kubectl` with Docker Desktop.
1220
To do so, run the following command:
1321

1422
```
15-
kubectl config use-context docker-desktop
23+
kubectl config use-context k8s-context-name
1624
```
1725

26+
If using Docker Desktop, `k8s-context-name` is `docker-desktop`.
27+
1828
You can test this out by running:
1929

2030
```
@@ -23,7 +33,7 @@ kubectl get -A pods
2333

2434
and a list of all running pods should be printed.
2535

26-
## Deploy Harbor to Docker Desktop
36+
## Deploy Harbor
2737

2838
Run the following command:
2939

@@ -35,7 +45,7 @@ helm repo add harbor https://helm.goharbor.io
3545
helm install harbor harbor/harbor
3646
```
3747

38-
## Deploy mybinder.org to Docker Desktop
48+
## Deploy mybinder.org
3949

4050
Run the following command:
4151

@@ -50,5 +60,5 @@ done
5060
```
5161

5262
```
53-
python deploy.py docker-desktop
63+
python deploy.py localhost
5464
```

0 commit comments

Comments
 (0)