✨ add --bundle-version-overrides flag; update default bundle to OCM v0.16.1 (#488)

TylerGillson · web-flow · commit 63858211ad7d · 2025-05-29T01:54:02.000Z
* chore: support v0.16.1 bundle

Signed-off-by: Tyler Gillson &lt;tyler.gillson@gmail.com&gt;

* feat: configurable version bundle

Signed-off-by: Tyler Gillson &lt;tyler.gillson@gmail.com&gt;

* refactor: override component versions

Signed-off-by: Tyler Gillson &lt;tyler.gillson@gmail.com&gt;

* chore: minimize diff

Signed-off-by: Tyler Gillson &lt;tyler.gillson@gmail.com&gt;

* chore: add unit tests

Signed-off-by: Tyler Gillson &lt;tyler.gillson@gmail.com&gt;

---------

Signed-off-by: Tyler Gillson &lt;tyler.gillson@gmail.com&gt;
diff --git a/README.md b/README.md
@@ -146,3 +146,28 @@ Enable specific add-on(s) agent deployment to the given managed clusters of the
 Create and deploy a sample Argo CD ApplicationSet
 
 `clusteradm create sampleapp sample-appset`
+
+## Version Bundles
+
+By default, clusteradm uses a built-in version bundle that defines the versions of all OCM components to be installed. You can request a specific version bundle using the `--bundle-version` flag. You can override individual component versions within the selected version bundle using the `--bundle-version-overrides` flag:
+
+```bash
+# Override component versions within the default version bundle:
+clusteradm init --bundle-version-overrides /path/to/bundle-overrides.json
+
+# Override component versions within a specific version bundle:
+clusteradm init --bundle-version v0.16.0 --bundle-version-overrides /path/to/bundle-overrides.json
+```
+
+The version bundle override file must be a JSON file containing one or more OCM component versions. Example:
+
+```json
+{
+  "ocm": "v0.16.1",
+  "app_addon": "v0.16.0",
+  "policy_addon": "v0.16.0",
+  "multicluster_controlplane": "v0.7.0"
+}
+```
+
+This is useful when you need to use specific versions of components or when working with custom builds.
diff --git a/pkg/cmd/init/cmd.go b/pkg/cmd/init/cmd.go
@@ -74,9 +74,12 @@ func NewCmd(clusteradmFlags *genericclioptionsclusteradm.ClusteradmFlags, stream
 		"The credential file is the docker config json file and will be filled into the default image pull secret named open-cluster-management-image-pull-credentials.")
 	cmd.Flags().StringVar(&o.bundleVersion, "bundle-version", "default",
 		"The version of predefined compatible image versions (e.g. v0.6.0). Defaults to the latest released version. You can also set \"latest\" to install the latest development version.")
+	cmd.Flags().StringVar(&o.versionBundleFile, "bundle-version-overrides", "",
+		"Path to a file containing version bundle overrides. Optional. If provided, overrides component versions within the selected version bundle.")
 	clusterManagerSet.BoolVar(&o.useBootstrapToken, "use-bootstrap-token", false, "If set then the bootstrap token will used instead of a service account token")
 	_ = clusterManagerSet.SetAnnotation("image-registry", "clusterManagerSet", []string{})
 	_ = clusterManagerSet.SetAnnotation("bundle-version", "clusterManagerSet", []string{})
+	_ = clusterManagerSet.SetAnnotation("bundle-version-file", "clusterManagerSet", []string{})
 	_ = clusterManagerSet.SetAnnotation("use-bootstrap-token", "clusterManagerSet", []string{})
 	cmd.Flags().AddFlagSet(clusterManagerSet)
 
diff --git a/pkg/cmd/init/exec.go b/pkg/cmd/init/exec.go
@@ -59,7 +59,7 @@ func (o *Options) complete(cmd *cobra.Command, args []string) (err error) {
 		}
 	})
 
-	bundleVersion, err := version.GetVersionBundle(o.bundleVersion)
+	bundleVersion, err := version.GetVersionBundle(o.bundleVersion, o.versionBundleFile)
 	if err != nil {
 		return err
 	}
diff --git a/pkg/cmd/init/options.go b/pkg/cmd/init/options.go
@@ -28,6 +28,8 @@ type Options struct {
 
 	// version of predefined compatible image versions
 	bundleVersion string
+	// Path to a file containing version bundle configuration
+	versionBundleFile string
 
 	// If set, deploy the singleton controlplane
 	singleton     bool
diff --git a/pkg/cmd/install/hubaddon/cmd.go b/pkg/cmd/install/hubaddon/cmd.go
@@ -53,6 +53,8 @@ func NewCmd(clusteradmFlags *genericclioptionsclusteradm.ClusteradmFlags, stream
 	cmd.Flags().StringVar(&o.outputFile, "output-file", "", "The generated resources will be copied in the specified file")
 	cmd.Flags().StringVar(&o.bundleVersion, "bundle-version", "default",
 		"The image version tag to use when deploying the hub add-on(s) (e.g. v0.6.0). Defaults to the latest released version. You can also set \"latest\" to install the latest development version.")
+	cmd.Flags().StringVar(&o.versionBundleFile, "bundle-version-overrides", "",
+		"Path to a file containing version bundle overrides. Optional. If provided, overrides component versions within the selected version bundle.")
 
 	return cmd
 }
diff --git a/pkg/cmd/install/hubaddon/exec.go b/pkg/cmd/install/hubaddon/exec.go
@@ -52,7 +52,7 @@ func (o *Options) validate() (err error) {
 		}
 	}
 
-	versionBundle, err := version.GetVersionBundle(o.bundleVersion)
+	versionBundle, err := version.GetVersionBundle(o.bundleVersion, o.versionBundleFile)
 	if err != nil {
 		return err
 	}
diff --git a/pkg/cmd/install/hubaddon/exec_test.go b/pkg/cmd/install/hubaddon/exec_test.go
@@ -41,7 +41,7 @@ var _ = ginkgo.Describe("install hub-addon", func() {
 		}
 
 		var err error
-		ocmBundleVersion, err = version.GetVersionBundle(ocmVersion)
+		ocmBundleVersion, err = version.GetVersionBundle(ocmVersion, "")
 		gomega.Expect(err).ToNot(gomega.HaveOccurred())
 	})
 
diff --git a/pkg/cmd/install/hubaddon/options.go b/pkg/cmd/install/hubaddon/options.go
@@ -17,6 +17,8 @@ type Options struct {
 	outputFile    string
 	values        scenario.Values
 	bundleVersion string
+	// Path to a file containing version bundle configuration
+	versionBundleFile string
 
 	Streams genericiooptions.IOStreams
 
diff --git a/pkg/cmd/join/cmd.go b/pkg/cmd/join/cmd.go
@@ -63,6 +63,8 @@ func NewCmd(clusteradmFlags *genericclioptionsclusteradm.ClusteradmFlags, stream
 		"The credential file is the docker config json file and will be filled into the default image pull secret named open-cluster-management-image-pull-credentials.")
 	cmd.Flags().StringVar(&o.bundleVersion, "bundle-version", "default",
 		"The version of predefined compatible image versions (e.g. v0.6.0). Defaults to the latest released version. You can also set \"latest\" to install the latest development version.")
+	cmd.Flags().StringVar(&o.versionBundleFile, "bundle-version-overrides", "",
+		"Path to a file containing version bundle overrides. Optional. If provided, overrides component versions within the selected version bundle.")
 	cmd.Flags().BoolVar(&o.forceHubInClusterEndpointLookup, "force-internal-endpoint-lookup", false,
 		"If true, the installed klusterlet agent will be starting the cluster registration process by "+
 			"looking for the internal endpoint from the public cluster-info in the hub cluster instead of from --hub-apiserver.")
diff --git a/pkg/cmd/join/exec.go b/pkg/cmd/join/exec.go
@@ -96,7 +96,7 @@ func (o *Options) complete(cmd *cobra.Command, args []string) (err error) {
 		ClusterName: o.clusterName,
 	}
 
-	bundleVersion, err := version.GetVersionBundle(o.bundleVersion)
+	bundleVersion, err := version.GetVersionBundle(o.bundleVersion, o.versionBundleFile)
 	if err != nil {
 		return err
 	}
diff --git a/pkg/cmd/join/options.go b/pkg/cmd/join/options.go
@@ -37,6 +37,8 @@ type Options struct {
 
 	// version of predefined compatible image versions
 	bundleVersion string
+	// Path to a file containing version bundle configuration
+	versionBundleFile string
 
 	// if set, deploy the singleton agent rather than klusterlet
 	singleton bool
diff --git a/pkg/cmd/uninstall/hubaddon/exec.go b/pkg/cmd/uninstall/hubaddon/exec.go
@@ -23,7 +23,7 @@ var (
 	policyFrameworkAddonName = "governance-policy-framework"
 )
 
-func (o *Options) complete(cmd *cobra.Command, args []string) (err error) {
+func (o *Options) complete(_ *cobra.Command, _ []string) (err error) {
 	klog.V(1).InfoS("addon options:", "dry-run", o.ClusteradmFlags.DryRun, "names", o.names)
 	return nil
 }
@@ -77,7 +77,7 @@ func (o *Options) run() error {
 	o.values.HubAddons = addons
 	// this needs to be set to render the manifests, but the version value
 	// does not matter.
-	o.values.BundleVersion, _ = version.GetVersionBundle("default")
+	o.values.BundleVersion, _ = version.GetVersionBundle("default", "")
 
 	klog.V(3).InfoS("values:", "addon", o.values.HubAddons)
 
diff --git a/pkg/cmd/upgrade/clustermanager/cmd.go b/pkg/cmd/upgrade/clustermanager/cmd.go
@@ -47,6 +47,8 @@ func NewCmd(clusteradmFlags *genericclioptionsclusteradm.ClusteradmFlags, stream
 		"The name of the image registry serving OCM images, which will be applied to all the deploying OCM components.")
 	cmd.Flags().StringVar(&o.bundleVersion, "bundle-version", "default",
 		"The version of predefined compatible image versions (e.g. v0.6.0). Defaults to the latest released version. You can also set \"latest\" to install the latest development version.")
+	cmd.Flags().StringVar(&o.versionBundleFile, "bundle-version-overrides", "",
+		"Path to a file containing version bundle overrides. Optional. If provided, overrides component versions within the selected version bundle.")
 	cmd.Flags().BoolVar(&o.wait, "wait", false,
 		"If set, the command will initialize the OCM control plan in foreground.")
 	return cmd
diff --git a/pkg/cmd/upgrade/clustermanager/exec.go b/pkg/cmd/upgrade/clustermanager/exec.go
@@ -18,7 +18,7 @@ import (
 	"open-cluster-management.io/clusteradm/pkg/helpers/wait"
 )
 
-func (o *Options) complete(cmd *cobra.Command, args []string) (err error) {
+func (o *Options) complete(_ *cobra.Command, _ []string) (err error) {
 	klog.V(1).InfoS("init options:", "dry-run", o.ClusteradmFlags.DryRun)
 
 	f := o.ClusteradmFlags.KubectlFactory
@@ -39,7 +39,7 @@ func (o *Options) complete(cmd *cobra.Command, args []string) (err error) {
 		return err
 	}
 
-	bundleVersion, err := version.GetVersionBundle(o.bundleVersion)
+	bundleVersion, err := version.GetVersionBundle(o.bundleVersion, o.versionBundleFile)
 	if err != nil {
 		return err
 	}
diff --git a/pkg/cmd/upgrade/clustermanager/options.go b/pkg/cmd/upgrade/clustermanager/options.go
@@ -17,6 +17,8 @@ type Options struct {
 	registry string
 	//version of predefined compatible image versions
 	bundleVersion string
+	// Path to a file containing version bundle configuration
+	versionBundleFile string
 	//If set, the command will hold until the OCM control plane initialized
 	wait bool
 
diff --git a/pkg/cmd/upgrade/klusterlet/cmd.go b/pkg/cmd/upgrade/klusterlet/cmd.go
@@ -47,6 +47,8 @@ func NewCmd(clusteradmFlags *genericclioptionsclusteradm.ClusteradmFlags, stream
 		"The name of the image registry serving OCM images, which will be applied to all the deploying OCM components.")
 	cmd.Flags().StringVar(&o.bundleVersion, "bundle-version", "default",
 		"The version of predefined compatible image versions (e.g. v0.6.0). Defaults to the latest released version. You can also set \"latest\" to install the latest development version.")
+	cmd.Flags().StringVar(&o.versionBundleFile, "bundle-version-overrides", "",
+		"Path to a file containing version bundle overrides. Optional. If provided, overrides component versions within the selected version bundle.")
 	cmd.Flags().BoolVar(&o.wait, "wait", false,
 		"If set, the command will initialize the OCM control plan in foreground.")
 	return cmd
diff --git a/pkg/cmd/upgrade/klusterlet/exec.go b/pkg/cmd/upgrade/klusterlet/exec.go
@@ -44,7 +44,7 @@ func (o *Options) complete(_ *cobra.Command, _ []string) (err error) {
 		return err
 	}
 
-	bundleVersion, err := version.GetVersionBundle(o.bundleVersion)
+	bundleVersion, err := version.GetVersionBundle(o.bundleVersion, o.versionBundleFile)
 	if err != nil {
 		return err
 	}
diff --git a/pkg/cmd/upgrade/klusterlet/options.go b/pkg/cmd/upgrade/klusterlet/options.go
@@ -18,6 +18,8 @@ type Options struct {
 	registry string
 	//version of predefined compatible image versions
 	bundleVersion string
+	// Path to a file containing version bundle configuration
+	versionBundleFile string
 	//If set, the command will hold until the OCM control plane initialized
 	wait bool
 
diff --git a/pkg/version/testdata/bundle-overrides.json b/pkg/version/testdata/bundle-overrides.json
@@ -0,0 +1,3 @@
+{
+    "ocm": "v0.16.1"
+}
diff --git a/pkg/version/version.go b/pkg/version/version.go
@@ -2,10 +2,13 @@
 package version
 
 import (
+	"encoding/json"
 	"fmt"
+	"os"
 	"strings"
 
 	"k8s.io/apimachinery/pkg/version"
+	"k8s.io/klog/v2"
 )
 
 var (
@@ -36,19 +39,36 @@ func Get() version.Info {
 }
 
 type VersionBundle struct {
-	OCM                      string
-	AppAddon                 string
-	PolicyAddon              string
-	MulticlusterControlplane string
+	OCM                      string `json:"ocm"`
+	AppAddon                 string `json:"app_addon"`
+	PolicyAddon              string `json:"policy_addon"`
+	MulticlusterControlplane string `json:"multicluster_controlplane"`
 }
 
-var defaultBundleVersion = "0.16.0"
+var defaultBundleVersion = "0.16.1"
 
 func GetDefaultBundleVersion() string {
 	return defaultBundleVersion
 }
 
-func GetVersionBundle(version string) (VersionBundle, error) {
+// GetVersionBundle returns a version bundle for the requested version and optional overrides.
+func GetVersionBundle(version string, versionBundleFile string) (VersionBundle, error) {
+	bundle, err := getVersionBundle(version)
+	if err != nil {
+		return VersionBundle{}, err
+	}
+
+	if versionBundleFile != "" {
+		bundle, err = overrideVersionBundle(bundle, versionBundleFile)
+		if err != nil {
+			return VersionBundle{}, err
+		}
+	}
+
+	return bundle, nil
+}
+
+func getVersionBundle(version string) (VersionBundle, error) {
 
 	// supporting either "x.y.z" or "vx.y.z" format version
 	version = strings.TrimPrefix(version, "v")
@@ -93,6 +113,13 @@ func GetVersionBundle(version string) (VersionBundle, error) {
 		MulticlusterControlplane: "v0.7.0",
 	}
 
+	versionBundleList["0.16.1"] = VersionBundle{
+		OCM:                      "v0.16.1",
+		AppAddon:                 "v0.16.0",
+		PolicyAddon:              "v0.16.0",
+		MulticlusterControlplane: "v0.7.0",
+	}
+
 	// default
 	versionBundleList["default"] = versionBundleList[defaultBundleVersion]
 
@@ -101,3 +128,16 @@ func GetVersionBundle(version string) (VersionBundle, error) {
 	}
 	return VersionBundle{}, fmt.Errorf("couldn't find the requested version bundle: %v", version)
 }
+
+func overrideVersionBundle(bundle VersionBundle, filePath string) (VersionBundle, error) {
+	data, err := os.ReadFile(filePath)
+	if err != nil {
+		return VersionBundle{}, fmt.Errorf("failed to read version bundle file: %w", err)
+	}
+	if err := json.Unmarshal(data, &bundle); err != nil {
+		return VersionBundle{}, fmt.Errorf("failed to unmarshal version bundle: %w", err)
+	}
+
+	klog.V(3).InfoS("applied overrides to version bundle", "finalBundle", bundle)
+	return bundle, nil
+}
diff --git a/pkg/version/version_test.go b/pkg/version/version_test.go
@@ -0,0 +1,60 @@
+// Copyright Contributors to the Open Cluster Management project
+package version
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestGetVersionBundle(t *testing.T) {
+	expectedVersionBundle := VersionBundle{
+		OCM:                      "v0.16.1",
+		AppAddon:                 "v0.16.0",
+		PolicyAddon:              "v0.16.0",
+		MulticlusterControlplane: "v0.7.0",
+	}
+
+	tests := []struct {
+		name                  string
+		version               string
+		versionBundleFile     string
+		expectedVersionBundle func() VersionBundle
+		wantErr               bool
+	}{
+		{
+			name:                  "default",
+			version:               "default",
+			versionBundleFile:     "",
+			expectedVersionBundle: func() VersionBundle { return expectedVersionBundle },
+		},
+		{
+			name:              "specific version",
+			version:           "v0.16.0",
+			versionBundleFile: "",
+			expectedVersionBundle: func() VersionBundle {
+				b := expectedVersionBundle
+				b.OCM = "v0.16.0"
+				return b
+			},
+		},
+		{
+			name:                  "override",
+			version:               "v0.16.0",
+			versionBundleFile:     "testdata/bundle-overrides.json",
+			expectedVersionBundle: func() VersionBundle { return expectedVersionBundle },
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			bundle, err := GetVersionBundle(test.version, test.versionBundleFile)
+			if (err != nil) != test.wantErr {
+				t.Errorf("GetVersionBundle() error = %v, wantErr %v", err, test.wantErr)
+			}
+			expected := test.expectedVersionBundle()
+			if !reflect.DeepEqual(bundle, expected) {
+				t.Errorf("GetVersionBundle() = %v, want %v", bundle, expected)
+			}
+		})
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ func (o Options) complete(cmd cobra.Command, args []string) (err error) {`
`59`	`59`	`}`
`60`	`60`	`})`
`61`	`61`
`62`		`- bundleVersion, err := version.GetVersionBundle(o.bundleVersion)`
	`62`	`+ bundleVersion, err := version.GetVersionBundle(o.bundleVersion, o.versionBundleFile)`
`63`	`63`	`if err != nil {`
`64`	`64`	`return err`
`65`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,8 @@ func NewCmd(clusteradmFlags *genericclioptionsclusteradm.ClusteradmFlags, stream`
`53`	`53`	`cmd.Flags().StringVar(&o.outputFile, "output-file", "", "The generated resources will be copied in the specified file")`
`54`	`54`	`cmd.Flags().StringVar(&o.bundleVersion, "bundle-version", "default",`
`55`	`55`	`"The image version tag to use when deploying the hub add-on(s) (e.g. v0.6.0). Defaults to the latest released version. You can also set \"latest\" to install the latest development version.")`
	`56`	`+ cmd.Flags().StringVar(&o.versionBundleFile, "bundle-version-overrides", "",`
	`57`	`+ "Path to a file containing version bundle overrides. Optional. If provided, overrides component versions within the selected version bundle.")`
`56`	`58`
`57`	`59`	`return cmd`
`58`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ func (o *Options) validate() (err error) {`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`
`55`		`- versionBundle, err := version.GetVersionBundle(o.bundleVersion)`
	`55`	`+ versionBundle, err := version.GetVersionBundle(o.bundleVersion, o.versionBundleFile)`
`56`	`56`	`if err != nil {`
`57`	`57`	`return err`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ var _ = ginkgo.Describe("install hub-addon", func() {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`var err error`
`44`		`- ocmBundleVersion, err = version.GetVersionBundle(ocmVersion)`
	`44`	`+ ocmBundleVersion, err = version.GetVersionBundle(ocmVersion, "")`
`45`	`45`	`gomega.Expect(err).ToNot(gomega.HaveOccurred())`
`46`	`46`	`})`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ func (o Options) complete(cmd cobra.Command, args []string) (err error) {`
`96`	`96`	`ClusterName: o.clusterName,`
`97`	`97`	`}`
`98`	`98`
`99`		`- bundleVersion, err := version.GetVersionBundle(o.bundleVersion)`
	`99`	`+ bundleVersion, err := version.GetVersionBundle(o.bundleVersion, o.versionBundleFile)`
`100`	`100`	`if err != nil {`
`101`	`101`	`return err`
`102`	`102`	`}`