Merge pull request #16 from theohbrothers/feature/add-docker-variants

Feature: Add `docker` variants
theohbrothers · Dec 27, 2022 · 7acdeef · 7acdeef
2 parents c967e01 + d58c8a2
commit 7acdeef
Show file tree

Hide file tree

Showing 38 changed files with 1,948 additions and 82 deletions.
diff --git a/.github/workflows/ci-master-pr.yml b/.github/workflows/ci-master-pr.yml
diff --git a/README.md b/README.md
@@ -11,29 +11,60 @@ Dockerized [`code-server`](https://github.com/coder/code-server).
 | Tag | Dockerfile Build Context |
 |:-------:|:---------:|
 | `:v4.9.1-alpine-3.15`, `:latest` | [View](variants/v4.9.1-alpine-3.15 ) |
+| `:v4.9.1-docker-alpine-3.15` | [View](variants/v4.9.1-docker-alpine-3.15 ) |
+| `:v4.9.1-docker-rootless-alpine-3.15` | [View](variants/v4.9.1-docker-rootless-alpine-3.15 ) |
 | `:v4.8.3-alpine-3.15` | [View](variants/v4.8.3-alpine-3.15 ) |
+| `:v4.8.3-docker-alpine-3.15` | [View](variants/v4.8.3-docker-alpine-3.15 ) |
+| `:v4.8.3-docker-rootless-alpine-3.15` | [View](variants/v4.8.3-docker-rootless-alpine-3.15 ) |
 | `:v4.8.3-pwsh-7.3.1-alpine-3.15` | [View](variants/v4.8.3-pwsh-7.3.1-alpine-3.15 ) |
 | `:v4.8.3-pwsh-7.2.8-alpine-3.15` | [View](variants/v4.8.3-pwsh-7.2.8-alpine-3.15 ) |
 | `:v4.8.3-pwsh-7.1.7-alpine-3.15` | [View](variants/v4.8.3-pwsh-7.1.7-alpine-3.15 ) |
 | `:v4.8.3-pwsh-7.0.13-alpine-3.15` | [View](variants/v4.8.3-pwsh-7.0.13-alpine-3.15 ) |
 | `:v4.7.1-alpine-3.15` | [View](variants/v4.7.1-alpine-3.15 ) |
+| `:v4.7.1-docker-alpine-3.15` | [View](variants/v4.7.1-docker-alpine-3.15 ) |
+| `:v4.7.1-docker-rootless-alpine-3.15` | [View](variants/v4.7.1-docker-rootless-alpine-3.15 ) |
 | `:v4.6.1-alpine-3.15` | [View](variants/v4.6.1-alpine-3.15 ) |
+| `:v4.6.1-docker-alpine-3.15` | [View](variants/v4.6.1-docker-alpine-3.15 ) |
+| `:v4.6.1-docker-rootless-alpine-3.15` | [View](variants/v4.6.1-docker-rootless-alpine-3.15 ) |
 
 Base variants do not contain additional tools. E.g. `v4.9.1-alpine-3.15`.
 
-Incremental variants contain additional tools. E.g. `v4.8.3-pwsh-7.3.1-alpine-3.15`:
+Incremental variants contain additional tools. E.g. `v4.9.1-docker-alpine-3.15`:
 
-- `pwsh`: Powershell
+- `docker`: [docker](https://docs.docker.com/engine/)
+- `docker-rootless`: [Rootless docker](https://docs.docker.com/engine/security/rootless/)
+- `pwsh`: [Powershell](https://github.com/PowerShell/PowerShell)
 
 ## Usage
 
+To run a base variant:
+
+```sh
+docker run --name code-server --rm -it -p 127.0.0.1:8080:8080 theohbrothers/docker-code-server:latest
+```
+
+To run an incremental variant:
+
+```sh
+# docker or docker-rootless
+docker run --name code-server --rm -it --privileged -p 127.0.0.1:8080:8080 theohbrothers/docker-code-server:v4.9.1-docker-alpine-3.15
+
+# pwsh
+docker run --name code-server --rm -it --privileged -p 127.0.0.1:8080:8080 theohbrothers/docker-code-server:
+```
+
+`code-server` is now available at http://127.0.0.1:8080. To login, use the password in the config file:
+
 ```sh
-# code-server available at http://127.0.0.1:8080
-docker run --name code-server -it -p 127.0.0.1:8080:8080 theohbrothers/docker-code-server:latest
-# Login using the password in the config file
 docker exec code-server sh -c 'cat ~/.config/code-server/config.yaml'
 ```
 
+## Notes
+
+- The default user is named `user` with UID `1000`. To escalate as `root`, use `sudo`.
+- Users should provision their own configuration files at entrypoint. Examples include dot files such as `~/.bash_aliases`, `~/.gitconfig`, and `code` configs such as `~/.local/share/code-server/User/keybindings.json` and `~/.local/share/code-server/User/settings.json`.
+- To ensure `bash-completion` works, ensure `/etc/profile.d/bash_completion.sh` is sourced by `~/.bashrc`. When `exec`ing into the container, use a login shell (E.g. `docker exec -it <container> bash -l`).
+
 ## Development
 
 Requires Windows `powershell` or [`pwsh`](https://github.com/PowerShell/PowerShell).

diff --git a/generate/definitions/VARIANTS.ps1 b/generate/definitions/VARIANTS.ps1
@@ -7,6 +7,8 @@ $local:VARIANTS_MATRIX = @(
         distro_version = '3.15'
         subvariants = @(
             @{ components = @(); tag_as_latest = $true } # Base
+            @{ components = @( 'docker' ) } # Incremental
+            @{ components = @( 'docker-rootless' ) } # Incremental
         )
     }
     @{
@@ -16,6 +18,8 @@ $local:VARIANTS_MATRIX = @(
         distro_version = '3.15'
         subvariants = @(
             @{ components = @() } # Base
+            @{ components = @( 'docker' ) } # Incremental
+            @{ components = @( 'docker-rootless' ) } # Incremental
             @{ components = @( 'pwsh-7.3.1' ) } # Incremental
             @{ components = @( 'pwsh-7.2.8' ) } # Incremental
             @{ components = @( 'pwsh-7.1.7' ) } # Incremental
@@ -29,6 +33,8 @@ $local:VARIANTS_MATRIX = @(
         distro_version = '3.15'
         subvariants = @(
             @{ components = @() } # Base
+            @{ components = @( 'docker' ) } # Incremental
+            @{ components = @( 'docker-rootless' ) } # Incremental
         )
     }
     @{
@@ -38,6 +44,8 @@ $local:VARIANTS_MATRIX = @(
         distro_version = '3.15'
         subvariants = @(
             @{ components = @() } # Base
+            @{ components = @( 'docker' ) } # Incremental
+            @{ components = @( 'docker-rootless' ) } # Incremental
         )
     }
     # @{
@@ -99,8 +107,14 @@ $VARIANTS_SHARED = @{
         templates = @{
             'Dockerfile' = @{
                 common = $true
-                includeHeader = $false
-                includeFooter = $false
+                passes = @(
+                    @{
+                        variables = @{}
+                    }
+                )
+            }
+            'docker-entrypoint.sh' = @{
+                common = $true
                 passes = @(
                     @{
                         variables = @{}

diff --git a/generate/templates/Dockerfile.ps1 b/generate/templates/Dockerfile.ps1
@@ -61,28 +61,64 @@ RUN code-server --install-extension vscode-icons-team.vscode-icons@11.13.0
 RUN code-server --install-extension redhat.vscode-xml@0.18.0
 # yaml
 RUN code-server --install-extension redhat.vscode-yaml@1.9.1
-# Remove the default config file created when extensions are installed
-RUN rm -v ~/.config/code-server/config.yaml
-
-ENV LANG=en_US.UTF-8
-USER user
-WORKDIR /home/user
-CMD [ "code-server", "--bind-addr", "0.0.0.0:8080", "--disable-telemetry", "--disable-update-check" ]
 "@
 }else {
     # Incremental build
     @'
 ARG BASE_IMAGE
 FROM $BASE_IMAGE
 
+
+'@
+    foreach ($c in $VARIANT['_metadata']['components']) {
+        if ($c -eq 'docker') {
+@'
 USER root
 
+# Install docker
+RUN apk add --no-cache shadow-uidmap fuse-overlayfs iproute2 iptables ip6tables
+RUN apk add --no-cache docker
+RUN adduser user docker
+
+# Install docker compose v2
+RUN apk add --no-cache docker-cli-compose
+
+# Install docker-compose v1 (deprecated, but for backward compatibility)
+RUN apk add --no-cache docker-compose
 
 '@
-    foreach ($c in $VARIANT['_metadata']['components']) {
+
+        }
+        if ($c -eq 'docker-rootless') {
+@'
+USER root
+
+# Install rootless docker
+# See: https://docs.docker.com/engine/security/rootless/
+RUN apk add --no-cache shadow-uidmap fuse-overlayfs iproute2 iptables ip6tables
+RUN apk add --no-cache bash-completion
+RUN echo user:100000:65536 >/etc/subuid
+RUN echo user:100000:65536 >/etc/subgid
+USER user
+RUN wget -qO- https://get.docker.com/rootless | sh
+ENV XDG_RUNTIME_DIR=/home/user/.docker/run
+ENV PATH=/home/user/bin:$PATH
+ENV DOCKER_HOST=unix:///home/user/.docker/run/docker.sock
+
+USER root
+
+# Install docker compose v2
+RUN apk add --no-cache docker-cli-compose
+
+# Install docker-compose v1 (deprecated, but for backward compatibility)
+RUN apk add --no-cache docker-compose
+'@
+        }
         if ($c -match 'pwsh-([^-]+)') {
             $v = $matches[1]
             @"
+USER root
+
 # Install pwsh
 # See: https://learn.microsoft.com/en-us/powershell/scripting/install/install-alpine?view=powershell-7.3
 RUN apk add --no-cache \
@@ -120,16 +156,24 @@ RUN pwsh -c 'Install-Module Pester -Force -Scope AllUsers -MinimumVersion 4.0.0
 # Install extensions
 USER user
 RUN code-server --install-extension ms-vscode.powershell@2021.12.0
-
 "@
         }
     }
+}
+
 @"
-# Remove the default config file created when extensions are installed
-RUN rm -v ~/.config/code-server/config.yaml
 
-# Restore user
+
+# Remove the default code-server config file created when extensions are installed
 USER user
+RUN rm -fv ~/.config/code-server/config.yaml
+
+USER root
+COPY docker-entrypoint.sh /docker-entrypoint.sh
+RUN chmod +x /docker-entrypoint.sh
 
+ENV LANG=en_US.UTF-8
+USER user
+WORKDIR /home/user
+CMD [ "/docker-entrypoint.sh" ]
 "@
-}
diff --git a/generate/templates/README.md.ps1 b/generate/templates/README.md.ps1
@@ -30,19 +30,46 @@ Base variants do not contain additional tools. E.g. ``$( $VARIANTS | ? { $_['tag
 
 Incremental variants contain additional tools. E.g. ``$( $VARIANTS | ? { $_['_metadata']['base_tag'] } | Select-Object -First 1 | Select-Object -ExpandProperty tag )``:
 
-- ``pwsh``: Powershell
+- ``docker``: [docker](https://docs.docker.com/engine/)
+- ``docker-rootless``: [Rootless docker](https://docs.docker.com/engine/security/rootless/)
+- ``pwsh``: [Powershell](https://github.com/PowerShell/PowerShell)
 
 
 "@
-@'
+@"
 ## Usage
 
-```sh
-# code-server available at http://127.0.0.1:8080
-docker run --name code-server -it -p 127.0.0.1:8080:8080 theohbrothers/docker-code-server:latest
-# Login using the password in the config file
+To run a base variant:
+
+``````sh
+docker run --name code-server --rm -it -p 127.0.0.1:8080:8080 theohbrothers/docker-code-server:latest
+``````
+
+To run an incremental variant:
+
+``````sh
+# docker or docker-rootless
+docker run --name code-server --rm -it --privileged -p 127.0.0.1:8080:8080 theohbrothers/docker-code-server:$( $VARIANTS | ? { $_['_metadata']['components'] -contains 'docker' } | Select-Object -First 1 | Select-Object -ExpandProperty tag )
+
+# pwsh
+docker run --name code-server --rm -it --privileged -p 127.0.0.1:8080:8080 theohbrothers/docker-code-server:$( $VARIANTS | ? { $_['_metadata']['components'] -contains 'pwsh' } | Select-Object -First 1 | Select-Object -ExpandProperty tag )
+``````
+
+``code-server`` is now available at http://127.0.0.1:8080. To login, use the password in the config file:
+
+``````sh
 docker exec code-server sh -c 'cat ~/.config/code-server/config.yaml'
-```
+``````
+
+
+"@
+
+@'
+## Notes
+
+- The default user is named `user` with UID `1000`. To escalate as `root`, use `sudo`.
+- Users should provision their own configuration files at entrypoint. Examples include dot files such as `~/.bash_aliases`, `~/.gitconfig`, and `code` configs such as `~/.local/share/code-server/User/keybindings.json` and `~/.local/share/code-server/User/settings.json`.
+- To ensure `bash-completion` works, ensure `/etc/profile.d/bash_completion.sh` is sourced by `~/.bashrc`. When `exec`ing into the container, use a login shell (E.g. `docker exec -it <container> bash -l`).
 
 ## Development
 

diff --git a/generate/templates/docker-entrypoint.sh.ps1 b/generate/templates/docker-entrypoint.sh.ps1
@@ -0,0 +1,30 @@
+@'
+#!/bin/sh
+set -eu
+
+'@
+
+if ($VARIANT['_metadata']['base_tag']) {
+    # Incremental build
+    foreach ($c in $VARIANT['_metadata']['components']) {
+        if ($c -eq 'docker') {
+@'
+echo "Starting dockerd"
+sudo dockerd &
+
+'@
+        }
+        if ($c -eq 'docker-rootless') {
+@'
+echo "Starting rootless dockerd"
+PATH=/home/user/bin:/sbin:/usr/sbin:$PATH dockerd-rootless.sh &
+
+'@
+        }
+    }
+}
+
+@'
+echo "Starting code-server"
+exec code-server --bind-addr 0.0.0.0:8080 --disable-telemetry --disable-update-check
+'@
diff --git a/variants/v4.6.1-alpine-3.15/Dockerfile b/variants/v4.6.1-alpine-3.15/Dockerfile
@@ -58,10 +58,16 @@ RUN code-server --install-extension vscode-icons-team.vscode-icons@11.13.0
 RUN code-server --install-extension redhat.vscode-xml@0.18.0
 # yaml
 RUN code-server --install-extension redhat.vscode-yaml@1.9.1
-# Remove the default config file created when extensions are installed
-RUN rm -v ~/.config/code-server/config.yaml
+
+# Remove the default code-server config file created when extensions are installed
+USER user
+RUN rm -fv ~/.config/code-server/config.yaml
+
+USER root
+COPY docker-entrypoint.sh /docker-entrypoint.sh
+RUN chmod +x /docker-entrypoint.sh
 
 ENV LANG=en_US.UTF-8
 USER user
 WORKDIR /home/user
-CMD [ "code-server", "--bind-addr", "0.0.0.0:8080", "--disable-telemetry", "--disable-update-check" ]
+CMD [ "/docker-entrypoint.sh" ]
diff --git a/variants/v4.6.1-alpine-3.15/docker-entrypoint.sh b/variants/v4.6.1-alpine-3.15/docker-entrypoint.sh
@@ -0,0 +1,4 @@
+#!/bin/sh
+set -eu
+echo "Starting code-server"
+exec code-server --bind-addr 0.0.0.0:8080 --disable-telemetry --disable-update-check
diff --git a/variants/v4.6.1-docker-alpine-3.15/Dockerfile b/variants/v4.6.1-docker-alpine-3.15/Dockerfile
@@ -0,0 +1,29 @@
+ARG BASE_IMAGE
+FROM $BASE_IMAGE
+
+USER root
+
+# Install docker
+RUN apk add --no-cache shadow-uidmap fuse-overlayfs iproute2 iptables ip6tables
+RUN apk add --no-cache docker
+RUN adduser user docker
+
+# Install docker compose v2
+RUN apk add --no-cache docker-cli-compose
+
+# Install docker-compose v1 (deprecated, but for backward compatibility)
+RUN apk add --no-cache docker-compose
+
+
+# Remove the default code-server config file created when extensions are installed
+USER user
+RUN rm -fv ~/.config/code-server/config.yaml
+
+USER root
+COPY docker-entrypoint.sh /docker-entrypoint.sh
+RUN chmod +x /docker-entrypoint.sh
+
+ENV LANG=en_US.UTF-8
+USER user
+WORKDIR /home/user
+CMD [ "/docker-entrypoint.sh" ]
diff --git a/variants/v4.6.1-docker-alpine-3.15/docker-entrypoint.sh b/variants/v4.6.1-docker-alpine-3.15/docker-entrypoint.sh
@@ -0,0 +1,6 @@
+#!/bin/sh
+set -eu
+echo "Starting dockerd"
+sudo dockerd &
+echo "Starting code-server"
+exec code-server --bind-addr 0.0.0.0:8080 --disable-telemetry --disable-update-check