Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add page about Docker Desktop to documentation #3611

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

rgaiacs
Copy link
Contributor

@rgaiacs rgaiacs commented Jan 27, 2025

This PR adds a page covering how to set up Kubernetes using Docker Desktop for development.

I tested the steps from Installing JupyterHub.

The basic Helm deployment

helm upgrade --cleanup-on-fail \
  --install dd-demo jupyterhub/jupyterhub \
  --namespace jupyterhub-demo \
  --create-namespace \
  --version=4.1.0 \
  --values config.yaml

work as expected.

kubectl get pod --namespace jupyterhub-demo

lists all pods running

NAME                             READY   STATUS    RESTARTS   AGE
continuous-image-puller-4tqvf    1/1     Running   0          31m
hub-7b5d9cb9f4-slbwc             1/1     Running   0          31m
jupyter-dummy                    1/1     Running   0          29m
proxy-8f749748f-ffb2x            1/1     Running   0          31m
user-scheduler-88b85bfb5-n79bv   1/1     Running   0          31m
user-scheduler-88b85bfb5-v2ncp   1/1     Running   0          31m

and

kubectl --namespace jupyterhub-demo get service proxy-public

lists an external IP port that works for local development

NAME           TYPE           CLUSTER-IP    EXTERNAL-IP   PORT(S)        AGE
proxy-public   LoadBalancer   10.99.50.90   10.6.46.141   80:32135/TCP   32m

This should help new developers to contribute, specially Windows users.

@rgaiacs rgaiacs self-assigned this Jan 27, 2025
@manics
Copy link
Member

manics commented Jan 29, 2025

@consideRatio what do you think? I'm a bit reluctant to recommend Docker Desktop to beginners, especially given the complex licensing.

@rgaiacs
Copy link
Contributor Author

rgaiacs commented Jan 30, 2025

I'm a bit reluctant to recommend Docker Desktop to beginners

I'm also reluctant but "Docker Desktop" is probably what beginners are taught to use at their school.

One alternative is to recommend "podman desktop" but for that we should make podman a first class in repo2docker.

@consideRatio
Copy link
Member

We are having docs on setting up against loads of third party paid services, so i figure its fine - but i'd like to list it below minikube and not at the top before minikube.

@consideRatio
Copy link
Member

I appreciate how these docs wasnt too detailed, which would make me concerned that we'd need to maintain details over time - instead its mostly linking out and providing high level steps.

@rgaiacs
Copy link
Contributor Author

rgaiacs commented Jan 30, 2025

but i'd like to list it below minikube and not at the top before minikube.

Done.

Copy link
Member

@consideRatio consideRatio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wdyt @manics?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants