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

Helm values files for CLI #1974

Merged
merged 1 commit into from
Sep 13, 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: 3 additions & 1 deletion cmd/liqoctl/cmd/install.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const liqoctlInstallLongHelp = `Install/upgrade Liqo in the selected cluster.

This command wraps the Helm command to install/upgrade Liqo in the selected
cluster, appropriately configuring it based on the provided flags. Additional
default values can be overridden through the --set flag.
default values can be overridden through the --values and or --set flag.
Alternatively, it can be configured to only output a pre-configured values file,
which can be further customized and used for a manual installation with Helm.

Expand Down Expand Up @@ -160,6 +160,8 @@ func newInstallCommand(ctx context.Context, f *factory.Factory) *cobra.Command {
// Using StringArray rather than StringSlice: splitting is left to the Helm library, which takes care of special cases (e.g., lists).
cmd.PersistentFlags().StringArrayVar(&options.OverrideValues, "set", []string{},
"Set additional values on the command line (can specify multiple times or separate values with commas: key1=val1,key2=val2)")
cmd.PersistentFlags().StringArrayVar(&options.OverrideValuesFiles, "values", []string{},
"Specify values in a YAML file or a URL (can specify multiple)")
cmd.PersistentFlags().BoolVar(&options.DisableAPIServerSanityChecks, "disable-api-server-sanity-check", false,
"Disable the sanity checks concerning the retrieved Kubernetes API server URL (default false)")
cmd.PersistentFlags().BoolVar(&options.SkipValidation, "skip-validation", false, "Skip the validation of the arguments "+
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,12 +413,12 @@ To change this behavior, check the [network flags](NetworkFlags).
## Customization options

This section lists the main **customization parameters** supported by the *liqoctl install* command, along with a brief description.
Additionally, **all parameters** available in the Helm *values* file (the full list is provided in the dedicated [repository page](https://github.com/liqotech/liqo/tree/master/deployments/liqo)) can be modified through the `liqoctl install --set` flag, which supports the standard Helm syntax.
Additionally, **all parameters** available in the Helm *values* file (the full list is provided in the dedicated [repository page](https://github.com/liqotech/liqo/tree/master/deployments/liqo)) can be modified through the `liqoctl install --values` and or `liqoctl install --set` flags, which supports the standard Helm syntax.

Finally, remember that:

* You can type `liqoctl install --help` to get the list of available options.
* Some of the above parameters can be changed after installation by simply updating their value and re-applying the Helm chart, or by re-issuing the proper `liqoctl install --set [param=value]` command. However, given that not all parameters can be updated at run-time, please check that the command triggered the desired effect; a precise list of commands that can be changed at run-time is left for our future work.
* Some of the above parameters can be changed after installation by simply updating their value and re-applying the Helm chart, or by re-issuing the proper `liqoctl install --values [file] --set [param=value]` command. However, given that not all parameters can be updated at run-time, please check that the command triggered the desired effect; a precise list of commands that can be changed at run-time is left for our future work.

### Global

Expand Down
67 changes: 64 additions & 3 deletions pkg/liqoctl/install/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ import (
"context"
"errors"
"fmt"
"io"
"net/url"
"os"
"path/filepath"
"strings"
"time"

Expand All @@ -28,6 +31,8 @@ import (
"golang.org/x/mod/semver"
"gopkg.in/yaml.v3"
"helm.sh/helm/v3/pkg/action"
"helm.sh/helm/v3/pkg/cli"
"helm.sh/helm/v3/pkg/getter"
"helm.sh/helm/v3/pkg/repo"
"helm.sh/helm/v3/pkg/strvals"
corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -66,9 +71,10 @@ type Options struct {
RepoURL string
ChartPath string

OverrideValues []string
chartValues map[string]interface{}
tmpDir string
OverrideValues []string
OverrideValuesFiles []string
chartValues map[string]interface{}
tmpDir string

DryRun bool
OnlyOutputValues bool
Expand Down Expand Up @@ -162,6 +168,17 @@ func (o *Options) Run(ctx context.Context, provider Provider) error {
return err
}

valuesFiles, err := o.valuesFiles()
if err != nil {
s.Fail("Error generating installation parameters: ", output.PrettyErr(err))
return err
}
values, err = util.MergeMaps(values, valuesFiles)
if err != nil {
s.Fail("Error generating installation parameters: ", output.PrettyErr(err))
return err
}

for _, value := range o.OverrideValues {
if err := strvals.ParseInto(value, values); err != nil {
err := fmt.Errorf("failed parsing --set data: %w", err)
Expand Down Expand Up @@ -398,6 +415,50 @@ func (o *Options) postProviderValues() map[string]interface{} {
return values
}

func (o *Options) valuesFiles() (map[string]interface{}, error) {
values := map[string]interface{}{}
// Near copy from Helm https://github.com/helm/helm/blob/eb4edc96c581c1978fe935197e20ced4071af5d5/pkg/cli/values/options.go#L48
for _, filePath := range o.OverrideValuesFiles {
currentMap := map[string]interface{}{}
bytes, err := readFile(filePath, getter.All(cli.New()))
cheina97 marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
return nil, err
}

if err := yaml.Unmarshal(bytes, &currentMap); err != nil {
return nil, err
}
// Merge with the previous map
values, err = util.MergeMaps(currentMap, values)
if err != nil {
return nil, err
}
}
return values, nil
}

// copy from Helm https://github.com/helm/helm/blob/eb4edc96c581c1978fe935197e20ced4071af5d5/pkg/cli/values/options.go#L128
func readFile(filePath string, p getter.Providers) ([]byte, error) {
if strings.TrimSpace(filePath) == "-" {
return io.ReadAll(os.Stdin)
}
u, err := url.Parse(filePath)
if err != nil {
return nil, err
}

// FIXME: maybe someone handle other protocols like ftp.
g, err := p.ByScheme(u.Scheme)
if err != nil {
return os.ReadFile(filepath.Clean(filePath))
}
data, err := g.Get(filePath, getter.WithURL(filePath))
if err != nil {
return nil, err
}
return data.Bytes(), err
}

func (o *Options) cleanup() error {
if o.tmpDir != "" {
return os.RemoveAll(o.tmpDir)
Expand Down