Skip to content

Modern Docker Management, Designed for Everyone

fix: allow setting the data directroy for non docker installs (#2931)

Kyle Mendelle0debfde3c5e
diff --git a/backend/pkg/libarcane/startup/runtime_identity.go b/backend/pkg/libarcane/startup/runtime_identity.go
index c518a0bd3..f8aa8d69b 100644
--- a/backend/pkg/libarcane/startup/runtime_identity.go
+++ b/backend/pkg/libarcane/startup/runtime_identity.go
@@ -56,20 +56,24 @@ func ApplyRequestedRuntimeIdentity(ctx context.Context, cfg *RuntimeIdentityConf
projectsDir = filepath.Clean(strings.TrimSpace(cfg.ProjectsDirectory))
}
- req, warning, err := loadRuntimeIdentityRequestInternal(cfg)
+ inContainer := runningInContainerInternal(os.Getenv, os.Stat)
+ req, warning, err := loadRuntimeIdentityRequestInternal(cfg, inContainer)
if warning != "" {
fmt.Fprintf(os.Stderr, "Runtime identity warning: %s\n", warning)
}
- if err != nil || !req.Enabled {
+ if err != nil {
return err
}
+ if !req.Enabled {
+ return ensureSQLiteFilesExistInternal(cfg.DatabaseURL)
+ }
runtimeUID := req.UID
runtimeGID := req.GID
// Avoid re-execing forever when the requested runtime identity is already active.
if os.Geteuid() == runtimeUID && os.Getegid() == runtimeGID {
- if err := ensureRuntimeDockerConfigInternal(cfg, os.Setenv, runtimeUID, runtimeGID); err != nil {
+ if err := ensureRuntimeDockerConfigInternal(cfg, os.Setenv, runtimeUID, runtimeGID, inContainer); err != nil {
return err
}
return ensureSQLiteFilesExistInternal(cfg.DatabaseURL)
@@ -78,29 +82,31 @@ func ApplyRequestedRuntimeIdentity(ctx context.Context, cfg *RuntimeIdentityConf
if os.Geteuid() != 0 {
fmt.Fprintf(os.Stderr, "Runtime identity warning: process is not root (euid=%d), cannot switch to PUID=%d PGID=%d; continuing as current user\n",
os.Geteuid(), runtimeUID, runtimeGID)
- if err := ensureRuntimeDockerConfigInternal(cfg, os.Setenv, runtimeUID, runtimeGID); err != nil {
+ if err := ensureRuntimeDockerConfigInternal(cfg, os.Setenv, runtimeUID, runtimeGID, inContainer); err != nil {
return err
}
return ensureSQLiteFilesExistInternal(cfg.DatabaseURL)
}
- mountpoints, err := loadMountpointsInternal(mountInfoPath)
- if err != nil {
- return fmt.Errorf("load mountpoints: %w", err)
- }
-
- if err := ensureRuntimeDockerConfigInternal(cfg, os.Setenv, runtimeUID, runtimeGID); err != nil {
+ if err := ensureRuntimeDockerConfigInternal(cfg, os.Setenv, runtimeUID, runtimeGID, inContainer); err != nil {
return err
}
- if err := prepareWritablePathsInternal(runtimeUID, runtimeGID, mountpoints, projectsDir); err != nil {
- return err
+ if inContainer {
+ mountpoints, err := loadMountpointsInternal(mountInfoPath)
+ if err != nil {
+ return fmt.Errorf("load mountpoints: %w", err)
+ }
+
+ if err := prepareWritablePathsInternal(runtimeUID, runtimeGID, mountpoints, projectsDir); err != nil {
+ return err
+ }
}
return reexecWithRuntimeIdentityInternal(ctx, req)
}
-func loadRuntimeIdentityRequestInternal(cfg *RuntimeIdentityConfig) (runtimeIdentityRequest, string, error) {
+func loadRuntimeIdentityRequestInternal(cfg *RuntimeIdentityConfig, inContainer bool) (runtimeIdentityRequest, string, error) {
if cfg == nil {
cfg = &RuntimeIdentityConfig{}
}
@@ -109,11 +115,15 @@ func loadRuntimeIdentityRequestInternal(cfg *RuntimeIdentityConfig) (runtimeIden
pgid := strings.TrimSpace(cfg.PGID)
if puid == "" && pgid == "" {
- return defaultRuntimeIdentityRequestInternal(cfg.DockerHost), "", nil
+ return defaultRuntimeIdentityRequestInternal(cfg.DockerHost, inContainer), "", nil
}
if puid == "" || pgid == "" {
- return defaultRuntimeIdentityRequestInternal(cfg.DockerHost), "PUID and PGID must both be set to override the default non-root runtime user; continuing with the default non-root runtime user", nil
+ req := defaultRuntimeIdentityRequestInternal(cfg.DockerHost, inContainer)
+ if inContainer {
+ return req, "PUID and PGID must both be set to override the default non-root runtime user; continuing with the default non-root runtime user", nil
+ }
+ return req, "PUID and PGID must both be set to enable runtime identity outside containers; continuing without runtime identity", nil
}
uid, credentialUID, err := parseRuntimeIdentityValueInternal(puid, "PUID")
@@ -136,7 +146,14 @@ func loadRuntimeIdentityRequestInternal(cfg *RuntimeIdentityConfig) (runtimeIden
}, "", nil
}
-func defaultRuntimeIdentityRequestInternal(dockerHost string) runtimeIdentityRequest {
+func defaultRuntimeIdentityRequestInternal(dockerHost string, inContainer bool) runtimeIdentityRequest {
+ if !inContainer {
+ return runtimeIdentityRequest{
+ Enabled: false,
+ DockerHost: dockerHost,
+ }
+ }
+
return runtimeIdentityRequest{
Enabled: true,
UID: defaultRuntimeUID,
@@ -147,21 +164,26 @@ func defaultRuntimeIdentityRequestInternal(dockerHost string) runtimeIdentityReq
}
}
-func runtimeDockerConfigDirInternal(cfg *RuntimeIdentityConfig) string {
- if cfg == nil {
- cfg = &RuntimeIdentityConfig{}
+func runningInContainerInternal(getenv func(string) string, stat func(string) (os.FileInfo, error)) bool {
+ if pkgutils.BoolOrDefault(strings.TrimSpace(getenv("ARCANE_IN_CONTAINER")), false) {
+ return true
}
- configDir := strings.TrimSpace(cfg.DockerConfig)
- if configDir != "" {
- return configDir
+ if strings.TrimSpace(getenv("container")) != "" {
+ return true
}
- return defaultDockerConfigDir
+ for _, markerPath := range []string{"/.dockerenv", "/run/.containerenv"} {
+ if _, err := stat(markerPath); err == nil {
+ return true
+ }
+ }
+
+ return false
}
-func ensureRuntimeDockerConfigInternal(cfg *RuntimeIdentityConfig, setenv func(string, string) error, uid int, gid int) error {
- configDir, err := configureRuntimeDockerConfigEnvInternal(cfg, setenv, uid, gid)
+func ensureRuntimeDockerConfigInternal(cfg *RuntimeIdentityConfig, setenv func(string, string) error, uid int, gid int, inContainer bool) error {
+ configDir, err := configureRuntimeDockerConfigEnvInternal(cfg, setenv, uid, gid, inContainer)
if err != nil {
return err
}
@@ -182,7 +204,7 @@ func ensureRuntimeDockerConfigInternal(cfg *RuntimeIdentityConfig, setenv func(s
return nil
}
-func configureRuntimeDockerConfigEnvInternal(cfg *RuntimeIdentityConfig, setenv func(string, string) error, uid int, gid int) (string, error) {
+func configureRuntimeDockerConfigEnvInternal(cfg *RuntimeIdentityConfig, setenv func(string, string) error, uid int, gid int, inContainer bool) (string, error) {
if cfg == nil {
cfg = &RuntimeIdentityConfig{}
}
@@ -192,12 +214,19 @@ func configureRuntimeDockerConfigEnvInternal(cfg *RuntimeIdentityConfig, setenv
return "", nil
}
- configDir := runtimeDockerConfigDirInternal(cfg)
- if strings.TrimSpace(cfg.DockerConfig) == "" {
- cfg.DockerConfig = configDir
- if err := setenv("DOCKER_CONFIG", configDir); err != nil {
- return "", fmt.Errorf("set DOCKER_CONFIG: %w", err)
- }
+ configDir := strings.TrimSpace(cfg.DockerConfig)
+ if configDir != "" {
+ return configDir, nil
+ }
+
+ if !inContainer {
+ return "", nil
+ }
+
+ configDir = defaultDockerConfigDir
+ cfg.DockerConfig = configDir
+ if err := setenv("DOCKER_CONFIG", configDir); err != nil {
+ return "", fmt.Errorf("set DOCKER_CONFIG: %w", err)
}
return configDir, nil
diff --git a/backend/pkg/libarcane/startup/runtime_identity_test.go b/backend/pkg/libarcane/startup/runtime_identity_test.go
index cf64b7e24..c5aecc635 100644
--- a/backend/pkg/libarcane/startup/runtime_identity_test.go
+++ b/backend/pkg/libarcane/startup/runtime_identity_test.go
@@ -11,10 +11,20 @@ import (
)
func TestLoadRuntimeIdentityRequest(t *testing.T) {
- t.Run("enabled with default non-root runtime when unset", func(t *testing.T) {
+ t.Run("disabled when unset outside a container", func(t *testing.T) {
req, warning, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{
DockerHost: "unix:///tmp/docker.sock",
- })
+ }, false)
+ require.NoError(t, err)
+ require.Empty(t, warning)
+ require.False(t, req.Enabled)
+ require.Equal(t, "unix:///tmp/docker.sock", req.DockerHost)
+ })
+
+ t.Run("enabled with default non-root runtime when unset in container", func(t *testing.T) {
+ req, warning, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{
+ DockerHost: "unix:///tmp/docker.sock",
+ }, true)
require.NoError(t, err)
require.Empty(t, warning)
require.True(t, req.Enabled)
@@ -26,7 +36,7 @@ func TestLoadRuntimeIdentityRequest(t *testing.T) {
})
t.Run("warning when partial config", func(t *testing.T) {
- req, warning, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: "1001"})
+ req, warning, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: "1001"}, true)
require.NoError(t, err)
require.Contains(t, warning, "PUID and PGID must both be set")
require.True(t, req.Enabled)
@@ -36,8 +46,19 @@ func TestLoadRuntimeIdentityRequest(t *testing.T) {
require.Equal(t, uint32(defaultRuntimeGID), req.CredentialGID)
})
+ t.Run("warning when partial config outside container", func(t *testing.T) {
+ req, warning, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: "1001"}, false)
+ require.NoError(t, err)
+ require.Contains(t, warning, "PUID and PGID must both be set to enable runtime identity outside containers")
+ require.False(t, req.Enabled)
+ require.Zero(t, req.UID)
+ require.Zero(t, req.GID)
+ require.Equal(t, uint32(0), req.CredentialUID)
+ require.Equal(t, uint32(0), req.CredentialGID)
+ })
+
t.Run("error when invalid numeric value", func(t *testing.T) {
- _, _, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: "abc", PGID: "1001"})
+ _, _, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: "abc", PGID: "1001"}, false)
require.Error(t, err)
require.Contains(t, err.Error(), "invalid PUID")
})
@@ -45,7 +66,7 @@ func TestLoadRuntimeIdentityRequest(t *testing.T) {
t.Run("error when value exceeds uint32", func(t *testing.T) {
tooLarge := strconv.FormatUint(uint64(math.MaxUint32)+1, 10)
- _, _, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: tooLarge, PGID: "1001"})
+ _, _, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: tooLarge, PGID: "1001"}, false)
require.Error(t, err)
require.Contains(t, err.Error(), "invalid PUID")
})
@@ -55,7 +76,7 @@ func TestLoadRuntimeIdentityRequest(t *testing.T) {
PUID: "1001",
PGID: "2001",
DockerHost: "unix:///tmp/docker.sock",
- })
+ }, false)
require.NoError(t, err)
require.Empty(t, warning)
require.True(t, req.Enabled)
@@ -67,38 +88,73 @@ func TestLoadRuntimeIdentityRequest(t *testing.T) {
})
t.Run("error when value is negative", func(t *testing.T) {
- _, _, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: "-1", PGID: "1001"})
+ _, _, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{PUID: "-1", PGID: "1001"}, false)
require.Error(t, err)
require.Contains(t, err.Error(), "invalid PUID")
})
}
-func TestRuntimeDockerConfigDir(t *testing.T) {
- t.Run("defaults to app data docker config when unset", func(t *testing.T) {
- dir := runtimeDockerConfigDirInternal(&RuntimeIdentityConfig{})
+func TestRunningInContainerInternal(t *testing.T) {
+ t.Run("explicit arcane env enables container mode", func(t *testing.T) {
+ inContainer := runningInContainerInternal(
+ func(key string) string {
+ if key == "ARCANE_IN_CONTAINER" {
+ return "true"
+ }
+ return ""
+ },
+ func(string) (os.FileInfo, error) {
+ return nil, os.ErrNotExist
+ },
+ )
- require.Equal(t, defaultDockerConfigDir, dir)
+ require.True(t, inContainer)
})
- t.Run("preserves explicit docker config", func(t *testing.T) {
- dir := runtimeDockerConfigDirInternal(&RuntimeIdentityConfig{DockerConfig: "/custom/docker-config"})
+ t.Run("container env enables container mode", func(t *testing.T) {
+ inContainer := runningInContainerInternal(
+ func(key string) string {
+ if key == "container" {
+ return "podman"
+ }
+ return ""
+ },
+ func(string) (os.FileInfo, error) {
+ return nil, os.ErrNotExist
+ },
+ )
- require.Equal(t, "/custom/docker-config", dir)
+ require.True(t, inContainer)
})
- t.Run("default runtime uses non-root identity", func(t *testing.T) {
- req, warning, err := loadRuntimeIdentityRequestInternal(&RuntimeIdentityConfig{})
+ t.Run("container marker file enables container mode", func(t *testing.T) {
+ inContainer := runningInContainerInternal(
+ func(string) string { return "" },
+ func(path string) (os.FileInfo, error) {
+ if path == "/run/.containerenv" {
+ return nil, nil
+ }
+ return nil, os.ErrNotExist
+ },
+ )
- require.NoError(t, err)
- require.Empty(t, warning)
- require.True(t, req.Enabled)
- require.Equal(t, defaultRuntimeUID, req.UID)
- require.Equal(t, defaultRuntimeGID, req.GID)
+ require.True(t, inContainer)
+ })
+
+ t.Run("no signal disables container mode", func(t *testing.T) {
+ inContainer := runningInContainerInternal(
+ func(string) string { return "" },
+ func(string) (os.FileInfo, error) {
+ return nil, os.ErrNotExist
+ },
+ )
+
+ require.False(t, inContainer)
})
}
func TestConfigureRuntimeDockerConfigEnv(t *testing.T) {
- t.Run("sets default for non root runtime when unset", func(t *testing.T) {
+ t.Run("sets default for non root runtime when unset in container", func(t *testing.T) {
cfg := &RuntimeIdentityConfig{}
env := map[string]string{}
@@ -110,6 +166,7 @@ func TestConfigureRuntimeDockerConfigEnv(t *testing.T) {
},
1001,
1001,
+ true,
)
require.NoError(t, err)
@@ -118,6 +175,30 @@ func TestConfigureRuntimeDockerConfigEnv(t *testing.T) {
require.Equal(t, defaultDockerConfigDir, cfg.DockerConfig)
})
+ t.Run("skips default for non root runtime when unset outside container", func(t *testing.T) {
+ cfg := &RuntimeIdentityConfig{}
+ env := map[string]string{}
+ setCalled := false
+
+ configDir, err := configureRuntimeDockerConfigEnvInternal(
+ cfg,
+ func(key string, value string) error {
+ setCalled = true
+ env[key] = value
+ return nil
+ },
+ 1001,
+ 1001,
+ false,
+ )
+
+ require.NoError(t, err)
+ require.Empty(t, configDir)
+ require.Empty(t, env["DOCKER_CONFIG"])
+ require.Empty(t, cfg.DockerConfig)
+ require.False(t, setCalled)
+ })
+
t.Run("preserves explicit docker config for non root runtime", func(t *testing.T) {
cfg := &RuntimeIdentityConfig{DockerConfig: "/custom/docker-config"}
env := map[string]string{}
@@ -132,6 +213,7 @@ func TestConfigureRuntimeDockerConfigEnv(t *testing.T) {
},
1001,
1001,
+ false,
)
require.NoError(t, err)
@@ -155,6 +237,7 @@ func TestConfigureRuntimeDockerConfigEnv(t *testing.T) {
},
0,
0,
+ true,
)
require.NoError(t, err)
@@ -176,6 +259,7 @@ func TestConfigureRuntimeDockerConfigEnv(t *testing.T) {
},
0,
1001,
+ true,
)
require.NoError(t, err)
@@ -197,6 +281,7 @@ func TestEnsureRuntimeDockerConfigCreatesCustomDirectory(t *testing.T) {
},
1001,
1001,
+ false,
))
info, err := os.Stat(customDir)
diff --git a/docker/Dockerfile b/docker/Dockerfile
index 5c18f04e6..ebb667217 100644
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@@ -84,6 +84,7 @@ ARG REVISION
ENV GIN_MODE=release
ENV PORT=3552
ENV ENVIRONMENT=production
+ENV ARCANE_IN_CONTAINER=true
ENV NVIDIA_VISIBLE_DEVICES=all \
NVIDIA_DRIVER_CAPABILITIES=compute,utility \
ROCR_VISIBLE_DEVICES=all \
diff --git a/docker/Dockerfile-agent b/docker/Dockerfile-agent
index 7eff2ae37..1f71d3e60 100644
--- a/docker/Dockerfile-agent
+++ b/docker/Dockerfile-agent
@@ -66,6 +66,7 @@ ENV NVIDIA_VISIBLE_DEVICES=all \
LD_LIBRARY_PATH=/usr/local/nvidia/lib:/usr/local/nvidia/lib64:/opt/rocm/lib:/opt/intel/oneapi/lib:/opt/intel/oneapi/lib/intel64:/usr/lib/x86_64-linux-gnu:/usr/lib/aarch64-linux-gnu:/usr/lib64:/usr/lib:/lib64:/lib
ENV ENVIRONMENT=production \
+ ARCANE_IN_CONTAINER=true \
AGENT_MODE=true \
GIN_MODE=release \
PORT=3553
diff --git a/docker/Dockerfile.dev b/docker/Dockerfile.dev
index 225e7c08e..15f986934 100644
--- a/docker/Dockerfile.dev
+++ b/docker/Dockerfile.dev
@@ -45,6 +45,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
ENV GIN_MODE=debug \
PORT=3552 \
ENVIRONMENT=development \
+ ARCANE_IN_CONTAINER=true \
GOCACHE=/root/.cache/go-build \
GOMODCACHE=/go/pkg/mod