[Feature] [Platform] Improve CLI Values (#1891)

ajanikow · web-flow · commit b7ae7e99765e · 2025-05-13T15:48:54.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 - (Feature) (Platform) Reorganize Envoy Auth
 - (Feature) Ensure Group Service Type
 - (Maintenance) Fix Helm & JWT CVE's
+- (Feature) (Platform) Improve CLI Values
 
 ## [1.2.48](https://github.com/arangodb/kube-arangodb/tree/1.2.48) (2025-05-08)
 - (Maintenance) Extend Documentation
diff --git a/docs/cli/arangodb_operator_platform.md b/docs/cli/arangodb_operator_platform.md
@@ -40,9 +40,8 @@ Available Commands:
   status      Describes Charts Status
 
 Flags:
-  -h, --help                    help for registry
-      --platform.name string    Kubernetes Platform Name (name of the ArangoDeployment)
-      --platform.stage string   Platform Stage Name (default "dev")
+  -h, --help                   help for registry
+      --platform.name string   Kubernetes Platform Name (name of the ArangoDeployment)
 
 Global Flags:
   -n, --namespace string   Kubernetes Namespace (default "default")
@@ -61,12 +60,11 @@ Usage:
   arangodb_operator_platform registry install [flags] [...charts]
 
 Flags:
-  -a, --all                     Runs on all items
-  -h, --help                    help for install
-  -o, --output string           Output format. Allowed table, json, yaml (default "table")
-      --platform.name string    Kubernetes Platform Name (name of the ArangoDeployment)
-      --platform.stage string   Platform Stage Name (default "dev")
-  -u, --upgrade                 Enable upgrade procedure
+  -a, --all                    Runs on all items
+  -h, --help                   help for install
+  -o, --output string          Output format. Allowed table, json, yaml (default "table")
+      --platform.name string   Kubernetes Platform Name (name of the ArangoDeployment)
+  -u, --upgrade                Enable upgrade procedure
 
 Global Flags:
   -n, --namespace string   Kubernetes Namespace (default "default")
@@ -83,10 +81,9 @@ Usage:
   arangodb_operator_platform registry status [flags]
 
 Flags:
-  -h, --help                    help for status
-  -o, --output string           Output format. Allowed table, json, yaml (default "table")
-      --platform.name string    Kubernetes Platform Name (name of the ArangoDeployment)
-      --platform.stage string   Platform Stage Name (default "dev")
+  -h, --help                   help for status
+  -o, --output string          Output format. Allowed table, json, yaml (default "table")
+      --platform.name string   Kubernetes Platform Name (name of the ArangoDeployment)
 
 Global Flags:
   -n, --namespace string   Kubernetes Namespace (default "default")
@@ -108,9 +105,8 @@ Available Commands:
   status         Shows Service Status
 
 Flags:
-  -h, --help                    help for service
-      --platform.name string    Kubernetes Platform Name (name of the ArangoDeployment)
-      --platform.stage string   Platform Stage Name (default "dev")
+  -h, --help                   help for service
+      --platform.name string   Kubernetes Platform Name (name of the ArangoDeployment)
 
 Global Flags:
   -n, --namespace string   Kubernetes Namespace (default "default")
@@ -129,10 +125,9 @@ Usage:
   arangodb_operator_platform service enable [flags] deployment name chart
 
 Flags:
-  -h, --help                    help for enable
-      --platform.name string    Kubernetes Platform Name (name of the ArangoDeployment)
-      --platform.stage string   Platform Stage Name (default "dev")
-  -f, --values strings          Chart values
+  -h, --help                   help for enable
+      --platform.name string   Kubernetes Platform Name (name of the ArangoDeployment)
+  -f, --values strings         Chart values
 
 Global Flags:
   -n, --namespace string   Kubernetes Namespace (default "default")
@@ -149,10 +144,9 @@ Usage:
   arangodb_operator_platform service enable-service [flags] deployment chart
 
 Flags:
-  -h, --help                    help for enable-service
-      --platform.name string    Kubernetes Platform Name (name of the ArangoDeployment)
-      --platform.stage string   Platform Stage Name (default "dev")
-  -f, --values strings          Chart values
+  -h, --help                   help for enable-service
+      --platform.name string   Kubernetes Platform Name (name of the ArangoDeployment)
+  -f, --values strings         Chart values
 
 Global Flags:
   -n, --namespace string   Kubernetes Namespace (default "default")
@@ -169,10 +163,9 @@ Usage:
   arangodb_operator_platform service status [flags] deployment
 
 Flags:
-  -h, --help                    help for status
-  -o, --output string           Output format. Allowed table, json, yaml (default "table")
-      --platform.name string    Kubernetes Platform Name (name of the ArangoDeployment)
-      --platform.stage string   Platform Stage Name (default "dev")
+  -h, --help                   help for status
+  -o, --output string          Output format. Allowed table, json, yaml (default "table")
+      --platform.name string   Kubernetes Platform Name (name of the ArangoDeployment)
 
 Global Flags:
   -n, --namespace string   Kubernetes Namespace (default "default")
@@ -231,8 +224,7 @@ Usage:
   arangodb_operator_platform package install [flags] deployment package
 
 Flags:
-  -h, --help                    help for install
-      --platform.stage string   Platform Stage Name (default "dev")
+  -h, --help   help for install
 
 Global Flags:
   -n, --namespace string       Kubernetes Namespace (default "default")
diff --git a/pkg/platform/chart_manager.go b/pkg/platform/chart_manager.go
@@ -21,7 +21,6 @@
 package platform
 
 import (
-	"fmt"
 	goHttp "net/http"
 
 	"github.com/spf13/cobra"
@@ -35,10 +34,5 @@ func getChartManager(cmd *cobra.Command) (helm.ChartManager, error) {
 		return nil, err
 	}
 
-	stage, err := flagPlatformStage.Get(cmd)
-	if err != nil {
-		return nil, err
-	}
-
-	return helm.NewChartManager(cmd.Context(), goHttp.DefaultClient, "%s/index.yaml", fmt.Sprintf(endpoint, stage))
+	return helm.NewChartManager(cmd.Context(), goHttp.DefaultClient, "%s/index.yaml", endpoint)
 }
diff --git a/pkg/platform/flags.go b/pkg/platform/flags.go
@@ -60,25 +60,10 @@ var (
 		},
 	}
 
-	flagPlatformStage = cli.Flag[string]{
-		Name:        "platform.stage",
-		Description: "Platform Stage Name",
-		Default:     "dev",
-		Persistent:  true,
-		Check: func(in string) error {
-			switch in {
-			case "prd", "dev":
-				return nil
-			}
-
-			return errors.Errorf("Unsupported Platform Stage: %s", in)
-		},
-	}
-
 	flagPlatformEndpoint = cli.Flag[string]{
 		Name:        "platform.endpoint",
 		Description: "Platform Repository URL",
-		Default:     "https://arangodb-platform-%s-chart-registry.s3.amazonaws.com",
+		Default:     "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com",
 		Persistent:  true,
 		Hidden:      true,
 	}
diff --git a/pkg/platform/package_install.go b/pkg/platform/package_install.go
@@ -44,7 +44,7 @@ func packageInstall() (*cobra.Command, error) {
 	cmd.Use = "install [flags] deployment package"
 	cmd.Short = "Installs the specified setup of the platform"
 
-	if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint); err != nil {
+	if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint); err != nil {
 		return nil, err
 	}
 
@@ -153,6 +153,12 @@ func packageInstallRun(cmd *cobra.Command, args []string) error {
 	}
 	logger.Str("uid", string(deploymentObject.GetUID())).Info("ArangoDeployment Found")
 
+	gv, err := r.Overrides.Marshal()
+	if err != nil {
+		logger.Err(err).Error("Unable to unmarshal values")
+		return err
+	}
+
 	for name, release := range r.Releases {
 		ov, err := release.Overrides.Marshal()
 		if err != nil {
@@ -166,9 +172,7 @@ func packageInstallRun(cmd *cobra.Command, args []string) error {
 					"name": deployment,
 				},
 			},
-		},
-
-			ov)
+		}, gv, ov)
 		if err != nil {
 			return errors.Wrapf(err, "Unable to build helm data")
 		}
diff --git a/pkg/platform/registry.go b/pkg/platform/registry.go
@@ -32,7 +32,7 @@ func registry() (*cobra.Command, error) {
 	cmd.Use = "registry"
 	cmd.Short = "Registry related operations"
 
-	if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName); err != nil {
+	if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName); err != nil {
 		return nil, err
 	}
 
diff --git a/pkg/platform/registry_install.go b/pkg/platform/registry_install.go
@@ -45,7 +45,7 @@ func registryInstall() (*cobra.Command, error) {
 	cmd.Use = "install [flags] [...charts]"
 	cmd.Short = "Manages the Chart Installation"
 
-	if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName, flagOutput, flagUpgradeVersions, flagAll); err != nil {
+	if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName, flagOutput, flagUpgradeVersions, flagAll); err != nil {
 		return nil, err
 	}
 
diff --git a/pkg/platform/registry_status.go b/pkg/platform/registry_status.go
@@ -45,7 +45,7 @@ func registryStatus() (*cobra.Command, error) {
 	cmd.Use = "status"
 	cmd.Short = "Describes Charts Status"
 
-	if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName, flagOutput); err != nil {
+	if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName, flagOutput); err != nil {
 		return nil, err
 	}
 
diff --git a/pkg/platform/runner.go b/pkg/platform/runner.go
@@ -31,7 +31,6 @@ func getRunner() cli.Runner {
 		cli.ValidateFlags(
 			flagNamespace,
 			flagPlatformName,
-			flagPlatformStage,
 			flagPlatformEndpoint,
 			flagOutput,
 			flagUpgradeVersions,
diff --git a/pkg/platform/service.go b/pkg/platform/service.go
@@ -32,7 +32,7 @@ func service() (*cobra.Command, error) {
 	cmd.Use = "service"
 	cmd.Short = "Service related operations"
 
-	if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName); err != nil {
+	if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName); err != nil {
 		return nil, err
 	}
 
diff --git a/pkg/platform/service_enable.go b/pkg/platform/service_enable.go
@@ -42,7 +42,7 @@ func serviceEnable() (*cobra.Command, error) {
 	cmd.Use = "enable [flags] deployment name chart"
 	cmd.Short = "Manages Service Installation/Management"
 
-	if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName, flagValues); err != nil {
+	if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName, flagValues); err != nil {
 		return nil, err
 	}
 
diff --git a/pkg/platform/service_enable_service.go b/pkg/platform/service_enable_service.go
@@ -42,7 +42,7 @@ func serviceEnableService() (*cobra.Command, error) {
 	cmd.Use = "enable-service [flags] deployment chart"
 	cmd.Short = "Manages Service Installation/Management"
 
-	if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName, flagValues); err != nil {
+	if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName, flagValues); err != nil {
 		return nil, err
 	}
 
diff --git a/pkg/platform/service_status.go b/pkg/platform/service_status.go
@@ -44,7 +44,7 @@ func serviceStatus() (*cobra.Command, error) {
 	cmd.Use = "status [flags] deployment"
 	cmd.Short = "Shows Service Status"
 
-	if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName, flagOutput); err != nil {
+	if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName, flagOutput); err != nil {
 		return nil, err
 	}
 
diff --git a/pkg/util/k8sutil/helm/package.go b/pkg/util/k8sutil/helm/package.go
@@ -36,6 +36,8 @@ type Package struct {
 	Packages map[string]string `json:"packages,omitempty"`
 
 	Releases map[string]PackageRelease `json:"releases,omitempty"`
+
+	Overrides Values `json:"overrides,omitempty"`
 }
 
 type PackageRelease struct {
diff --git a/pkg/util/k8sutil/helm/values.go b/pkg/util/k8sutil/helm/values.go
@@ -82,6 +82,16 @@ func (v Values) Equals(other Values) bool {
 	return util.SHA256(a) == util.SHA256(b)
 }
 
+func (v *Values) UnmarshalJSON(in []byte) error {
+	q := make(Values, len(in))
+
+	copy(q, in)
+
+	*v = q
+
+	return nil
+}
+
 func (v Values) MarshalJSON() ([]byte, error) {
 	return v, nil
 }

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func registry() (*cobra.Command, error) {`
`32`	`32`	`cmd.Use = "registry"`
`33`	`33`	`cmd.Short = "Registry related operations"`
`34`	`34`
`35`		`- if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName); err != nil {`
	`35`	`+ if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName); err != nil {`
`36`	`36`	`return nil, err`
`37`	`37`	`}`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ func registryInstall() (*cobra.Command, error) {`
`45`	`45`	`cmd.Use = "install [flags] [...charts]"`
`46`	`46`	`cmd.Short = "Manages the Chart Installation"`
`47`	`47`
`48`		`- if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName, flagOutput, flagUpgradeVersions, flagAll); err != nil {`
	`48`	`+ if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName, flagOutput, flagUpgradeVersions, flagAll); err != nil {`
`49`	`49`	`return nil, err`
`50`	`50`	`}`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ func registryStatus() (*cobra.Command, error) {`
`45`	`45`	`cmd.Use = "status"`
`46`	`46`	`cmd.Short = "Describes Charts Status"`
`47`	`47`
`48`		`- if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName, flagOutput); err != nil {`
	`48`	`+ if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName, flagOutput); err != nil {`
`49`	`49`	`return nil, err`
`50`	`50`	`}`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func service() (*cobra.Command, error) {`
`32`	`32`	`cmd.Use = "service"`
`33`	`33`	`cmd.Short = "Service related operations"`
`34`	`34`
`35`		`- if err := cli.RegisterFlags(&cmd, flagPlatformStage, flagPlatformEndpoint, flagPlatformName); err != nil {`
	`35`	`+ if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint, flagPlatformName); err != nil {`
`36`	`36`	`return nil, err`
`37`	`37`	`}`
`38`	`38`