Add images that can be used directly by end users #51

yuvipanda · 2023-08-08T19:19:11Z

Setting up docker images that run applications well can be a little complex, so we provide a simple base image that makes that easy. In addition, we also provide some simple derived images that have popular datascience related desktop applications set up correctly and ready to use.

The images will be published only to quay.io, to make sure people don't run into pulling limits from Dockerhub.

Base image `quay.io/jupyter-remote-desktop-proxy/base`

This image is based off the jupyter/minimal-notebook image maintained as part of jupyter/docker-stacks, and adds the following features:

The lightweight XFCE4 desktop environment
The Firefox web browser
A helper script to setup .desktop files correctly, so applications can show up in the Desktop and Application launcher.
A helper script to setup MIME associations correctly, so users can double click certain kinds of files and have them open in specific applications.

QGIS image `quay.io/jupyter-remote-desktop-proxy/qgis`

This image is based off the base image, and installs the popular QGIS application. A desktop launcher icon is provided, along with filetype associations so users can double click most files that can be opend via QGIS and they will be!
Brings in jupyter/docker-stacks#1961

Automated building

There's a build.py that automatically builds and pushes the images, dealing with dependencies as appropriate.

Thanks to @MattF-NSIDC for figuring out a lot of the qgis desktop & mime stuff.

TODO

Document how to inherit from the base image
Document policy for what applications get their own image here
Dynamic image tagging based on version of package installed inside, based on code in https://github.com/jupyter/docker-stacks/tree/main/tagging
Move the default container Dockerfile to be purely about testing Simplify developmental dockerfile #58

TODO at a later time

ARM image building support
Automated integration tests - these are difficult as we'll have to launch a browser, connect to the VNC server in the container, and somehow visually verify things work.

@MattF-NSIDC

Setting up docker images that run applications well can be a little complex, so we provide a simple base image that makes that easy. In addition, we also provide some simple derived images that have popular datascience related desktop applications set up correctly and ready to use. The images will be published *only* to [quay.io](https://quay.io/organization/jupyter-remote-desktop-proxy), to make sure people don't run into pulling limits from Dockerhub. \## Base image `quay.io/jupyter-remote-desktop-proxy/base` This image is based off the `jupyter/minimal-notebook` image maintained as part of jupyter/docker-stacks, and adds the following features: 1. The lightweight [XFCE4 desktop environment](https://www.xfce.org/) 2. The [Firefox web browser](https://www.mozilla.org/en-US/firefox/new/) 3. A helper script to setup [.desktop](https://wiki.archlinux.org/title/desktop_entries) files correctly, so applications can show up in the Desktop and Application launcher. 3. A helper script to setup [MIME associations](https://wiki.archlinux.org/title/XDG_MIME_Applications) correctly, so users can double click certain kinds of files and have them open in specific applications. \## QGIS image `quay.io/jupyter-remote-desktop-proxy/qgis` This image is based off the base image, and installs the popular [QGIS](https://qgis.org/en/site/) application. A desktop launcher icon is provided, along with filetype associations so users can double click most files that can be opend via QGIS and they will be! Brings in jupyter/docker-stacks#1961 \## Automated building There's a `build.py` that automatically builds and pushes the images, dealing with dependencies as appropriate. Thanks to @MattF-NSIDC for figuring out a lot of the qgis desktop & mime stuff. Co-authored-by: Matt Fisher <[email protected]>

github-actions · 2023-08-08T19:19:22Z

👈 Launch a binder notebook on this branch for commit 1e93ab5

I will automatically update this comment whenever this PR is modified

👈 Launch a binder notebook on this branch for commit 4513b41

👈 Launch a binder notebook on this branch for commit 9db1757

👈 Launch a binder notebook on this branch for commit 660fefe

👈 Launch a binder notebook on this branch for commit 880077a

👈 Launch a binder notebook on this branch for commit 4379b35

👈 Launch a binder notebook on this branch for commit 5d781f0

👈 Launch a binder notebook on this branch for commit 10b5740

👈 Launch a binder notebook on this branch for commit 7dbf1fa

👈 Launch a binder notebook on this branch for commit 261fa44

👈 Launch a binder notebook on this branch for commit ac05db1

👈 Launch a binder notebook on this branch for commit 6963970

👈 Launch a binder notebook on this branch for commit 28f4034

👈 Launch a binder notebook on this branch for commit c09c6aa

👈 Launch a binder notebook on this branch for commit 7040cfb

👈 Launch a binder notebook on this branch for commit ca6f889

👈 Launch a binder notebook on this branch for commit fc2a159

👈 Launch a binder notebook on this branch for commit e4387be

👈 Launch a binder notebook on this branch for commit 4adc96e

👈 Launch a binder notebook on this branch for commit 8844389

for more information, see https://pre-commit.ci

Otherwise, docker goes and pulls the base image from dockerhub, rather than using whatever is already in the local docker cache!

So future builds will actually find this built image in the local docker and use it, instead of pulling from quay.io

I do not want these

Without explicitly saying it, docker run seems to imply this

Too much noise

yuvipanda · 2023-08-24T03:25:02Z

I still need to test that the .desktop associations and mime associations actually happen when used with a JupyterHub!

consideRatio · 2023-08-25T08:30:23Z

Wieeee nice work on this @yuvipanda! I opened #55 to discuss image adding policy to offload this PR from such discussion.

- Don't run apt-get upgrade, is not necessary - Use tigervnc from apt rather than what we ship. This allows the image to work on ARM machines as well as getting us a newer version of everything. - Reorder and use COPY --chown to make rapid development faster with better caching - Remove firefox install from apt, as that no longer works anyway (it' a snap). That's set up with #51 correctly

Until #64 is merged and released

Necessary for s3 support

manics · 2023-11-08T22:18:22Z

What do you think about moving these to a separate repo? I expect jupyter-remote-desktop-proxy to have relatively few updates and releases whereas these images are likely to see more frequent updates, and will probably have a different tagging scheme to the pypi package.

yuvipanda · 2023-12-18T01:01:10Z

After reflecting on this for a while, I've written #55 (comment) and am going to close this PR

yuvipanda · 2023-12-18T01:06:41Z

@manics in practice that's what I think I'll end up doing :)

yuvipanda marked this pull request as draft August 8, 2023 19:19

yuvipanda and others added 3 commits August 8, 2023 12:20

Checkout the repo before trying to build

4513b41

[pre-commit.ci] auto fixes from pre-commit.com hooks

9db1757

for more information, see https://pre-commit.ci

Exclude .desktop files for pre-commit shebang check

660fefe

yuvipanda mentioned this pull request Aug 8, 2023

Add image with Linux Desktop environment in it jupyter/docker-stacks#1961

Closed

4 tasks

consideRatio mentioned this pull request Aug 9, 2023

Support an upstream jupyter-linux-desktop-notebook docker image 2i2c-org/infrastructure#2949

Open

yuvipanda added 16 commits August 23, 2023 12:05

Add policy for adding new images here

880077a

Switch to using docker buildx for building images

4379b35

Temporarily push to quay from PR too

5d781f0

Don't fail when no desktop or MIME files are found

7211885

Autogenerate useful tags for various built images

10b5740

Show docker container logs before tagging

7dbf1fa

Use :latest tag to build

a6e6897

Otherwise, docker goes and pulls the base image from dockerhub, rather than using whatever is already in the local docker cache!

Pass --load to docker buildx build

b17abc5

So future builds will actually find this built image in the local docker and use it, instead of pulling from quay.io

Don't use a :latest tag

1f021ef

I do not want these

Tag with current git sha too

261fa44

Use :latest

ac05db1

Without explicitly saying it, docker run seems to imply this

Push :latest tag too

6963970

Add a lot of comments to build.py

6ab33d2

Don't pass -v to update commands

28f4034

Too much noise

Document the tags we provide

c09c6aa

Add link to where one can find tags

7040cfb

yuvipanda marked this pull request as ready for review August 24, 2023 03:18

yuvipanda requested review from consideRatio and removed request for consideRatio August 24, 2023 03:18

yuvipanda marked this pull request as draft August 24, 2023 03:24

yuvipanda mentioned this pull request Aug 24, 2023

Desktop not working in Docker build #47

Closed

consideRatio mentioned this pull request Aug 25, 2023

What images are in scope for this project and the jupyterhub org? #55

Closed

Use correct path for qgis desktop image

ca6f889

yuvipanda mentioned this pull request Aug 25, 2023

Simplify developmental dockerfile #58

Merged

yuvipanda mentioned this pull request Sep 9, 2023

Split the Victor image and add corresponding profiles 2i2c-org/infrastructure#2948

Open

yuvipanda added 5 commits September 13, 2023 16:12

Add (but not enable) STAC plugin by default

fc2a159

Install qgis-plugin-manager from conda too

e4387be

Temporarily pin jupyter-remote-desktop-proxy

aff8087

Until #64 is merged and released

Install forked version of qgis-stac-plugin

4adc96e

Necessary for s3 support

Add nbgitpuller (temporarily) to base image

8844389

yuvipanda closed this Dec 18, 2023

sunu mentioned this pull request Dec 22, 2023

Feat/getting started nb developmentseed/eoapi-risk#13

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add images that can be used directly by end users #51

Add images that can be used directly by end users #51

yuvipanda commented Aug 8, 2023 •

edited

Loading

github-actions bot commented Aug 8, 2023 •

edited

Loading

yuvipanda commented Aug 24, 2023

consideRatio commented Aug 25, 2023

manics commented Nov 8, 2023 •

edited

Loading

yuvipanda commented Dec 18, 2023 •

edited

Loading

yuvipanda commented Dec 18, 2023

Add images that can be used directly by end users #51

Add images that can be used directly by end users #51

Conversation

yuvipanda commented Aug 8, 2023 • edited Loading

Base image quay.io/jupyter-remote-desktop-proxy/base

QGIS image quay.io/jupyter-remote-desktop-proxy/qgis

Automated building

TODO

TODO at a later time

github-actions bot commented Aug 8, 2023 • edited Loading

yuvipanda commented Aug 24, 2023

consideRatio commented Aug 25, 2023

manics commented Nov 8, 2023 • edited Loading

yuvipanda commented Dec 18, 2023 • edited Loading

yuvipanda commented Dec 18, 2023

yuvipanda commented Aug 8, 2023 •

edited

Loading

Base image `quay.io/jupyter-remote-desktop-proxy/base`

QGIS image `quay.io/jupyter-remote-desktop-proxy/qgis`

github-actions bot commented Aug 8, 2023 •

edited

Loading

manics commented Nov 8, 2023 •

edited

Loading

yuvipanda commented Dec 18, 2023 •

edited

Loading