From b90ee5d10067f822dba1732718aa1193c5f19fbb Mon Sep 17 00:00:00 2001 From: Tariq Ibrahim Date: Thu, 10 Oct 2024 09:50:48 -0700 Subject: [PATCH] [no-relnote] minor cleanup and improvements Signed-off-by: Tariq Ibrahim Signed-off-by: Evan Lezar --- .golangci.yml | 2 +- CHANGELOG.md | 2 +- cmd/nvidia-ctk/runtime/configure/configure.go | 8 ++++---- internal/platform-support/tegra/csv.go | 2 +- pkg/config/engine/containerd/config_v1.go | 4 ++-- pkg/config/engine/containerd/containerd.go | 3 ++- pkg/config/engine/crio/crio.go | 3 ++- pkg/config/engine/docker/docker.go | 3 ++- tools/container/nvidia-toolkit/run.go | 12 +++++------- 9 files changed, 20 insertions(+), 19 deletions(-) diff --git a/.golangci.yml b/.golangci.yml index 825d94c3..f1208798 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -1,5 +1,5 @@ run: - deadline: 10m + timeout: 10m linters: enable: diff --git a/CHANGELOG.md b/CHANGELOG.md index 5dcd5690..461c2630 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -135,7 +135,7 @@ ## v1.14.0-rc.2 * Fix bug causing incorrect nvidia-smi symlink to be created on WSL2 systems with multiple driver roots. * Remove dependency on coreutils when installing package on RPM-based systems. -* Create ouput folders if required when running `nvidia-ctk runtime configure` +* Create output folders if required when running `nvidia-ctk runtime configure` * Generate default config as post-install step. * Added support for detecting GSP firmware at custom paths when generating CDI specifications. * Added logic to skip the extraction of image requirements if `NVIDIA_DISABLE_REQUIRES` is set to `true`. diff --git a/cmd/nvidia-ctk/runtime/configure/configure.go b/cmd/nvidia-ctk/runtime/configure/configure.go index 2f82ae6d..ed4d84ac 100644 --- a/cmd/nvidia-ctk/runtime/configure/configure.go +++ b/cmd/nvidia-ctk/runtime/configure/configure.go @@ -54,7 +54,7 @@ type command struct { logger logger.Interface } -// NewCommand constructs an configure command with the specified logger +// NewCommand constructs a configure command with the specified logger func NewCommand(logger logger.Interface) *cli.Command { c := command{ logger: logger, @@ -289,7 +289,7 @@ func (m command) configureConfigFile(c *cli.Context, config *config) error { return fmt.Errorf("failed to enable CDI in %s: %w", config.runtime, err) } - outputPath := config.getOuputConfigPath() + outputPath := config.getOutputConfigPath() n, err := cfg.Save(outputPath) if err != nil { return fmt.Errorf("unable to flush config: %v", err) @@ -346,8 +346,8 @@ func (c *config) getCommandConfigSource() toml.Loader { return toml.Empty } -// getOuputConfigPath returns the configured config path or "" if dry-run is enabled -func (c *config) getOuputConfigPath() string { +// getOutputConfigPath returns the configured config path or "" if dry-run is enabled +func (c *config) getOutputConfigPath() string { if c.dryRun { return "" } diff --git a/internal/platform-support/tegra/csv.go b/internal/platform-support/tegra/csv.go index a025c52d..9af38d71 100644 --- a/internal/platform-support/tegra/csv.go +++ b/internal/platform-support/tegra/csv.go @@ -62,7 +62,7 @@ func (o tegraOptions) newDiscovererFromCSVFiles() (discover.Discover, error) { o.nvidiaCDIHookPath, ) - // We process the expliclitlty requested symlinks. + // We process the explicitly requested symlinks. symlinkTargets := o.ignorePatterns.Apply(targetsByType[csv.MountSpecSym]...) o.logger.Debugf("Filtered symlink targets: %v", symlinkTargets) symlinks := discover.NewMounts( diff --git a/pkg/config/engine/containerd/config_v1.go b/pkg/config/engine/containerd/config_v1.go index bfe1290b..db6cf2dc 100644 --- a/pkg/config/engine/containerd/config_v1.go +++ b/pkg/config/engine/containerd/config_v1.go @@ -141,14 +141,14 @@ func (c *ConfigV1) RemoveRuntime(name string) error { return nil } -// SetOption sets the specified containerd option. +// Set sets the specified containerd option. func (c *ConfigV1) Set(key string, value interface{}) { config := *c.Tree config.SetPath([]string{"plugins", "cri", "containerd", key}, value) *c.Tree = config } -// Save wrotes the config to a file +// Save writes the config to a file func (c ConfigV1) Save(path string) (int64, error) { return (Config)(c).Save(path) } diff --git a/pkg/config/engine/containerd/containerd.go b/pkg/config/engine/containerd/containerd.go index 01791c09..43ff44a7 100644 --- a/pkg/config/engine/containerd/containerd.go +++ b/pkg/config/engine/containerd/containerd.go @@ -41,7 +41,8 @@ type containerdCfgRuntime struct { var _ engine.RuntimeConfig = (*containerdCfgRuntime)(nil) -// GetBinaryPath retrieves the path to the actual low-level runtime binary invoked by the runtime handler +// GetBinaryPath retrieves the path to the low-level runtime binary for a runtime. +// If no path is available, the empty string is returned. func (c *containerdCfgRuntime) GetBinaryPath() string { if c == nil || c.tree == nil { return "" diff --git a/pkg/config/engine/crio/crio.go b/pkg/config/engine/crio/crio.go index acaa1185..ce9c37ff 100644 --- a/pkg/config/engine/crio/crio.go +++ b/pkg/config/engine/crio/crio.go @@ -36,7 +36,8 @@ type crioRuntime struct { var _ engine.RuntimeConfig = (*crioRuntime)(nil) -// GetBinaryPath retrieves the path to the actual low-level runtime binary invoked by the runtime handler +// GetBinaryPath retrieves the path to the low-level runtime binary for a runtime. +// If no path is available, the empty string is returned. func (c *crioRuntime) GetBinaryPath() string { if c.tree != nil { if binaryPath, ok := c.tree.GetPath([]string{"runtime_path"}).(string); ok { diff --git a/pkg/config/engine/docker/docker.go b/pkg/config/engine/docker/docker.go index 3f0f3e47..6ea64f06 100644 --- a/pkg/config/engine/docker/docker.go +++ b/pkg/config/engine/docker/docker.go @@ -39,7 +39,8 @@ type dockerRuntime map[string]interface{} var _ engine.RuntimeConfig = (*dockerRuntime)(nil) -// GetBinaryPath retrieves the path to the actual low-level runtime binary invoked by the runtime handler +// GetBinaryPath retrieves the path to the low-level runtime binary for a runtime. +// If no path is available, the empty string is returned. func (d dockerRuntime) GetBinaryPath() string { if d == nil { return "" diff --git a/tools/container/nvidia-toolkit/run.go b/tools/container/nvidia-toolkit/run.go index 8e389e94..265814a5 100644 --- a/tools/container/nvidia-toolkit/run.go +++ b/tools/container/nvidia-toolkit/run.go @@ -9,8 +9,8 @@ import ( "syscall" log "github.com/sirupsen/logrus" - cli "github.com/urfave/cli/v2" - unix "golang.org/x/sys/unix" + "github.com/urfave/cli/v2" + "golang.org/x/sys/unix" "github.com/NVIDIA/nvidia-container-toolkit/tools/container/runtime" "github.com/NVIDIA/nvidia-container-toolkit/tools/container/toolkit" @@ -19,12 +19,10 @@ import ( const ( toolkitPidFilename = "toolkit.pid" defaultPidFile = "/run/nvidia/toolkit/" + toolkitPidFilename - toolkitCommand = "toolkit" toolkitSubDir = "toolkit" - defaultRuntime = "docker" - defaultRuntimeArgs = "" - defaultHostRootMount = "/host" + defaultRuntime = "docker" + defaultRuntimeArgs = "" ) var availableRuntimes = map[string]struct{}{"docker": {}, "crio": {}, "containerd": {}} @@ -192,7 +190,7 @@ func Run(c *cli.Context, o *options) error { } // ParseArgs checks if a single positional argument was defined and extracts this the root. -// If no positional arguments are defined, the it is assumed that the root is specified as a flag. +// If no positional arguments are defined, it is assumed that the root is specified as a flag. func ParseArgs(args []string) ([]string, string, error) { log.Infof("Parsing arguments")