Merge pull request #124 from vvoland/rootless

Add rootless support
docker · Nov 14, 2024 · 332d315 · 332d315
2 parents e02739b + 343f867
commit 332d315
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 34 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -55,10 +55,6 @@ jobs:
         uses: ./
         with:
           version: ${{ env.DOCKER_VERSION }}
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   channel:
     runs-on: ${{ matrix.os }}
@@ -85,10 +81,6 @@ jobs:
         with:
           version: v24.0.0-rc.4
           channel: test
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   daemon-config:
     runs-on: ${{ matrix.os }}
@@ -120,10 +112,6 @@ jobs:
                 "containerd-snapshotter": true
               }
             }
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   context:
     runs-on: ${{ matrix.os }}
@@ -154,10 +142,6 @@ jobs:
         name: Check context
         run: |
           docker context inspect foo
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   lima-start-args:
     #runs-on: macos-14  # no virt: https://github.com/docker/actions-toolkit/issues/317
@@ -220,10 +204,6 @@ jobs:
         name: Inspect
         run: |
           docker buildx imagetools inspect localhost:5000/name/app:latest --format '{{json .}}'
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   build-macos:
     runs-on: ${{ matrix.os }}
@@ -270,10 +250,6 @@ jobs:
         name: Inspect
         run: |
           docker buildx imagetools inspect localhost:5000/name/app:latest --format '{{json .}}'
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   build-windows:
     runs-on: windows-latest
@@ -295,10 +271,6 @@ jobs:
         name: Inspect
         run: |
           docker image inspect test
-      -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
 
   set-host:
     runs-on: ubuntu-latest
@@ -315,7 +287,19 @@ jobs:
         name: List contexts
         run: |
           docker context ls
+
+  rootless:
+    runs-on: ubuntu-latest
+    steps:
       -
-        name: Dump context
-        if: always()
-        uses: crazy-max/ghaction-dump-context@v2
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Set up Docker
+        uses: ./
+        with:
+          rootless: true
+      -
+        name: List contexts
+        run: |
+          docker context ls
diff --git a/README.md b/README.md
@@ -135,6 +135,7 @@ The following inputs can be used as `step.with` keys
 | `daemon-config` | String |                       | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |
 | `context`       | String | `setup-docker-action` | Docker context name.                                                                                                        |
 | `set-host`      | Bool   | `false`               | Set `DOCKER_HOST` environment variable to docker socket path.                                                               |
+| `rootless`      | Bool   | `false`               | Start daemon in rootless mode                                                                                               |
 
 ### outputs
 

diff --git a/__tests__/context.test.ts b/__tests__/context.test.ts
@@ -19,6 +19,7 @@ describe('getInputs', () => {
       new Map<string, string>([
         ['version', 'v24.0.8'],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
         source: {
@@ -28,6 +29,7 @@ describe('getInputs', () => {
         },
         context: '',
         daemonConfig: '',
+        rootless: false,
         setHost: false
       } as context.Inputs
     ],
@@ -39,6 +41,7 @@ describe('getInputs', () => {
         ['context', 'foo'],
         ['daemon-config', `{"debug":true,"features":{"containerd-snapshotter":true}}`],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
         source: {
@@ -48,13 +51,15 @@ describe('getInputs', () => {
         },
         context: 'foo',
         daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
+        rootless: false,
         setHost: false
       } as context.Inputs
     ],
     [
       2,
       new Map<string, string>([
         ['set-host', 'true'],
+        ['rootless', 'false'],
       ]),
       {
         source: {
@@ -64,6 +69,7 @@ describe('getInputs', () => {
         },
         context: '',
         daemonConfig: '',
+        rootless: false,
         setHost: true
       } as context.Inputs
     ],
@@ -74,6 +80,7 @@ describe('getInputs', () => {
         ['context', 'foo'],
         ['daemon-config', `{"debug":true,"features":{"containerd-snapshotter":true}}`],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
         source: {
@@ -82,6 +89,7 @@ describe('getInputs', () => {
         },
         context: 'foo',
         daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
+        rootless: false,
         setHost: false
       } as context.Inputs
     ],
@@ -90,6 +98,7 @@ describe('getInputs', () => {
       new Map<string, string>([
         ['version', 'type=image'],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
         source: {
@@ -98,6 +107,7 @@ describe('getInputs', () => {
         },
         context: '',
         daemonConfig: '',
+        rootless: false,
         setHost: false
       } as context.Inputs
     ],
@@ -106,6 +116,7 @@ describe('getInputs', () => {
       new Map<string, string>([
         ['version', 'type=archive'],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
         source: {
@@ -116,13 +127,15 @@ describe('getInputs', () => {
         setHost: false,
         context: '',
         daemonConfig: '',
+        rootless: false,
       } as context.Inputs
     ],
     [
       6,
       new Map<string, string>([
         ['version', 'version=v27.2.0,channel=test'],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
         source: {
@@ -133,13 +146,15 @@ describe('getInputs', () => {
         setHost: false,
         context: '',
         daemonConfig: '',
+        rootless: false,
       } as context.Inputs
     ],
     [
       7,
       new Map<string, string>([
         ['version', 'type=image,tag=27.2.1'],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
         source: {
@@ -149,6 +164,25 @@ describe('getInputs', () => {
         setHost: false,
         context: '',
         daemonConfig: '',
+        rootless: false,
+      } as context.Inputs
+    ],
+    [
+      8,
+      new Map<string, string>([
+        ['version', 'type=image,tag=27.2.1'],
+        ['set-host', 'false'],
+        ['rootless', 'true']
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: '27.2.1',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: true,
       } as context.Inputs
     ],
   ])(

diff --git a/action.yml b/action.yml
@@ -24,6 +24,10 @@ inputs:
     description: 'Set DOCKER_HOST environment variable to docker socket path'
     default: 'false'
     required: false
+  rootless:
+    description: 'Enable Docker rootless mode'
+    default: 'false'
+    required: false
 
 outputs:
   sock:

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/context.ts b/src/context.ts
@@ -7,6 +7,7 @@ export interface Inputs {
   daemonConfig?: string;
   context: string;
   setHost: boolean;
+  rootless: boolean;
 }
 
 export function getInputs(): Inputs {
@@ -21,7 +22,8 @@ export function getInputs(): Inputs {
     source: source,
     daemonConfig: core.getInput('daemon-config'),
     context: core.getInput('context'),
-    setHost: core.getBooleanInput('set-host')
+    setHost: core.getBooleanInput('set-host'),
+    rootless: core.getBooleanInput('rootless')
   };
 }
 

diff --git a/src/main.ts b/src/main.ts
@@ -22,6 +22,7 @@ actionsToolkit.run(
     const install = new Install({
       runDir: runDir,
       source: input.source,
+      rootless: input.rootless,
       contextName: input.context || 'setup-docker-action',
       daemonConfig: input.daemonConfig
     });