From 3bc4b6da9a5a0762e8815b84d5dc999542fd203b Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Tue, 19 Dec 2023 15:51:28 +0000 Subject: [PATCH] chore: update README, stop building deprecated images (#240) --- README.md | 38 ++++-------------- .../android/Dockerfile.ubuntu | 0 {images => deprecated}/android/README.md | 0 .../clion/Dockerfile.ubuntu | 0 {images => deprecated}/clion/README.md | 0 .../configure/Dockerfile.ubuntu | 0 {images => deprecated}/configure/README.md | 0 {images => deprecated}/configure/configure | 0 .../configure/deprecated.txt | 0 .../dataSpell/Dockerfile.ubuntu | 0 .../goland/Dockerfile.ubuntu | 0 {images => deprecated}/goland/README.md | 0 .../golang/Dockerfile.ubuntu | 0 {images => deprecated}/golang/README.md | 0 {images => deprecated}/golang/deprecated.txt | 0 .../intellij/Dockerfile.ubuntu | 0 {images => deprecated}/intellij/README.md | 0 {images => deprecated}/java/Dockerfile.ubuntu | 0 {images => deprecated}/java/README.md | 0 {images => deprecated}/java/deprecated.txt | 0 .../jupyter/Dockerfile.ubuntu | 0 {images => deprecated}/jupyter/README.md | 0 {images => deprecated}/jupyter/deprecated.txt | 0 .../multieditor/Dockerfile.ubuntu | 0 {images => deprecated}/multieditor/README.md | 0 .../multieditor/deprecated.txt | 0 {images => deprecated}/node/Dockerfile.ubuntu | 0 {images => deprecated}/node/README.md | 0 {images => deprecated}/node/deprecated.txt | 0 .../pycharm/Dockerfile.ubuntu | 0 {images => deprecated}/pycharm/README.md | 0 {images => deprecated}/ruby/Dockerfile.ubuntu | 0 {images => deprecated}/ruby/deprecated.txt | 0 {images => deprecated}/ruby/install-ruby.sh | 0 {images => deprecated}/rust/Dockerfile.ubuntu | 0 {images => deprecated}/rust/README.md | 0 {images => deprecated}/rust/deprecated.txt | 0 {images => deprecated}/rust/rustup.sh | 0 {images => deprecated}/vnc/Dockerfile.ubuntu | 0 {images => deprecated}/vnc/README.md | 0 .../vnc/coder/apps/config.yaml | 0 .../vnc/coder/apps/desktop.png | Bin {images => deprecated}/vnc/coder/configure | 0 {images => deprecated}/vnc/deprecated.txt | 0 {images => deprecated}/vnc/example.png | Bin .../vnc/supervisor/conf.d/novnc.conf | 0 .../vnc/supervisor/conf.d/vncserver.conf | 0 .../vnc/supervisor/supervisord.conf | 0 {images => deprecated}/vnc/vnc/index.html | 0 .../vnc/vnc/scripts/vncserver.sh | 0 .../vnc/vnc/setup/no_vnc.sh | 0 .../vnc/vnc/setup/set_user_permission.sh | 0 {images => deprecated}/vnc/vnc/xstartup | 0 {images => deprecated}/vnc/xfce4/coder-bg.jpg | Bin {images => deprecated}/vnc/xfce4/helpers.rc | 0 .../xfconf/xfce-perchannel-xml/displays.xml | 0 .../xfce-perchannel-xml/xfce4-desktop.xml | 0 .../xfconf/xfce-perchannel-xml/xfwm4.xml | 0 .../xfconf/xfce-perchannel-xml/xsettings.xml | 0 .../webstorm/Dockerfile.ubuntu | 0 {images => deprecated}/webstorm/README.md | 0 scripts/images.sh | 20 --------- 62 files changed, 8 insertions(+), 50 deletions(-) rename {images => deprecated}/android/Dockerfile.ubuntu (100%) rename {images => deprecated}/android/README.md (100%) rename {images => deprecated}/clion/Dockerfile.ubuntu (100%) rename {images => deprecated}/clion/README.md (100%) rename {images => deprecated}/configure/Dockerfile.ubuntu (100%) rename {images => deprecated}/configure/README.md (100%) rename {images => deprecated}/configure/configure (100%) rename {images => deprecated}/configure/deprecated.txt (100%) rename {images => deprecated}/dataSpell/Dockerfile.ubuntu (100%) rename {images => deprecated}/goland/Dockerfile.ubuntu (100%) rename {images => deprecated}/goland/README.md (100%) rename {images => deprecated}/golang/Dockerfile.ubuntu (100%) rename {images => deprecated}/golang/README.md (100%) rename {images => deprecated}/golang/deprecated.txt (100%) rename {images => deprecated}/intellij/Dockerfile.ubuntu (100%) rename {images => deprecated}/intellij/README.md (100%) rename {images => deprecated}/java/Dockerfile.ubuntu (100%) rename {images => deprecated}/java/README.md (100%) rename {images => deprecated}/java/deprecated.txt (100%) rename {images => deprecated}/jupyter/Dockerfile.ubuntu (100%) rename {images => deprecated}/jupyter/README.md (100%) rename {images => deprecated}/jupyter/deprecated.txt (100%) rename {images => deprecated}/multieditor/Dockerfile.ubuntu (100%) rename {images => deprecated}/multieditor/README.md (100%) rename {images => deprecated}/multieditor/deprecated.txt (100%) rename {images => deprecated}/node/Dockerfile.ubuntu (100%) rename {images => deprecated}/node/README.md (100%) rename {images => deprecated}/node/deprecated.txt (100%) rename {images => deprecated}/pycharm/Dockerfile.ubuntu (100%) rename {images => deprecated}/pycharm/README.md (100%) rename {images => deprecated}/ruby/Dockerfile.ubuntu (100%) rename {images => deprecated}/ruby/deprecated.txt (100%) rename {images => deprecated}/ruby/install-ruby.sh (100%) rename {images => deprecated}/rust/Dockerfile.ubuntu (100%) rename {images => deprecated}/rust/README.md (100%) rename {images => deprecated}/rust/deprecated.txt (100%) rename {images => deprecated}/rust/rustup.sh (100%) rename {images => deprecated}/vnc/Dockerfile.ubuntu (100%) rename {images => deprecated}/vnc/README.md (100%) rename {images => deprecated}/vnc/coder/apps/config.yaml (100%) rename {images => deprecated}/vnc/coder/apps/desktop.png (100%) rename {images => deprecated}/vnc/coder/configure (100%) rename {images => deprecated}/vnc/deprecated.txt (100%) rename {images => deprecated}/vnc/example.png (100%) rename {images => deprecated}/vnc/supervisor/conf.d/novnc.conf (100%) rename {images => deprecated}/vnc/supervisor/conf.d/vncserver.conf (100%) rename {images => deprecated}/vnc/supervisor/supervisord.conf (100%) rename {images => deprecated}/vnc/vnc/index.html (100%) rename {images => deprecated}/vnc/vnc/scripts/vncserver.sh (100%) rename {images => deprecated}/vnc/vnc/setup/no_vnc.sh (100%) rename {images => deprecated}/vnc/vnc/setup/set_user_permission.sh (100%) rename {images => deprecated}/vnc/vnc/xstartup (100%) rename {images => deprecated}/vnc/xfce4/coder-bg.jpg (100%) rename {images => deprecated}/vnc/xfce4/helpers.rc (100%) rename {images => deprecated}/vnc/xfce4/xfconf/xfce-perchannel-xml/displays.xml (100%) rename {images => deprecated}/vnc/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml (100%) rename {images => deprecated}/vnc/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml (100%) rename {images => deprecated}/vnc/xfce4/xfconf/xfce-perchannel-xml/xsettings.xml (100%) rename {images => deprecated}/webstorm/Dockerfile.ubuntu (100%) rename {images => deprecated}/webstorm/README.md (100%) diff --git a/README.md b/README.md index f14556e..45c0218 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,18 @@ # Enterprise Example Images -These docs contain examples and guides for how to setup your images to utilize -the Multi Editor Support built into Coder Enterprise. +This repository contains example images for use with [Coder](https://coder.com/docs/v2/latest). -Each directory in [`images/`](./images) contains examples for how to setup your -images with different IDEs. - -See our -[documentation at our Enterprise Hub](https://enterprise.coder.com/docs/multi-editor) -for additional information about supported editors and known issues. - -## Image Minimums - -All of the images provided in this repo include the following utilities to -ensure they work well with all of Coder Enterprise's features, and to provide a -solid out-of-the-box developer experience: - -- git -- bash -- curl & wget -- htop -- man -- vim -- sudo -- python3 & pip3 -- gcc & gcc-c++ & make - -The one exception is the `minimal` image, which contains only bash, curl, git, and -sudo. +- `enterprise-base`: Contains an example image that can be used as a base for + other images. +- `enterprise-minimal`: Contains a minimal image that contians only the required + utilities for a Coder workspace to bootstrap successfully. ## Images on Docker Hub Each of these images is also published to Docker Hub under the -`codercom/enterprise-[name]` repository. For example, `intellij` is available at -https://hub.docker.com/r/codercom/enterprise-intellij. The tag is taken from the -file extension of the Dockerfile. For example, `intellij/Dockerfile.ubuntu` is +`codercom/enterprise-[name]` repository. For example, `base` is available at +https://hub.docker.com/r/codercom/enterprise-base. The tag is taken from the +file extension of the Dockerfile. For example, `base/Dockerfile.ubuntu` is under the `ubuntu` tag. ## Contributing diff --git a/images/android/Dockerfile.ubuntu b/deprecated/android/Dockerfile.ubuntu similarity index 100% rename from images/android/Dockerfile.ubuntu rename to deprecated/android/Dockerfile.ubuntu diff --git a/images/android/README.md b/deprecated/android/README.md similarity index 100% rename from images/android/README.md rename to deprecated/android/README.md diff --git a/images/clion/Dockerfile.ubuntu b/deprecated/clion/Dockerfile.ubuntu similarity index 100% rename from images/clion/Dockerfile.ubuntu rename to deprecated/clion/Dockerfile.ubuntu diff --git a/images/clion/README.md b/deprecated/clion/README.md similarity index 100% rename from images/clion/README.md rename to deprecated/clion/README.md diff --git a/images/configure/Dockerfile.ubuntu b/deprecated/configure/Dockerfile.ubuntu similarity index 100% rename from images/configure/Dockerfile.ubuntu rename to deprecated/configure/Dockerfile.ubuntu diff --git a/images/configure/README.md b/deprecated/configure/README.md similarity index 100% rename from images/configure/README.md rename to deprecated/configure/README.md diff --git a/images/configure/configure b/deprecated/configure/configure similarity index 100% rename from images/configure/configure rename to deprecated/configure/configure diff --git a/images/configure/deprecated.txt b/deprecated/configure/deprecated.txt similarity index 100% rename from images/configure/deprecated.txt rename to deprecated/configure/deprecated.txt diff --git a/images/dataSpell/Dockerfile.ubuntu b/deprecated/dataSpell/Dockerfile.ubuntu similarity index 100% rename from images/dataSpell/Dockerfile.ubuntu rename to deprecated/dataSpell/Dockerfile.ubuntu diff --git a/images/goland/Dockerfile.ubuntu b/deprecated/goland/Dockerfile.ubuntu similarity index 100% rename from images/goland/Dockerfile.ubuntu rename to deprecated/goland/Dockerfile.ubuntu diff --git a/images/goland/README.md b/deprecated/goland/README.md similarity index 100% rename from images/goland/README.md rename to deprecated/goland/README.md diff --git a/images/golang/Dockerfile.ubuntu b/deprecated/golang/Dockerfile.ubuntu similarity index 100% rename from images/golang/Dockerfile.ubuntu rename to deprecated/golang/Dockerfile.ubuntu diff --git a/images/golang/README.md b/deprecated/golang/README.md similarity index 100% rename from images/golang/README.md rename to deprecated/golang/README.md diff --git a/images/golang/deprecated.txt b/deprecated/golang/deprecated.txt similarity index 100% rename from images/golang/deprecated.txt rename to deprecated/golang/deprecated.txt diff --git a/images/intellij/Dockerfile.ubuntu b/deprecated/intellij/Dockerfile.ubuntu similarity index 100% rename from images/intellij/Dockerfile.ubuntu rename to deprecated/intellij/Dockerfile.ubuntu diff --git a/images/intellij/README.md b/deprecated/intellij/README.md similarity index 100% rename from images/intellij/README.md rename to deprecated/intellij/README.md diff --git a/images/java/Dockerfile.ubuntu b/deprecated/java/Dockerfile.ubuntu similarity index 100% rename from images/java/Dockerfile.ubuntu rename to deprecated/java/Dockerfile.ubuntu diff --git a/images/java/README.md b/deprecated/java/README.md similarity index 100% rename from images/java/README.md rename to deprecated/java/README.md diff --git a/images/java/deprecated.txt b/deprecated/java/deprecated.txt similarity index 100% rename from images/java/deprecated.txt rename to deprecated/java/deprecated.txt diff --git a/images/jupyter/Dockerfile.ubuntu b/deprecated/jupyter/Dockerfile.ubuntu similarity index 100% rename from images/jupyter/Dockerfile.ubuntu rename to deprecated/jupyter/Dockerfile.ubuntu diff --git a/images/jupyter/README.md b/deprecated/jupyter/README.md similarity index 100% rename from images/jupyter/README.md rename to deprecated/jupyter/README.md diff --git a/images/jupyter/deprecated.txt b/deprecated/jupyter/deprecated.txt similarity index 100% rename from images/jupyter/deprecated.txt rename to deprecated/jupyter/deprecated.txt diff --git a/images/multieditor/Dockerfile.ubuntu b/deprecated/multieditor/Dockerfile.ubuntu similarity index 100% rename from images/multieditor/Dockerfile.ubuntu rename to deprecated/multieditor/Dockerfile.ubuntu diff --git a/images/multieditor/README.md b/deprecated/multieditor/README.md similarity index 100% rename from images/multieditor/README.md rename to deprecated/multieditor/README.md diff --git a/images/multieditor/deprecated.txt b/deprecated/multieditor/deprecated.txt similarity index 100% rename from images/multieditor/deprecated.txt rename to deprecated/multieditor/deprecated.txt diff --git a/images/node/Dockerfile.ubuntu b/deprecated/node/Dockerfile.ubuntu similarity index 100% rename from images/node/Dockerfile.ubuntu rename to deprecated/node/Dockerfile.ubuntu diff --git a/images/node/README.md b/deprecated/node/README.md similarity index 100% rename from images/node/README.md rename to deprecated/node/README.md diff --git a/images/node/deprecated.txt b/deprecated/node/deprecated.txt similarity index 100% rename from images/node/deprecated.txt rename to deprecated/node/deprecated.txt diff --git a/images/pycharm/Dockerfile.ubuntu b/deprecated/pycharm/Dockerfile.ubuntu similarity index 100% rename from images/pycharm/Dockerfile.ubuntu rename to deprecated/pycharm/Dockerfile.ubuntu diff --git a/images/pycharm/README.md b/deprecated/pycharm/README.md similarity index 100% rename from images/pycharm/README.md rename to deprecated/pycharm/README.md diff --git a/images/ruby/Dockerfile.ubuntu b/deprecated/ruby/Dockerfile.ubuntu similarity index 100% rename from images/ruby/Dockerfile.ubuntu rename to deprecated/ruby/Dockerfile.ubuntu diff --git a/images/ruby/deprecated.txt b/deprecated/ruby/deprecated.txt similarity index 100% rename from images/ruby/deprecated.txt rename to deprecated/ruby/deprecated.txt diff --git a/images/ruby/install-ruby.sh b/deprecated/ruby/install-ruby.sh similarity index 100% rename from images/ruby/install-ruby.sh rename to deprecated/ruby/install-ruby.sh diff --git a/images/rust/Dockerfile.ubuntu b/deprecated/rust/Dockerfile.ubuntu similarity index 100% rename from images/rust/Dockerfile.ubuntu rename to deprecated/rust/Dockerfile.ubuntu diff --git a/images/rust/README.md b/deprecated/rust/README.md similarity index 100% rename from images/rust/README.md rename to deprecated/rust/README.md diff --git a/images/rust/deprecated.txt b/deprecated/rust/deprecated.txt similarity index 100% rename from images/rust/deprecated.txt rename to deprecated/rust/deprecated.txt diff --git a/images/rust/rustup.sh b/deprecated/rust/rustup.sh similarity index 100% rename from images/rust/rustup.sh rename to deprecated/rust/rustup.sh diff --git a/images/vnc/Dockerfile.ubuntu b/deprecated/vnc/Dockerfile.ubuntu similarity index 100% rename from images/vnc/Dockerfile.ubuntu rename to deprecated/vnc/Dockerfile.ubuntu diff --git a/images/vnc/README.md b/deprecated/vnc/README.md similarity index 100% rename from images/vnc/README.md rename to deprecated/vnc/README.md diff --git a/images/vnc/coder/apps/config.yaml b/deprecated/vnc/coder/apps/config.yaml similarity index 100% rename from images/vnc/coder/apps/config.yaml rename to deprecated/vnc/coder/apps/config.yaml diff --git a/images/vnc/coder/apps/desktop.png b/deprecated/vnc/coder/apps/desktop.png similarity index 100% rename from images/vnc/coder/apps/desktop.png rename to deprecated/vnc/coder/apps/desktop.png diff --git a/images/vnc/coder/configure b/deprecated/vnc/coder/configure similarity index 100% rename from images/vnc/coder/configure rename to deprecated/vnc/coder/configure diff --git a/images/vnc/deprecated.txt b/deprecated/vnc/deprecated.txt similarity index 100% rename from images/vnc/deprecated.txt rename to deprecated/vnc/deprecated.txt diff --git a/images/vnc/example.png b/deprecated/vnc/example.png similarity index 100% rename from images/vnc/example.png rename to deprecated/vnc/example.png diff --git a/images/vnc/supervisor/conf.d/novnc.conf b/deprecated/vnc/supervisor/conf.d/novnc.conf similarity index 100% rename from images/vnc/supervisor/conf.d/novnc.conf rename to deprecated/vnc/supervisor/conf.d/novnc.conf diff --git a/images/vnc/supervisor/conf.d/vncserver.conf b/deprecated/vnc/supervisor/conf.d/vncserver.conf similarity index 100% rename from images/vnc/supervisor/conf.d/vncserver.conf rename to deprecated/vnc/supervisor/conf.d/vncserver.conf diff --git a/images/vnc/supervisor/supervisord.conf b/deprecated/vnc/supervisor/supervisord.conf similarity index 100% rename from images/vnc/supervisor/supervisord.conf rename to deprecated/vnc/supervisor/supervisord.conf diff --git a/images/vnc/vnc/index.html b/deprecated/vnc/vnc/index.html similarity index 100% rename from images/vnc/vnc/index.html rename to deprecated/vnc/vnc/index.html diff --git a/images/vnc/vnc/scripts/vncserver.sh b/deprecated/vnc/vnc/scripts/vncserver.sh similarity index 100% rename from images/vnc/vnc/scripts/vncserver.sh rename to deprecated/vnc/vnc/scripts/vncserver.sh diff --git a/images/vnc/vnc/setup/no_vnc.sh b/deprecated/vnc/vnc/setup/no_vnc.sh similarity index 100% rename from images/vnc/vnc/setup/no_vnc.sh rename to deprecated/vnc/vnc/setup/no_vnc.sh diff --git a/images/vnc/vnc/setup/set_user_permission.sh b/deprecated/vnc/vnc/setup/set_user_permission.sh similarity index 100% rename from images/vnc/vnc/setup/set_user_permission.sh rename to deprecated/vnc/vnc/setup/set_user_permission.sh diff --git a/images/vnc/vnc/xstartup b/deprecated/vnc/vnc/xstartup similarity index 100% rename from images/vnc/vnc/xstartup rename to deprecated/vnc/vnc/xstartup diff --git a/images/vnc/xfce4/coder-bg.jpg b/deprecated/vnc/xfce4/coder-bg.jpg similarity index 100% rename from images/vnc/xfce4/coder-bg.jpg rename to deprecated/vnc/xfce4/coder-bg.jpg diff --git a/images/vnc/xfce4/helpers.rc b/deprecated/vnc/xfce4/helpers.rc similarity index 100% rename from images/vnc/xfce4/helpers.rc rename to deprecated/vnc/xfce4/helpers.rc diff --git a/images/vnc/xfce4/xfconf/xfce-perchannel-xml/displays.xml b/deprecated/vnc/xfce4/xfconf/xfce-perchannel-xml/displays.xml similarity index 100% rename from images/vnc/xfce4/xfconf/xfce-perchannel-xml/displays.xml rename to deprecated/vnc/xfce4/xfconf/xfce-perchannel-xml/displays.xml diff --git a/images/vnc/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml b/deprecated/vnc/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml similarity index 100% rename from images/vnc/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml rename to deprecated/vnc/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml diff --git a/images/vnc/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml b/deprecated/vnc/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml similarity index 100% rename from images/vnc/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml rename to deprecated/vnc/xfce4/xfconf/xfce-perchannel-xml/xfwm4.xml diff --git a/images/vnc/xfce4/xfconf/xfce-perchannel-xml/xsettings.xml b/deprecated/vnc/xfce4/xfconf/xfce-perchannel-xml/xsettings.xml similarity index 100% rename from images/vnc/xfce4/xfconf/xfce-perchannel-xml/xsettings.xml rename to deprecated/vnc/xfce4/xfconf/xfce-perchannel-xml/xsettings.xml diff --git a/images/webstorm/Dockerfile.ubuntu b/deprecated/webstorm/Dockerfile.ubuntu similarity index 100% rename from images/webstorm/Dockerfile.ubuntu rename to deprecated/webstorm/Dockerfile.ubuntu diff --git a/images/webstorm/README.md b/deprecated/webstorm/README.md similarity index 100% rename from images/webstorm/README.md rename to deprecated/webstorm/README.md diff --git a/scripts/images.sh b/scripts/images.sh index cceb537..d131d6a 100644 --- a/scripts/images.sh +++ b/scripts/images.sh @@ -3,26 +3,6 @@ set -euo pipefail IMAGES=( - # This image must always be built first. "base" - - # These must be built first because others build FROM these - "configure" - "golang" - "java" - "multieditor" - "node" - "ruby" - "rust" - "vnc" - - # We can build these images in any order - "android" - "clion" - "goland" - "intellij" "minimal" - "jupyter" - "pycharm" - "webstorm" )