✨ Usage of Extensions #386

rxinui · 2025-06-06T02:10:36Z

Summary

The implementation of Preferences used to be on-the-fly by using corev1.ConfigMap as "k8s.io/client-go/tools/clientcmd/api" requires runtime.Object type for Extension.

In our new implementation, a new file extensions.go is created where structs are defined. This allow us Static typing and check at compilation time, reducing likelihood of errors.

BREAKING CHANGES

Within the code, breaking changes are indicated through comment // BREAKING CHANGE

const (
	ExtensionConfigName                = "config-extension-name"    // BREAKING CHANGE
	ExtensionHostingClusterContextName = "hosting-cluster-ctx-name" // BREAKING CHANGE

Those values have changed. Also, perhaps some of these values are now useless. In fact, all kubeflex metadata are stored under kubeflex key (ie. extensions.kubeflex) therefore ExtensionConfigName seems irrelevant.

Functions defined in pkg/kubeconfig/kubeconfig.go are no longer looking up to preferences.extensions within a Kubeconfig. Thereby, any clients/end-users using kflex version prior this PR has their Kubeconfig populated by Preferences. Once this PR merge to kubestellar/kubeflex, metadata stored under Preferences are ignored (hence become irrelevant) and new metadata will be inserted under extensions and contexts[].extensions. Breaking changes are to be expected for the end user.

Old way:

preferences:
  extensions:
  - extension:
      data:
        kflex-initial-ctx-name: kind-kubeflex    # key=ExtensionHostingClusterContextName
      metadata:
        creationTimestamp: null
        name: kflex-config-extension-name        # value=ExtensionConfigName
    name: kflex-config-extension-name            # value=ExtensionConfigName

New way:

# global
extensions:
- extension:
    data:
      hosting-cluster-ctx-name: kind-kubeflex    # key=ExtensionHostingClusterContextName
    metadata:
      creationTimestamp: null
      name: kubeflex                             # value=ExtensionKubeflexKey
  name: kubeflex                                 # value=ExtensionKubeflexKey
# ...
# context-scope
contexts:
- name: kind-kubeflex
  context:
    cluster: kind-kubeflex
    user: kind-kubeflex
  extensions:
  - extension:
      data:
        first-ctx-name: kind-kubeflex            # key=ExtensionInitialContextName
        is-hosting-cluster-ctx: true             # key=ExtensionContextsIsHostingCluster
      metadata:
        creationTimestamp: null
        name: kubeflex
    name: kubeflex

To alleviate those breaking changes, a follow up PR is to be considerated. The creation of a command kflex config seems ideal where subcommands interact with Kubeconfig. For instance, to help the transition to this breaking changes, we can imagine:

kflex config tidy to migrate/clean-up a kubeconfig to adapt with kubeflex latest changes.

Related issue(s)

Fixes #385

- new: implement KubeflexConfig Signed-off-by: rxinui <rainui.ly@gmail.com>

Signed-off-by: rxinui <rainui.ly@gmail.com>

- new: kubeconfig extensions funcs are implemented - test: extensions tests OK Signed-off-by: rxinui <rainui.ly@gmail.com>

Signed-off-by: rxinui <rainui.ly@gmail.com>

- ref: update SetHostingClusterContext using KubeflexConfig Signed-off-by: rxinui <rainui.ly@gmail.com>

Signed-off-by: rxinui <rainui.ly@gmail.com>

kubestellar-prow · 2025-06-06T02:10:46Z

Hi @rxinui. Thanks for your PR.

I'm waiting for a kubestellar member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

rxinui · 2025-06-06T02:12:04Z

CC: @pdettori @dumb0002

Signed-off-by: rxinui <rainui.ly@gmail.com>

- test: update ctx_test.go Signed-off-by: rxinui <rainui.ly@gmail.com>

rxinui · 2025-06-08T06:31:43Z

The constant ExtensionConfigName does not bring any value in the new way and in my opinion, should be totally removed as ExtensionKubeflexKey is taking over indicating clearly that such extension refers to kubeflex usage.

pdettori · 2025-06-09T01:22:25Z

/ok-to-test

pdettori

Overall looks good, I have couple of general comments I think would be best to address before merging:

Since this is a breaking change, it would be helpful adding a script or command to migrate old kubeconfig extensions to the new format, or at least provide documentation about this breaking change and how the user can migrate (even by manually editing the file if no automation is provided)
Should add some text to README or release notes to explain the new extension mechanism, breaking changes, and manual steps required by users.

pdettori · 2025-06-09T01:29:41Z

pkg/kubeconfig/extensions.go

+		return err
+	}
+	return nil
+}


I think the code assumes all kubeconfig for Kubeflex have well-formed KubeflexExtensions objects under the extensions key. If a user manually edits kubeconfig, or if there are partial/invalid extension values, code may panic or behave unexpectedly.

True. What should we do then? Isn't a panic a good situation to act as such?

yes, as long as the user understands what caused it

pdettori · 2025-06-09T01:30:54Z

pkg/kubeconfig/kubeconfig.go

 }

+// TODO: the signature is confusing. It switches context but expect controlPlane name as parameter
+// NOTE: Perhaps SwitchContext should only switch context to a context name
+// NOTE: Create a new function SwitchToControlPlaneContext to find a context using control plane name


Agreed - that would be more clear

rxinui · 2025-06-09T19:49:16Z

1. Since this is a breaking change, it would be helpful adding a script or command to migrate old kubeconfig extensions to the new format, or at least provide documentation about this breaking change and how the user can migrate (even by manually editing the file if no automation is provided)

The migration would be part of the issue #389 - therefore, i would like to favour documentation for a manual change.

- new: kflex prints warning message about breaking changes Signed-off-by: rxinui <rainui.ly@gmail.com>

rxinui · 2025-06-09T21:22:09Z

docs/users.md

@@ -1,5 +1,54 @@
 # User's Guide

+## Breaking changes


@pdettori I have added this section to describe the breaking changes what needs to be done by the end-user.

looks good, thx

rxinui · 2025-06-09T21:24:27Z

cmd/kflex/main.go

 func main() {
+	// TODO - find a way to inject it using Makefile
+	common.WarningMessage = "WARNING: current kflex version introduces BREAKING CHANGES related to kflex and your kubeconfig file which may interrupt kflex to function properly.\nSee https://github.com/kubestellar/kubeflex/blob/main/docs/users.md"


@pdettori Everytime kflex is ran, a YELLOW WARNING message will be displayed to indicate the user about breaking changes, with a URL pointing to the end-user documentation.

Ideally, I wanted to inject the message within the Makefile but it is rather complicated to do it. So I fallback in Go for now.

Perhaps it is a sign to move to https://taskfile.dev/usage/

pdettori · 2025-06-09T22:03:03Z

/lgtm

kubestellar-prow · 2025-06-09T22:03:07Z

LGTM label has been added.

Git tree hash: 5363a70b42e260c5f6e0f8d9de9ddd4136fc9217

pdettori · 2025-06-09T22:03:36Z

/approve

kubestellar-prow · 2025-06-09T22:03:40Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pdettori

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [pdettori]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

rxinui added 10 commits June 1, 2025 00:24

new: new struct for extensions

0fb153c

- new: implement KubeflexConfig Signed-off-by: rxinui <rainui.ly@gmail.com>

new: implement extensions structs

f19f41f

Signed-off-by: rxinui <rainui.ly@gmail.com>

new: add extensions and its tests

b7ef773

- new: kubeconfig extensions funcs are implemented - test: extensions tests OK Signed-off-by: rxinui <rainui.ly@gmail.com>

ref: usage of generic to refactor extensions

d7526fb

Signed-off-by: rxinui <rainui.ly@gmail.com>

ref: remove UnmarshallCM to use KubeflexConfig

63ffdd4

Signed-off-by: rxinui <rainui.ly@gmail.com>

ref: update AssignControlPlaneToContext using KubeflexConfig

ea479df

Signed-off-by: rxinui <rainui.ly@gmail.com>

ref: update IsHostingClusterContextSet using KubeflexConfig

0a4d9e0

Signed-off-by: rxinui <rainui.ly@gmail.com>

ref: remove SaveHostingClusterContext

b52b2eb

- ref: update SetHostingClusterContext using KubeflexConfig Signed-off-by: rxinui <rainui.ly@gmail.com>

ref: remove SaveHostingClusterContext and update init command

1141bfd

Signed-off-by: rxinui <rainui.ly@gmail.com>

ref: SwitchToHostingClusterContext updated

2e61811

Signed-off-by: rxinui <rainui.ly@gmail.com>

kubestellar-prow bot added the dco-signoff: yes label Jun 6, 2025

kubestellar-prow bot added needs-ok-to-test size/XL labels Jun 6, 2025

fix: SetHostingClusterContext was faulty

5e3c1ca

Signed-off-by: rxinui <rainui.ly@gmail.com>

rxinui mentioned this pull request Jun 8, 2025

feature: move away from Preferences to Extensions #385

Closed

1 task

rxinui force-pushed the main branch 2 times, most recently from af3f091 to 2c35c59 Compare June 8, 2025 04:52

new: adding is-hosting-cluster-ctx info to context extensions

f087d45

- test: update ctx_test.go Signed-off-by: rxinui <rainui.ly@gmail.com>

rxinui force-pushed the main branch from 2c35c59 to f087d45 Compare June 8, 2025 06:14

kubestellar-prow bot added ok-to-test and removed needs-ok-to-test labels Jun 9, 2025

pdettori reviewed Jun 9, 2025

View reviewed changes

doc: update docs/users.md about breaking changes

67dd197

- new: kflex prints warning message about breaking changes Signed-off-by: rxinui <rainui.ly@gmail.com>

rxinui commented Jun 9, 2025

View reviewed changes

kubestellar-prow bot assigned pdettori Jun 9, 2025

kubestellar-prow bot added the lgtm label Jun 9, 2025

kubestellar-prow bot added the approved label Jun 9, 2025

kubestellar-prow bot merged commit 26f7294 into kubestellar:main Jun 9, 2025
9 checks passed

rxinui mentioned this pull request Jun 12, 2025

bug: kflex fails when kflex-initial-ctx-name is invalid #202

Closed

✨ Usage of Extensions #386

✨ Usage of Extensions #386

Uh oh!

Conversation

rxinui commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

BREAKING CHANGES

Related issue(s)

Uh oh!

kubestellar-prow bot commented Jun 6, 2025

Uh oh!

rxinui commented Jun 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rxinui commented Jun 8, 2025

Uh oh!

pdettori commented Jun 9, 2025

Uh oh!

pdettori left a comment

Choose a reason for hiding this comment

Uh oh!

pdettori Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

rxinui Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

pdettori Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

pdettori Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

rxinui commented Jun 9, 2025

Uh oh!

rxinui Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

pdettori Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

rxinui Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pdettori Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

pdettori commented Jun 9, 2025

Uh oh!

kubestellar-prow bot commented Jun 9, 2025

Uh oh!

pdettori commented Jun 9, 2025

Uh oh!

kubestellar-prow bot commented Jun 9, 2025

Uh oh!

Uh oh!

Uh oh!

rxinui commented Jun 6, 2025 •

edited

Loading

rxinui commented Jun 6, 2025 •

edited

Loading

rxinui Jun 9, 2025 •

edited

Loading