Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

config: avoid to use default dir if root is valid #393

Merged
merged 3 commits into from
Mar 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -245,10 +245,6 @@ func ValidateConfig(c *SnapshotterConfig) error {
"\"enable_cri_keychain\" and \"enable_kubeconfig_keychain\" can't be set at the same time")
}

if !c.CacheManagerConfig.Disable && c.CacheManagerConfig.CacheDir == "" {
return errors.Wrapf(errdefs.ErrInvalidArgument, "cache directory is empty")
}

if c.RemoteConfig.MirrorsConfig.Dir != "" {
dirExisted, err := file.IsDirExisted(c.RemoteConfig.MirrorsConfig.Dir)
if err != nil {
Expand Down
63 changes: 63 additions & 0 deletions config/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package config

import (
"path/filepath"
"testing"
"time"

Expand Down Expand Up @@ -162,3 +163,65 @@ func TestSnapshotterConfig(t *testing.T) {
A.NoError(err)
A.EqualValues(cfg.LoggingConfig.LogToStdout, false)
}

func TestMergeConfig(t *testing.T) {
A := assert.New(t)
var defaultSnapshotterConfig SnapshotterConfig
var snapshotterConfig1 SnapshotterConfig

defaultSnapshotterConfig.FillUpWithDefaults()

MergeConfig(&snapshotterConfig1, &defaultSnapshotterConfig)
A.Equal(snapshotterConfig1.Root, defaultRootDir)
A.Equal(snapshotterConfig1.LoggingConfig.LogDir, "")
A.Equal(snapshotterConfig1.CacheManagerConfig.CacheDir, "")

A.Equal(snapshotterConfig1.DaemonMode, DefaultDaemonMode)
A.Equal(snapshotterConfig1.SystemControllerConfig.Address, defaultSystemControllerAddress)
A.Equal(snapshotterConfig1.LoggingConfig.LogLevel, DefaultLogLevel)
A.Equal(snapshotterConfig1.LoggingConfig.RotateLogMaxSize, defaultRotateLogMaxSize)
A.Equal(snapshotterConfig1.LoggingConfig.RotateLogMaxBackups, defaultRotateLogMaxBackups)
A.Equal(snapshotterConfig1.LoggingConfig.RotateLogMaxAge, defaultRotateLogMaxAge)
A.Equal(snapshotterConfig1.LoggingConfig.RotateLogCompress, defaultRotateLogCompress)

A.Equal(snapshotterConfig1.DaemonConfig.NydusdConfigPath, defaultNydusDaemonConfigPath)
A.Equal(snapshotterConfig1.DaemonConfig.RecoverPolicy, RecoverPolicyRestart.String())
A.Equal(snapshotterConfig1.CacheManagerConfig.GCPeriod, defaultGCPeriod)

var snapshotterConfig2 SnapshotterConfig
snapshotterConfig2.Root = "/snapshotter/root"

MergeConfig(&snapshotterConfig2, &defaultSnapshotterConfig)
A.Equal(snapshotterConfig2.Root, "/snapshotter/root")
A.Equal(snapshotterConfig2.LoggingConfig.LogDir, "")
A.Equal(snapshotterConfig2.CacheManagerConfig.CacheDir, "")
}

func TestProcessConfigurations(t *testing.T) {
A := assert.New(t)
var defaultSnapshotterConfig SnapshotterConfig
var snapshotterConfig1 SnapshotterConfig

defaultSnapshotterConfig.FillUpWithDefaults()

MergeConfig(&snapshotterConfig1, &defaultSnapshotterConfig)
err := ValidateConfig(&snapshotterConfig1)
A.NoError(err)
err = ProcessConfigurations(&snapshotterConfig1)
A.NoError(err)

A.Equal(snapshotterConfig1.LoggingConfig.LogDir, filepath.Join(snapshotterConfig1.Root, "logs"))
A.Equal(snapshotterConfig1.CacheManagerConfig.CacheDir, filepath.Join(snapshotterConfig1.Root, "cache"))

var snapshotterConfig2 SnapshotterConfig
snapshotterConfig2.Root = "/snapshotter/root"

MergeConfig(&snapshotterConfig2, &defaultSnapshotterConfig)
err = ValidateConfig(&snapshotterConfig2)
A.NoError(err)
err = ProcessConfigurations(&snapshotterConfig2)
A.NoError(err)

A.Equal(snapshotterConfig2.LoggingConfig.LogDir, filepath.Join(snapshotterConfig2.Root, "logs"))
A.Equal(snapshotterConfig2.CacheManagerConfig.CacheDir, filepath.Join(snapshotterConfig2.Root, "cache"))
}
9 changes: 0 additions & 9 deletions config/default.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ package config

import (
"os/exec"
"path/filepath"

"github.com/containerd/nydus-snapshotter/cmd/containerd-nydus-grpc/pkg/logging"
)

const (
Expand Down Expand Up @@ -50,9 +47,6 @@ func (c *SnapshotterConfig) FillUpWithDefaults() error {
if logConfig.LogLevel == "" {
logConfig.LogLevel = DefaultLogLevel
}
if len(logConfig.LogDir) == 0 {
logConfig.LogDir = filepath.Join(c.Root, logging.DefaultLogDirName)
}
logConfig.RotateLogMaxSize = defaultRotateLogMaxSize
logConfig.RotateLogMaxBackups = defaultRotateLogMaxBackups
logConfig.RotateLogMaxAge = defaultRotateLogMaxAge
Expand All @@ -71,9 +65,6 @@ func (c *SnapshotterConfig) FillUpWithDefaults() error {
if cacheConfig.GCPeriod == "" {
cacheConfig.GCPeriod = defaultGCPeriod
}
if len(cacheConfig.CacheDir) == 0 {
cacheConfig.CacheDir = filepath.Join(c.Root, "cache")
}

return c.SetupNydusBinaryPaths()
}
Expand Down
8 changes: 8 additions & 0 deletions config/global.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"time"

"github.com/containerd/containerd/log"
"github.com/containerd/nydus-snapshotter/cmd/containerd-nydus-grpc/pkg/logging"
"github.com/pkg/errors"
)

Expand Down Expand Up @@ -96,6 +97,13 @@ func GetDaemonProfileCPUDuration() int64 {
}

func ProcessConfigurations(c *SnapshotterConfig) error {
if c.LoggingConfig.LogDir == "" {
c.LoggingConfig.LogDir = filepath.Join(c.Root, logging.DefaultLogDirName)
}
if c.CacheManagerConfig.CacheDir == "" {
c.CacheManagerConfig.CacheDir = filepath.Join(c.Root, "cache")
}

globalConfig.origin = c

globalConfig.SnapshotsDir = filepath.Join(c.Root, "snapshots")
Expand Down