Skip to content

Commit

Permalink
Update some documentation about where images live
Browse files Browse the repository at this point in the history
  • Loading branch information
yuvipanda committed Oct 18, 2023
1 parent e419906 commit 04a0446
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
# JupyterHub organization Helm chart repository.
#
# ref: https://github.com/jupyterhub/helm-chart
# ref: https://hub.docker.com/orgs/jupyterhub
# ref: https://quay.io/organization/jupyterhub

publish:
runs-on: ubuntu-22.04
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ Did you get an error like one of these below?
# while running apt-get install while building a docker image with chartpress
E: Failed to fetch http://archive.ubuntu.com/ubuntu/pool/main/r/rtmpdump/librtmp1_2.4+20151223.gitfa8646d.1-1_amd64.deb Could not connect to archive.ubuntu.com:80 (91.189.88.174). - connect (113: No route to host) Could not connect to archive.ubuntu.com:80 (91.189.88.31). - connect (113: No route to host) [IP: 91.189.88.174 80]
# [...]
subprocess.CalledProcessError: Command '['docker', 'build', '-t', 'jupyterhub/k8s-hub:0.9-217f798', 'images/hub', '--build-arg', 'JUPYTERHUB_VERSION=git+https://github.com/jupyterhub/jupyterhub@master']' returned non-zero exit status 100.
subprocess.CalledProcessError: Command '['docker', 'build', '-t', 'quay.io/jupyterhub/k8s-hub:0.9-217f798', 'images/hub', '--build-arg', 'JUPYTERHUB_VERSION=git+https://github.com/jupyterhub/jupyterhub@master']' returned non-zero exit status 100.

# while installing a dependency for our k8s cluster
Unable to connect to the server: dial tcp: lookup docs.projectcalico.org on 127.0.0.53:53: read udp 127.0.0.1:56409->127.0.0.53:53: i/o timeout
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Also consider nudging dependent projects in the JupyterHub GitHub organization f
These images version/tags are set in [values.yaml](jupyterhub/values.yaml), consider bumping the version of these as well.

- [ ] [configurable-http-proxy](https://github.com/jupyterhub/configurable-http-proxy)
- [Available image tags](https://hub.docker.com/r/jupyterhub/configurable-http-proxy/tags)
- [Available image tags](https://quay.io/repository/jupyterhub/configurable-http-proxy?tab=tags)
- values.yaml entry: `proxy.chp.image`
- [ ] [traefik/traefik](https://github.com/traefik/traefik)
- [Available image tags](https://hub.docker.com/_/traefik?tab=tags)
Expand Down
4 changes: 2 additions & 2 deletions docs/source/administrator/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ changes to your `config.yaml` file:

**NOTE:**

If the proxy service is of type `LoadBalancer`, which it is by default, then a specific static IP address can be requested (if available) instead of a dynamically acquired one.
If the proxy service is of type `LoadBalancer`, which it is by default, then a specific static IP address can be requested (if available) instead of a dynamically acquired one.
Although not essential for HTTPS, using a static IP address is a recommended practice for domain names referencing fixed IPs.
This ensures the same IP address for multiple deployments.
The IP can be provided like:
Expand Down Expand Up @@ -179,7 +179,7 @@ hub:
# when debugging something from the hub pod. To use it, apply this
# configuration.
#
name: jupyterhub/k8s-hub-slim
name: quay.io/jupyterhub/k8s-hub-slim
```

```{note}
Expand Down
4 changes: 2 additions & 2 deletions docs/source/administrator/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Services can be run [externally](https://jupyterhub.readthedocs.io/en/stable/get

## Hub-managed services in z2jh

A Hub-managed service will run in the same container/pod as the Hub itself. First, you'll need to install or copy the appropriate files for the service into your Hub image, either by creating a custom image derived from [`jupyterhub/k8s-hub`](https://hub.docker.com/r/jupyterhub/k8s-hub) or the [hub.extraFiles](schema_hub.extraFiles) configuration. Keep in mind that your Hub container may need to install dependency libraries like flask or fastapi, depending on the service. In those cases, you'll need a custom image.
A Hub-managed service will run in the same container/pod as the Hub itself. First, you'll need to install or copy the appropriate files for the service into your Hub image, either by creating a custom image derived from [`jupyterhub/k8s-hub`](https://quay.io/repository/jupyterhub/k8s-hub) or the [hub.extraFiles](schema_hub.extraFiles) configuration. Keep in mind that your Hub container may need to install dependency libraries like flask or fastapi, depending on the service. In those cases, you'll need a custom image.

In addition to the code for the service, you need to modify the Hub Kubernetes Service object to include [multiple ports](https://kubernetes.io/docs/concepts/services-networking/service/#multi-port-services), and update the Hub Network Policy. If you want to allow access from all sources, you can use [hub.networkPolicy.allowedIngressPorts](schema_hub.networkPolicy.allowedIngressPorts). Otherwise if you want to more precisely control access, you can use [hub.networkPolicy.ingress](schema_hub.networkPolicy.ingress).

Expand All @@ -19,7 +19,7 @@ In the following snippet, I'm using a custom image that copies over the applicat
```Dockerfile
# Dockerfile
# 2.0.0 is latest stable release at the time of this writing
FROM jupyterhub/k8s-hub:2.0.0
FROM quay.io/jupyterhub/k8s-hub:2.0.0

# Depending on version, the k8s-hub image may have installed
# pip packages as root, forcing you to install as root as well
Expand Down
2 changes: 1 addition & 1 deletion images/hub/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ RUN --mount=type=cache,target=${PIP_CACHE_DIR} \

# The final stage - slim version
# ------------------------------
# This stage is built and published as jupyterhub/k8s-hub-slim. It is meant to
# This stage is built and published as quay.io/jupyterhub/k8s-hub-slim. It is meant to
# provide no non-essential packages.
#
FROM python:3.11-slim-bullseye as slim-stage
Expand Down
4 changes: 2 additions & 2 deletions images/singleuser-sample/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ To quickly try out this Docker image on your computer:

```sh
# with JupyterLab
docker run -it --rm -p 8888:8888 jupyterhub/k8s-singleuser-sample:2.0.0 -- jupyter lab --ip 0.0.0.0
docker run -it --rm -p 8888:8888 quay.io/jupyterhub/k8s-singleuser-sample:2.0.0 -- jupyter lab --ip 0.0.0.0
```

This image available tags can be found [here](https://hub.docker.com/r/jupyterhub/k8s-singleuser-sample/tags/).
This image available tags can be found [here](https://quay.io/repository/jupyterhub/k8s-singleuser-sample?tab=tags).

## In the base-notebook image

Expand Down

0 comments on commit 04a0446

Please sign in to comment.