Skip to content

[deckhouse-cli] fix: Plugins fallback to use homedir #258

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.

Sign up for GitHub

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

Merged
ldmonster merged 4 commits into from
Dec 29, 2025
Merged

[deckhouse-cli] fix: Plugins fallback to use homedir #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b244af1
fix
riptide-01 Dec 26, 2025
2f7f00a
fix
riptide-01 Dec 26, 2025
14b308d
using nested string not struct
ldmonster Dec 26, 2025
0ec3f98
fix
riptide-01 Dec 26, 2025
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
22 changes: 11 additions & 11 deletions cmd/plugins/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import (

dkplog "github.com/deckhouse/deckhouse/pkg/log"

"github.com/deckhouse/deckhouse-cli/cmd/plugins/flags"
"github.com/deckhouse/deckhouse-cli/pkg/registry/service"
)

Expand All @@ -41,7 +40,7 @@ const (
func NewPluginCommand(commandName string, description string, aliases []string, logger *dkplog.Logger) *cobra.Command {
pc := NewPluginsCommand(logger.Named("plugins-command"))

pluginContractFilePath := path.Join(flags.DeckhousePluginsDir, "cache", "contracts", "system.json")
pluginContractFilePath := path.Join(pc.pluginDirectory, "cache", "contracts", "system.json")
pluginContract, err := service.GetPluginContractFromFile(pluginContractFilePath)
if err != nil {
logger.Debug("failed to get plugin contract from cache", slog.String("error", err.Error()))
Expand All @@ -53,18 +52,18 @@ func NewPluginCommand(commandName string, description string, aliases []string,

// to check we can create directories here
// we try to create root plugins folder
err = os.MkdirAll(flags.DeckhousePluginsDir+"/plugins", 0755)
err = os.MkdirAll(pc.pluginDirectory+"/plugins", 0755)
// if permission failed
if errors.Is(err, os.ErrPermission) {
pc.logger.Warn("use homedir instead of default d8 plugins path in '/opt/deckhouse/lib/deckhouse-cli'", slog.String("new_path", flags.DeckhousePluginsDir), dkplog.Err(err))
pc.logger.Warn("use homedir instead of default d8 plugins path in '/opt/deckhouse/lib/deckhouse-cli'", slog.String("new_path", pc.pluginDirectory), dkplog.Err(err))

flags.DeckhousePluginsDir, err = os.UserHomeDir()
pc.pluginDirectory, err = os.UserHomeDir()
if err != nil {
logger.Warn("failed to receive home dir to create plugins dir", slog.String("error", err.Error()))
return nil
}

flags.DeckhousePluginsDir = path.Join(flags.DeckhousePluginsDir, ".deckhouse-cli")
pc.pluginDirectory = path.Join(pc.pluginDirectory, ".deckhouse-cli")
}

if err != nil {
Expand All @@ -83,11 +82,12 @@ func NewPluginCommand(commandName string, description string, aliases []string,
pc.InitPluginServices()
},
Run: func(cmd *cobra.Command, args []string) {
installed, err := checkInstalled(commandName)
installed, err := pc.checkInstalled(commandName)
if err != nil {
fmt.Println("Error checking installed:", err)
return
}

if !installed {
fmt.Println("Not installed, installing...")
err = pc.InstallPlugin(cmd.Context(), commandName, "", -1)
Expand All @@ -98,15 +98,15 @@ func NewPluginCommand(commandName string, description string, aliases []string,
fmt.Println("Installed successfully")
}

pluginPath := path.Join(flags.DeckhousePluginsDir, "plugins", commandName)
pluginPath := path.Join(pc.pluginDirectory, "plugins", commandName)
pluginBinaryPath := path.Join(pluginPath, "current")
absPath, err := filepath.Abs(pluginBinaryPath)
if err != nil {
logger.Warn("failed to compute absolute path", slog.String("error", err.Error()))
return
}

logger.Info("Executing plugin", slog.Any("args", args))
logger.Debug("Executing plugin", slog.Any("args", args))

command := exec.CommandContext(cmd.Context(), absPath, args...)
command.Stdout = os.Stdout
Expand All @@ -122,8 +122,8 @@ func NewPluginCommand(commandName string, description string, aliases []string,
return systemCmd
}

func checkInstalled(commandName string) (bool, error) {
installedFile := path.Join(flags.DeckhousePluginsDir, "plugins", commandName, "current")
func (pc *PluginsCommand) checkInstalled(commandName string) (bool, error) {
installedFile := path.Join(pc.pluginDirectory, "plugins", commandName, "current")
absPath, err := filepath.Abs(installedFile)
if err != nil {
return false, fmt.Errorf("failed to compute absolute path: %w", err)
Expand Down
41 changes: 29 additions & 12 deletions cmd/plugins/plugins.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package plugins
import (
"context"
"encoding/json"
"errors"
"fmt"
"log/slog"
"os"
Expand All @@ -42,6 +43,7 @@ import (
type PluginsCommand struct {
service *service.PluginService
pluginRegistryClient registry.Client
pluginDirectory string

logger *dkplog.Logger
}
Expand All @@ -62,7 +64,8 @@ type pluginsListData struct {

func NewPluginsCommand(logger *dkplog.Logger) *PluginsCommand {
return &PluginsCommand{
logger: logger,
pluginDirectory: flags.DeckhousePluginsDir,
logger: logger,
}
}

Expand All @@ -76,6 +79,20 @@ func NewCommand(logger *dkplog.Logger) *cobra.Command {
PersistentPreRun: func(_ *cobra.Command, _ []string) {
// init plugin services for subcommands after flags are parsed
pc.InitPluginServices()

err := os.MkdirAll(flags.DeckhousePluginsDir+"/plugins", 0755)
// if permission failed
if errors.Is(err, os.ErrPermission) {
pc.logger.Warn("use homedir instead of default d8 plugins path in '/opt/deckhouse/lib/deckhouse-cli'", slog.String("new_path", flags.DeckhousePluginsDir), dkplog.Err(err))

newPluginDirectory, err := os.UserHomeDir()
if err != nil {
logger.Warn("failed to receive home dir to create plugins dir", slog.String("error", err.Error()))
return
}

pc.pluginDirectory = path.Join(newPluginDirectory, ".deckhouse-cli")
}
},
}

Expand Down Expand Up @@ -150,15 +167,15 @@ func (pc *PluginsCommand) preparePluginsListData(ctx context.Context, showInstal

// fetchInstalledPlugins retrieves installed plugins from filesystem
func (pc *PluginsCommand) fetchInstalledPlugins() ([]pluginDisplayInfo, error) {
plugins, err := os.ReadDir(path.Join(flags.DeckhousePluginsDir, "plugins"))
plugins, err := os.ReadDir(path.Join(pc.pluginDirectory, "plugins"))
if err != nil {
return nil, fmt.Errorf("failed to read plugins directory: %w", err)
}

res := make([]pluginDisplayInfo, 0, len(plugins))

for _, plugin := range plugins {
pluginBinaryPath := path.Join(flags.DeckhousePluginsDir, "plugins", plugin.Name(), "current")
pluginBinaryPath := path.Join(pc.pluginDirectory, "plugins", plugin.Name(), "current")
cmd := exec.Command(pluginBinaryPath, "--version")

output, err := cmd.Output()
Expand Down Expand Up @@ -202,7 +219,7 @@ func (pc *PluginsCommand) fetchInstalledPlugins() ([]pluginDisplayInfo, error) {
}

func (pc *PluginsCommand) getInstalledPluginContract(pluginName string) (*internal.Plugin, error) {
contractFile := path.Join(flags.DeckhousePluginsDir, "cache", "contracts", pluginName+".json")
contractFile := path.Join(pc.pluginDirectory, "cache", "contracts", pluginName+".json")

file, err := os.Open(contractFile)
if err != nil {
Expand Down Expand Up @@ -520,7 +537,7 @@ func (pc *PluginsCommand) InstallPlugin(ctx context.Context, pluginName, version
func (pc *PluginsCommand) installPlugin(ctx context.Context, pluginName string, version *semver.Version, useMajor int) error {
// create plugin directory if it doesn't exist
// example path: /opt/deckhouse/lib/deckhouse-cli/plugins/example-plugin
pluginDir := path.Join(flags.DeckhousePluginsDir, "plugins", pluginName)
pluginDir := path.Join(pc.pluginDirectory, "plugins", pluginName)
err := os.MkdirAll(pluginDir, 0755)
if err != nil {
return fmt.Errorf("failed to create plugin directory: %w", err)
Expand Down Expand Up @@ -615,7 +632,7 @@ func (pc *PluginsCommand) installPlugin(ctx context.Context, pluginName string,

// cache contract
// example path: /opt/deckhouse/lib/deckhouse-cli/cache/contracts
contractDir := path.Join(flags.DeckhousePluginsDir, "cache", "contracts")
contractDir := path.Join(pc.pluginDirectory, "cache", "contracts")
err = os.MkdirAll(contractDir, 0755)
if err != nil {
return fmt.Errorf("failed to create contract directory: %w", err)
Expand Down Expand Up @@ -707,7 +724,7 @@ func (pc *PluginsCommand) pluginsUpdateAllCommand() *cobra.Command {

fmt.Println("Updating all installed plugins...")

plugins, err := os.ReadDir(path.Join(flags.DeckhousePluginsDir, "plugins"))
plugins, err := os.ReadDir(path.Join(pc.pluginDirectory, "plugins"))
if err != nil {
return fmt.Errorf("failed to read plugins directory: %w", err)
}
Expand Down Expand Up @@ -739,7 +756,7 @@ func (pc *PluginsCommand) pluginsRemoveCommand() *cobra.Command {
pluginName := args[0]
fmt.Printf("Removing plugin: %s\n", pluginName)

pluginDir := path.Join(flags.DeckhousePluginsDir, "plugins", pluginName)
pluginDir := path.Join(pc.pluginDirectory, "plugins", pluginName)
fmt.Printf("Removing plugin from: %s\n", pluginDir)

err := os.RemoveAll(pluginDir)
Expand All @@ -749,7 +766,7 @@ func (pc *PluginsCommand) pluginsRemoveCommand() *cobra.Command {

fmt.Println("Cleaning up plugin files...")

os.Remove(path.Join(flags.DeckhousePluginsDir, "cache", "contracts", pluginName+".json"))
os.Remove(path.Join(pc.pluginDirectory, "cache", "contracts", pluginName+".json"))

fmt.Printf("✓ Plugin '%s' successfully removed!\n", pluginName)

Expand All @@ -771,15 +788,15 @@ func (pc *PluginsCommand) pluginsRemoveAllCommand() *cobra.Command {
RunE: func(_ *cobra.Command, _ []string) error {
fmt.Println("Removing all installed plugins...")

plugins, err := os.ReadDir(path.Join(flags.DeckhousePluginsDir, "plugins"))
plugins, err := os.ReadDir(path.Join(pc.pluginDirectory, "plugins"))
if err != nil {
return fmt.Errorf("failed to read plugins directory: %w", err)
}

fmt.Println("Found", len(plugins), "plugins to remove:")

for _, plugin := range plugins {
pluginDir := path.Join(flags.DeckhousePluginsDir, "plugins", plugin.Name())
pluginDir := path.Join(pc.pluginDirectory, "plugins", plugin.Name())
fmt.Printf("Removing plugin from: %s\n", pluginDir)

err := os.RemoveAll(pluginDir)
Expand All @@ -789,7 +806,7 @@ func (pc *PluginsCommand) pluginsRemoveAllCommand() *cobra.Command {

fmt.Printf("Cleaning up plugin files for '%s'...\n", plugin.Name())

os.Remove(path.Join(flags.DeckhousePluginsDir, "cache", "contracts", plugin.Name()+".json"))
os.Remove(path.Join(pc.pluginDirectory, "cache", "contracts", plugin.Name()+".json"))

fmt.Printf("✓ Plugin '%s' successfully removed!\n", plugin.Name())
}
Expand Down
6 changes: 2 additions & 4 deletions pkg/registry/service/plugin_service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,15 +81,13 @@ func (s *PluginService) GetPluginContract(ctx context.Context, pluginName, tag s
return nil, fmt.Errorf("no manifests found in index manifest")
}

// hardcoded first
// hardcoded first manifest (all contracts must be the same for all manifests)
digest := indexManifest.GetManifests()[0].GetDigest()
if digest.String() == "" {
return nil, fmt.Errorf("no digest found in manifest")
}

digestClient := pluginClient.WithSegment("meta")

digestManifestResult, err = digestClient.GetManifest(ctx, "@"+digest.String())
digestManifestResult, err = pluginClient.GetManifest(ctx, "@"+digest.String())
if err != nil {
return nil, fmt.Errorf("failed to get manifest: %w", err)
}
Expand Down