Move from Docker Hub to quay.io (#2010)

* Move from Docker Hub to quay.io

* Fix http->https

* Update registry-overviews

* Remove Docker Hub name

Author: mathbunnyru

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -57,7 +57,7 @@ body:
         What complete docker command do you run to launch the container (omitting sensitive values)?
       placeholder: |
         Example:
-        `docker run -it --rm -p 8888:8888 docker.io/jupyter/base-notebook`
+        `docker run -it --rm -p 8888:8888 quay.io/jupyter/base-notebook`
     validations:
       required: true
 

.github/workflows/docker-build-test-upload.yml

@@ -1,7 +1,7 @@
 name: Download parent image, build a new one and test it; then upload the image, tags and manifests to GitHub artifacts
 
 env:
-  REGISTRY: docker.io
+  REGISTRY: quay.io
   OWNER: ${{ github.repository_owner }}
 
 on:

.github/workflows/docker-merge-tags.yml

@@ -51,6 +51,7 @@ jobs:
         if: env.PUSH_TO_REGISTRY
         uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
         with:
+          registry: quay.io
           username: ${{ secrets.REGISTRY_USERNAME }}
           password: ${{ secrets.REGISTRY_TOKEN }}
 

.github/workflows/docker-tag-push.yml

@@ -1,7 +1,7 @@
 name: Download Docker image and its tags from GitHub artifacts, apply them and push the image to the Registry
 
 env:
-  REGISTRY: docker.io
+  REGISTRY: quay.io
   OWNER: ${{ github.repository_owner }}
   PUSH_TO_REGISTRY: (github.repository_owner == 'jupyter' || github.repository_owner == 'mathbunnyru') && (github.ref == 'refs/heads/main' || github.event_name == 'schedule')
 
@@ -41,6 +41,7 @@ jobs:
         if: env.PUSH_TO_REGISTRY
         uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
         with:
+          registry: quay.io
           username: ${{ secrets.REGISTRY_USERNAME }}
           password: ${{ secrets.REGISTRY_TOKEN }}
 

.github/workflows/docker.yml

@@ -248,8 +248,8 @@ jobs:
       platform: aarch64
       image: ${{ matrix.image }}
     secrets:
-      REGISTRY_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-      REGISTRY_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+      REGISTRY_USERNAME: ${{ secrets.QUAY_USERNAME }}
+      REGISTRY_TOKEN: ${{ secrets.QUAY_ROBOT_TOKEN }}
     strategy:
       matrix:
         image:
@@ -286,8 +286,8 @@ jobs:
       platform: x86_64
       image: ${{ matrix.image }}
     secrets:
-      REGISTRY_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-      REGISTRY_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+      REGISTRY_USERNAME: ${{ secrets.QUAY_USERNAME }}
+      REGISTRY_TOKEN: ${{ secrets.QUAY_ROBOT_TOKEN }}
     strategy:
       matrix:
         image:
@@ -322,8 +322,8 @@ jobs:
     with:
       image: ${{ matrix.image }}
     secrets:
-      REGISTRY_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
-      REGISTRY_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+      REGISTRY_USERNAME: ${{ secrets.QUAY_USERNAME }}
+      REGISTRY_TOKEN: ${{ secrets.QUAY_ROBOT_TOKEN }}
     strategy:
       matrix:
         image:

.github/workflows/registry-overviews.yml

@@ -16,7 +16,6 @@ on:
 jobs:
   update-overview:
     runs-on: ubuntu-latest
-    name: update-overview (${{matrix.image}})
     if: github.repository_owner == 'jupyter' || github.repository_owner == 'mathbunnyru'
 
     steps:
@@ -26,34 +25,24 @@ jobs:
       - name: Push README to Registry 🐳
         uses: christian-korneck/update-container-description-action@d36005551adeaba9698d8d67a296bd16fa91f8e8 # v1
         env:
-          DOCKER_USER: ${{ secrets.DOCKERHUB_USERNAME }}
-          DOCKER_PASS: ${{ secrets.DOCKERHUB_TOKEN }}
+          DOCKER_APIKEY: ${{ secrets.APIKEY__QUAY_IO }}
         with:
-          destination_container_repo: ${{ env.OWNER }}/${{ matrix.image }}
-          provider: dockerhub
-          short_description: ${{ matrix.description }}
+          destination_container_repo: quay.io/${{ env.OWNER }}/${{ matrix.image }}
+          provider: quay
           readme_file: images/${{ matrix.image }}/README.md
 
     strategy:
       matrix:
-        include:
-          - image: docker-stacks-foundation
-            description: "Tiny base image on which Jupyter apps can be built from https://github.com/jupyter/docker-stacks"
-          - image: base-notebook
-            description: "Base image for Jupyter Notebook stacks from https://github.com/jupyter/docker-stacks"
-          - image: minimal-notebook
-            description: "Minimal Jupyter Notebook Python Stack from https://github.com/jupyter/docker-stacks"
-          - image: scipy-notebook
-            description: "Scientific Jupyter Notebook Python Stack from https://github.com/jupyter/docker-stacks"
-          - image: r-notebook
-            description: "R Jupyter Notebook Stack from https://github.com/jupyter/docker-stacks"
-          - image: julia-notebook
-            description: "Julia Jupyter Notebook Stack from https://github.com/jupyter/docker-stacks"
-          - image: tensorflow-notebook
-            description: "Scientific Jupyter Notebook Python Stack w/ TensorFlow from https://github.com/jupyter/docker-stacks"
-          - image: datascience-notebook
-            description: "Data Science Jupyter Notebook Python Stack from https://github.com/jupyter/docker-stacks"
-          - image: pyspark-notebook
-            description: "Python and Spark Jupyter Notebook Stack from https://github.com/jupyter/docker-stacks"
-          - image: all-spark-notebook
-            description: "Python, Scala, R and Spark Jupyter Notebook Stack from https://github.com/jupyter/docker-stacks"
+        image:
+          [
+            docker-stacks-foundation,
+            base-notebook,
+            minimal-notebook,
+            scipy-notebook,
+            r-notebook,
+            julia-notebook,
+            tensorflow-notebook,
+            datascience-notebook,
+            pyspark-notebook,
+            all-spark-notebook,
+          ]

Makefile

@@ -4,7 +4,7 @@
 
 # Use bash for inline if-statements in arch_patch target
 SHELL:=bash
-REGISTRY?=docker.io
+REGISTRY?=quay.io
 OWNER?=jupyter
 
 # Need to list the images in build dependency order

README.md

@@ -7,7 +7,7 @@
 [![Discourse badge](https://img.shields.io/discourse/users.svg?color=%23f37626&server=https%3A%2F%2Fdiscourse.jupyter.org)](https://discourse.jupyter.org/ "Jupyter Discourse Forum")
 [![Binder badge](https://static.mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter/docker-stacks/main?urlpath=lab/tree/README.ipynb "Launch a jupyter/base-notebook container on mybinder.org")
 
-Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://hub.docker.com/u/jupyter) containing Jupyter applications and interactive computing tools.
+Jupyter Docker Stacks are a set of ready-to-run [Docker images](https://quay.io/organization/jupyter) containing Jupyter applications and interactive computing tools.
 You can use a stack image to do any of the following (and more):
 
 - Start a personal Jupyter Server with the JupyterLab frontend (default)
@@ -27,11 +27,11 @@ The [User Guide on ReadTheDocs](https://jupyter-docker-stacks.readthedocs.io/en/
 
 ### Example 1
 
-This command pulls the `jupyter/scipy-notebook` image tagged `2023-09-25` from Docker Hub if it is not already present on the local host.
+This command pulls the `jupyter/scipy-notebook` image tagged `2023-09-25` from Quay.io if it is not already present on the local host.
 It then starts a container running a Jupyter Server with the JupyterLab frontend and exposes the container's internal port `8888` to port `10000` of the host machine:
 
 ```bash
-docker run -p 10000:8888 docker.io/jupyter/scipy-notebook:2023-09-25
+docker run -p 10000:8888 quay.io/jupyter/scipy-notebook:2023-09-25
 ```
 
 You can modify the port on which the container's port is exposed by [changing the value of the `-p` option](https://docs.docker.com/engine/reference/run/#expose-incoming-ports) to `-p 8888:8888`.
@@ -46,11 +46,11 @@ The container remains intact for restart after the Server exits.
 
 ### Example 2
 
-This command pulls the `jupyter/datascience-notebook` image tagged `2023-09-25` from Docker Hub if it is not already present on the local host.
+This command pulls the `jupyter/datascience-notebook` image tagged `2023-09-25` from Quay.io if it is not already present on the local host.
 It then starts an _ephemeral_ container running a Jupyter Server with the JupyterLab frontend and exposes the server on host port 10000.
 
 ```bash
-docker run -it --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work docker.io/jupyter/datascience-notebook:2023-09-25
+docker run -it --rm -p 10000:8888 -v "${PWD}":/home/jovyan/work quay.io/jupyter/datascience-notebook:2023-09-25
 ```
 
 The use of the `-v` flag in the command mounts the current working directory on the host (`${PWD}` in the example command) as `/home/jovyan/work` in the container.
@@ -113,7 +113,7 @@ more information is available in the [documentation](https://jupyter-docker-stac
 - [Issue Tracker on GitHub](https://github.com/jupyter/docker-stacks/issues)
 - [Jupyter Discourse Forum](https://discourse.jupyter.org/)
 - [Jupyter Website](https://jupyter.org)
-- [Images on Docker Hub](https://hub.docker.com/u/jupyter)
+- [Images on Quay.io](https://quay.io/organization/jupyter)
 
 ## CPU Architectures
 

binder/Dockerfile

@@ -1,8 +1,8 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 
-# https://hub.docker.com/r/jupyter/base-notebook/tags
-ARG REGISTRY=docker.io
+# https://quay.io/repository/jupyter/base-notebook?tab=tags
+ARG REGISTRY=quay.io
 ARG OWNER=jupyter
 ARG BASE_CONTAINER=$REGISTRY/$OWNER/base-notebook:2023-09-25
 FROM $BASE_CONTAINER

docs/contributing/stacks.md

@@ -8,7 +8,7 @@ Following these steps will:
 
 1. Set up a project on GitHub containing a Dockerfile based on any image we provide.
 2. Configure GitHub Actions to build and test your image when users submit pull requests to your repository.
-3. Configure Docker Hub to host your images for others to use.
+3. Configure Quay.io to host your images for others to use.
 4. Update the [list of community stacks](../using/selecting.md#community-stacks) in this documentation to include your image.
 
 This approach mirrors how we build and share the core stack images.
@@ -35,8 +35,8 @@ This will serve as both the git repository name and the part of the Docker image
 stack_name [my-jupyter-stack]:
 ```
 
-Enter the user or organization name under which this stack will reside on Docker Hub.
-You must have access to manage this Docker Hub organization to push images here.
+Enter the user or organization name under which this stack will reside on Quay.io.
+You must have access to manage this Quay.io organization to push images here.
 
 ```text
 stack_org [my-project]:
@@ -89,6 +89,10 @@ git push -u origin main
 
 ## Configuring Docker Hub
 
+```{note}
+Jupyter Docker Stacks are hosted on Quay.io, but in this example, we show you how to host your image on Docker Hub.
+```
+
 Now, configure Docker Hub to build your stack image and push it to the Docker Hub repository whenever
 you merge a GitHub pull request to the main branch of your project.
 

docs/maintaining/tasks.md

@@ -56,7 +56,7 @@ When there's a new stack definition, check before merging the PR:
 
 ## Adding a New Maintainer Account
 
-1. Visit <https://hub.docker.com/orgs/jupyter/teams/stacks/members>
+1. Visit <https://quay.io/organization/jupyter/teams/owners>
 2. Add the maintainer's username.
 3. Visit <https://github.com/orgs/jupyter/teams/docker-image-maintainers/members>
 4. Add the maintainer's GitHub username.

docs/using/common.md

@@ -15,14 +15,14 @@ You can pass [Jupyter Server options](https://jupyter-server.readthedocs.io/en/l
    you can run the following (this hash was generated for the `my-password` password):
 
    ```bash
-   docker run -it --rm -p 8888:8888 docker.io/jupyter/base-notebook \
+   docker run -it --rm -p 8888:8888 quay.io/jupyter/base-notebook \
        start-notebook.py --PasswordIdentityProvider.hashed_password='argon2:$argon2id$v=19$m=10240,t=10,p=8$JdAN3fe9J45NvK/EPuGCvA$O/tbxglbwRpOFuBNTYrymAEH6370Q2z+eS1eF4GM6Do'
    ```
 
 2. To set the [base URL](https://jupyter-server.readthedocs.io/en/latest/operators/public-server.html#running-the-notebook-with-a-customized-url-prefix) of the Jupyter Server, you can run the following:
 
    ```bash
-   docker run  -it --rm -p 8888:8888 docker.io/jupyter/base-notebook \
+   docker run  -it --rm -p 8888:8888 quay.io/jupyter/base-notebook \
        start-notebook.py --ServerApp.base_url=/customized/url/prefix/
    ```
 
@@ -49,7 +49,7 @@ You do so by passing arguments to the `docker run` command.
       -e NB_USER="my-username" \
       -e CHOWN_HOME=yes \
       -w "/home/my-username" \
-      docker.io/jupyter/base-notebook
+      quay.io/jupyter/base-notebook
   ```
 
 - `-e NB_UID=<numeric uid>` - Instructs the startup script to switch the numeric user ID of `${NB_USER}` to the given value.
@@ -146,7 +146,7 @@ For example, to mount a host folder containing a `notebook.key` and `notebook.cr
 ```bash
 docker run -it --rm -p 8888:8888 \
     -v /some/host/folder:/etc/ssl/notebook \
-    docker.io/jupyter/base-notebook \
+    quay.io/jupyter/base-notebook \
     start-notebook.py \
     --ServerApp.keyfile=/etc/ssl/notebook/notebook.key \
     --ServerApp.certfile=/etc/ssl/notebook/notebook.crt
@@ -158,7 +158,7 @@ For example:
 ```bash
 docker run -it --rm -p 8888:8888 \
     -v /some/host/folder/notebook.pem:/etc/ssl/notebook.pem \
-    docker.io/jupyter/base-notebook \
+    quay.io/jupyter/base-notebook \
     start-notebook.py \
     --ServerApp.certfile=/etc/ssl/notebook.pem
 ```
@@ -207,14 +207,14 @@ Example:
 docker run -it --rm \
     -p 8888:8888 \
     -e DOCKER_STACKS_JUPYTER_CMD=notebook \
-    docker.io/jupyter/base-notebook
+    quay.io/jupyter/base-notebook
 # Executing the command: jupyter notebook ...
 
 # Use Jupyter NBClassic frontend
 docker run -it --rm \
     -p 8888:8888 \
     -e DOCKER_STACKS_JUPYTER_CMD=nbclassic \
-    docker.io/jupyter/base-notebook
+    quay.io/jupyter/base-notebook
 # Executing the command: jupyter nbclassic ...
 ```
 
@@ -225,7 +225,7 @@ The `start.sh` script supports all the features described above but allows you t
 For example, to run the text-based `ipython` console in a container, do the following:
 
 ```bash
-docker run -it --rm docker.io/jupyter/base-notebook start.sh ipython
+docker run -it --rm quay.io/jupyter/base-notebook start.sh ipython
 ```
 
 This script is handy when you derive a new Dockerfile from this image and install additional Jupyter applications with subcommands like `jupyter console`, `jupyter kernelgateway`, etc.

docs/using/recipe_code/custom_environment.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 # Name your environment and choose the python version
 ARG env_name=python310

docs/using/recipe_code/dask_jupyterlab.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 # Install the Dask dashboard
 RUN mamba install --yes 'dask-labextension' && \

docs/using/recipe_code/jupyterhub_version.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 RUN mamba install --yes 'jupyterhub==4.0.1' && \
     mamba clean --all -f -y && \

docs/using/recipe_code/mamba_install.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 RUN mamba install --yes 'flake8' && \
     mamba clean --all -f -y && \

docs/using/recipe_code/manpage_install.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 # Fix: https://github.com/hadolint/hadolint/wiki/DL4006
 # Fix: https://github.com/koalaman/shellcheck/wiki/SC3014

docs/using/recipe_code/microsoft_odbc.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 # Fix: https://github.com/hadolint/hadolint/wiki/DL4006
 # Fix: https://github.com/koalaman/shellcheck/wiki/SC3014

docs/using/recipe_code/oracledb.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 USER root
 

docs/using/recipe_code/pip_install.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 # Install in the default python3 environment
 RUN pip install --no-cache-dir 'flake8' && \

docs/using/recipe_code/rise_jupyterlab.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 RUN mamba install --yes 'jupyterlab_rise' && \
     mamba clean --all -f -y && \

docs/using/recipe_code/spellcheck_notebookv6.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook:notebook-6.5.4
+FROM quay.io/jupyter/base-notebook:notebook-6.5.4
 
 RUN pip install --no-cache-dir 'jupyter_contrib_nbextensions' && \
     jupyter contrib nbextension install --user && \

docs/using/recipe_code/xgboost.dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/jupyter/base-notebook
+FROM quay.io/jupyter/base-notebook
 
 RUN mamba install --yes 'py-xgboost' && \
     mamba clean --all -f -y && \