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.

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

add: Allow config and pre-processed configuration to leverage environment variables ($K3D_CONFIG env var) #1446

Merged
merged 9 commits into from
Nov 26, 2024
Merged

add: Allow config and pre-processed configuration to leverage environment variables ($K3D_CONFIG env var) #1446

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5f74fc0
allow config and pre-processed configuration to leverage environment …
dprunier May 29, 2024
a824179
cluster delete command was not using the correct viper instance...
dprunier Jul 15, 2024
376692e
cluster delete command was not using the correct viper instance again...
dprunier Jul 15, 2024
c50308f
Merge remote-tracking branch 'upstream/main' into config_file_from_env
dprunier Jul 15, 2024
fff51e9
ignore configuration provided to cluster delete command if it doesnt …
dprunier Jul 15, 2024
8248a7c
Merge remote-tracking branch 'upstream/main' into config_file_from_env
dprunier Sep 23, 2024
00692d3
Merge remote-tracking branch 'upstream/main' into config_file_from_env
dprunier Oct 22, 2024
6087e5d
Merge remote-tracking branch 'upstream/main' into config_file_from_env
dprunier Nov 18, 2024
a8445fc
allow --all or args to override configuration name
dprunier Nov 18, 2024
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
11 changes: 6 additions & 5 deletions cmd/cluster/clusterCreate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ import (
"github.com/k3d-io/k3d/v5/version"
)

var configFile string

const clusterCreateDescription = `
Create a new k3s cluster with containerized nodes (k3s in docker).
Every cluster will consist of one or more containers:
Expand All @@ -72,13 +70,15 @@ var (
func initConfig() error {
// Viper for pre-processed config options
ppViper.SetEnvPrefix("K3D")
ppViper.AutomaticEnv()
ppViper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))

if l.Log().GetLevel() >= logrus.DebugLevel {
c, _ := yaml.Marshal(ppViper.AllSettings())
l.Log().Debugf("Additional CLI Configuration:\n%s", c)
}

return cliconfig.InitViperWithConfigFile(cfgViper, configFile)
return cliconfig.InitViperWithConfigFile(cfgViper, ppViper.GetString("config"))
}

// NewCmdClusterCreate returns a new cobra command
Expand Down Expand Up @@ -123,7 +123,7 @@ func NewCmdClusterCreate() *cobra.Command {
l.Log().Fatalf("error processing/sanitizing simple config: %v", err)
}

clusterConfig, err := config.TransformSimpleToClusterConfig(cmd.Context(), runtimes.SelectedRuntime, simpleCfg, configFile)
clusterConfig, err := config.TransformSimpleToClusterConfig(cmd.Context(), runtimes.SelectedRuntime, simpleCfg, ppViper.GetString("config"))
if err != nil {
l.Log().Fatalln(err)
}
Expand Down Expand Up @@ -208,7 +208,8 @@ func NewCmdClusterCreate() *cobra.Command {
* Config File *
***************/

cmd.Flags().StringVarP(&configFile, "config", "c", "", "Path of a config file to use")
cmd.Flags().StringP("config", "c", "", "Path of a config file to use")
_ = ppViper.BindPFlag("config", cmd.Flags().Lookup("config"))
if err := cmd.MarkFlagFilename("config", "yaml", "yml"); err != nil {
l.Log().Fatalln("Failed to mark flag 'config' as filename flag")
}
Expand Down
30 changes: 25 additions & 5 deletions cmd/cluster/clusterDelete.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (
"fmt"
"os"
"path"
"strings"

"github.com/k3d-io/k3d/v5/cmd/util"
cliconfig "github.com/k3d-io/k3d/v5/cmd/util/config"
Expand All @@ -35,13 +36,31 @@ import (
"github.com/k3d-io/k3d/v5/pkg/runtimes"
k3d "github.com/k3d-io/k3d/v5/pkg/types"
k3dutil "github.com/k3d-io/k3d/v5/pkg/util"
"github.com/sirupsen/logrus"
"sigs.k8s.io/yaml"

"github.com/spf13/cobra"
"github.com/spf13/viper"
)

var clusterDeleteConfigFile string
var clusterDeleteCfgViper = viper.New()
var (
clusterDeleteCfgViper = viper.New()
clusterDeletePpViper = viper.New()
)

func initClusterDeleteConfig() error {
// Viper for pre-processed config options
ppViper.SetEnvPrefix("K3D")
ppViper.AutomaticEnv()
ppViper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))

if l.Log().GetLevel() >= logrus.DebugLevel {
c, _ := yaml.Marshal(ppViper.AllSettings())
l.Log().Debugf("Additional CLI Configuration:\n%s", c)
}

return cliconfig.InitViperWithConfigFile(cfgViper, ppViper.GetString("config"))
}

// NewCmdClusterDelete returns a new cobra command
func NewCmdClusterDelete() *cobra.Command {
Expand All @@ -54,7 +73,7 @@ func NewCmdClusterDelete() *cobra.Command {
Args: cobra.MinimumNArgs(0), // 0 or n arguments; 0 = default cluster name
ValidArgsFunction: util.ValidArgsAvailableClusters,
PreRunE: func(cmd *cobra.Command, args []string) error {
return cliconfig.InitViperWithConfigFile(clusterDeleteCfgViper, clusterDeleteConfigFile)
return initClusterDeleteConfig()
},
Run: func(cmd *cobra.Command, args []string) {
clusters := parseDeleteClusterCmd(cmd, args)
Expand Down Expand Up @@ -99,7 +118,8 @@ func NewCmdClusterDelete() *cobra.Command {
* Config File *
***************/

cmd.Flags().StringVarP(&clusterDeleteConfigFile, "config", "c", "", "Path of a config file to use")
cmd.Flags().StringP("config", "c", "", "Path of a config file to use")
_ = ppViper.BindPFlag("config", cmd.Flags().Lookup("config"))
if err := cmd.MarkFlagFilename("config", "yaml", "yml"); err != nil {
l.Log().Fatalln("Failed to mark flag 'config' as filename flag")
}
Expand All @@ -119,7 +139,7 @@ func parseDeleteClusterCmd(cmd *cobra.Command, args []string) []*k3d.Cluster {
}

// --config
if clusterDeleteConfigFile != "" {
if clusterDeletePpViper.GetString("config") != "" {
// not allowed with --all or more args
if len(args) > 0 || all {
l.Log().Fatalln("failed to delete cluster: cannot use `--config` flag with additional arguments or `--all`")
Expand Down