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

Enh/target cluster by alias #185

Merged
merged 6 commits into from
Dec 13, 2022
Merged

Enh/target cluster by alias #185

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
88d25ed
enh: allow targeting by alias
sven-petersen Nov 21, 2022
ca5d78b
enh: autocompletion/suggestion also lists aliases
sven-petersen Nov 21, 2022
2209d2c
enh: support alias for config set-garden
sven-petersen Nov 21, 2022
e8a9c41
enh: validate gardenctl config on load
sven-petersen Nov 22, 2022
1182d04
feat: PR feedback I
sven-petersen Nov 25, 2022
d2ad8d3
enh: PR feedback II
sven-petersen Dec 8, 2022
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
Prev Previous commit
Next Next commit
feat: PR feedback I
  • Loading branch information
@sven-petersen
sven-petersen committed Dec 12, 2022
commit 1182d04594932a0c05c45a34c6c81a979f010f57
53 changes: 25 additions & 28 deletions pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"gopkg.in/yaml.v3"
"k8s.io/client-go/tools/clientcmd"
clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
"k8s.io/klog/v2"

"github.com/gardener/gardenctl-v2/pkg/ac"
)
Expand Down Expand Up @@ -99,44 +100,36 @@ func LoadFromFile(filename string) (*Config, error) {
config.LinkKubeconfig = &val
}

if err := config.validate(); err != nil {
return nil, err
}
config.validate()

return config, nil
}

// validate checks the config for static errors. It does not check if the kubeconfig file exists.
func (config *Config) validate() error {
// validate checks the config for ambigous definitions and prints a warnings to the user.
sven-petersen marked this conversation as resolved.
Show resolved Hide resolved
func (config *Config) validate() {
seen := make(map[string]bool, len(config.Gardens))

for i := range config.Gardens {
garden := config.Gardens[i]

if garden.Name == "" {
return fmt.Errorf("identity is required for gardens in the gardenctl configuration")
}
if logged, ok := seen[garden.Name]; ok && !logged {
klog.Warningf("identity and alias should be unique but %q was found multiple times in gardenctl configuration", garden.Name)

if garden.Kubeconfig == "" {
return fmt.Errorf("kubeconfig is required for gardens in the gardenctl configuration")
seen[garden.Name] = true
} else if !ok {
seen[garden.Name] = false
}

if seen[garden.Name] {
return fmt.Errorf("identity and alias must be unique but %q was found multiple times in gardenctl configuration", garden.Name)
}
if garden.Alias != "" && garden.Alias != garden.Name {
if logged, ok := seen[garden.Alias]; ok && !logged {
klog.Warningf("identity and alias should be unique but %q was found multiple times in gardenctl configuration", garden.Alias)

if garden.Alias != "" {
if seen[garden.Alias] {
return fmt.Errorf("identity and alias must be unique but %q was found multiple times in gardenctl configuration", garden.Alias)
seen[garden.Alias] = true
} else if !ok {
seen[garden.Alias] = false
}

seen[garden.Alias] = true
}

seen[garden.Name] = true
}

return nil
}

// SymlinkTargetKubeconfig indicates if the kubeconfig of the current target should be always symlinked.
Expand Down Expand Up @@ -188,22 +181,26 @@ func (config *Config) GardenNames() []string {
return names
}

// Garden returns a Garden cluster by name (identity or alias) from the list of configured Gardens.
// Garden returns the matching Garden cluster by name (identity or alias) from the list
// of configured Gardens. In case of ambigous names the first match is returned and identity is
// preferred over alias.
func (config *Config) Garden(name string) (*Garden, error) {
var gardenConfig *Garden
var firstMatchByAlias *Garden

for idx := range config.Gardens {
cfg := &config.Gardens[idx]
if name == cfg.Name || name == cfg.Alias {
if name == cfg.Name {
return cfg, nil
} else if firstMatchByAlias == nil && name == cfg.Alias {
firstMatchByAlias = cfg
}
}

if gardenConfig == nil {
return nil, fmt.Errorf("garden %q is not defined in gardenctl configuration", name)
if firstMatchByAlias != nil {
return firstMatchByAlias, nil
}

return gardenConfig, nil
return nil, fmt.Errorf("garden %q is not defined in gardenctl configuration", name)
}

// ClientConfig returns a deferred loading client config for a configured garden cluster.
Expand Down
7 changes: 6 additions & 1 deletion pkg/target/manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,12 @@ func newGardenClient(name string, config *config.Config, provider ClientProvider
return nil, err
}

return gardenclient.NewGardenClient(client, name), nil
garden, err := config.Garden(name)
if err != nil {
return nil, err
}

return gardenclient.NewGardenClient(client, garden.Name), nil
}

// NewManager returns a new manager.
Expand Down