✨ Add classNamespace to topology #11352

Danil-Grigorev · 2024-10-30T09:46:21Z

What this PR does / why we need it:

Adding classNamespace variable to the cluster topology, which allows to point to a ClusterClass in a different namespace. This field is dormant, and is used for differentiation only.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Related to #5673

/area clusterclass

salasberryfin

Thanks @Danil-Grigorev! I added a small suggestion but I think this looks good.

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

salasberryfin · 2024-10-31T10:04:51Z

Thanks @Danil-Grigorev

/lgtm

k8s-ci-robot · 2024-10-31T10:04:57Z

LGTM label has been added.

Git tree hash: c4b418743a4683ae623b3264aae7636c41ad5675

salasberryfin · 2024-10-31T10:05:46Z

/assign @chrischdi

k8s-ci-robot · 2024-11-27T21:03:11Z

New changes are detected. LGTM label has been removed.

api/v1beta1/cluster_types.go

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

internal/webhooks/clusterclass.go

internal/controllers/topology/cluster/cluster_controller.go

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

Danil-Grigorev · 2024-12-18T17:11:46Z

@chrischdi @fabriziopandini Can I get another review? All comments are addressed here.

k8s-ci-robot · 2025-01-07T19:49:50Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from chrischdi. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

sbueringer

Thank you for working on this and thx for the patience. Sorry for the delay

api/v1beta1/cluster_types.go

internal/webhooks/clusterclass.go

api/v1beta1/index/cluster.go

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md

internal/topology/check/compatibility_test.go

api/v1beta1/index/cluster.go

sbueringer · 2025-01-14T16:27:32Z

@Danil-Grigorev Just a few minor comments

- Add documentation on securing cross-namespace access for CC - Add ByClusterClassRef index - Support cross-ns CC rebase Signed-off-by: Danil-Grigorev <[email protected]>

sbueringer · 2025-01-15T17:48:30Z

api/v1beta1/index/cluster.go

+// managers cache.
+func ByClusterClassRef(ctx context.Context, mgr ctrl.Manager) error {
+	if err := mgr.GetCache().IndexField(ctx, &clusterv1.Cluster{},
+		ClusterClassNameField,


Suggested change

ClusterClassNameField,

ClusterClassRefPath,

(same for the Cluster List calls where we use the index)

Please also check all usages of ClusterClassNameField outside of this package (e.g. internal/webhooks/clusterclass_test.go)

sbueringer · 2025-01-15T17:52:02Z

api/v1beta1/index/cluster.go

+	return nil
+}
+
+// ClusterByClusterClassRef contains the logic to index Clusters by ClusterClass name.


Suggested change

// ClusterByClusterClassRef contains the logic to index Clusters by ClusterClass name.

// ClusterByClusterClassRef contains the logic to index Clusters by ClusterClass name and namespace.

nit

sbueringer · 2025-01-15T17:59:55Z

internal/topology/check/compatibility_test.go

@@ -401,19 +401,19 @@ func TestClusterClassesAreCompatible(t *testing.T) {
 		APIVersion: "group.test.io/foo",


Didn't initially realize how broken this test is now :D

I think we should have defaultRef, incompatibleDefaultRef, compatibleRef, otherRef, ... (in the default & other namespace)

And then below we should make sure that each ClusterClass only has refs that match their own namespace (it's invalid to reference from a ClusterClass in one namespace to an external object in another namespace)

Let's also change l.476 to use "other" as namespace

sbueringer · 2025-01-15T18:00:45Z

internal/topology/check/compatibility_test.go

+			desired: builder.ClusterClass(metav1.NamespacePublic, "class1").
 				WithInfrastructureClusterTemplate(
 					builder.InfrastructureClusterTemplate(metav1.NamespaceDefault, "infra1").Build()).


Suggested change

desired: builder.ClusterClass(metav1.NamespacePublic, "class1").

WithInfrastructureClusterTemplate(

builder.InfrastructureClusterTemplate(metav1.NamespaceDefault, "infra1").Build()).

desired: builder.ClusterClass("other"", "class1").

WithInfrastructureClusterTemplate(

builder.InfrastructureClusterTemplate("other"", "infra1").Build()).

I meant we have to change these refs. All referenced templates of a CC should be in the same Namespaces as the CC itself (same for the rest of this builder)

sbueringer · 2025-01-15T18:01:20Z

internal/topology/check/compatibility_test.go

@@ -706,19 +706,19 @@ func TestMachineDeploymentClassesAreCompatible(t *testing.T) {
 		APIVersion: "group.test.io/foo",
 		Kind:       "barTemplate",
 		Name:       "baz",
-		Namespace:  "default",
+		Namespace:  "other",


Let's keep this at default as well (otherwise we don't verify that it's okay to change namespace)

Same in l.855

sbueringer · 2025-01-15T18:05:42Z

api/v1beta1/index/cluster.go

+}
+
+// ClusterClassRef returns ClusterClass index key to be used for search.
+func ClusterClassRef(o client.Object) string {


Suggested change

func ClusterClassRef(o client.Object) string {

func ClusterClassRef(cc *clusterv1.ClusterClass) string {

To make this slightly more typesafe

k8s-ci-robot added area/clusterclass Issues or PRs related to clusterclass cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 30, 2024

Danil-Grigorev changed the title ~~Add classNamespace to topology~~ ✨ Add classNamespace to topology Oct 30, 2024

k8s-ci-robot requested review from jackfrancis and sbueringer October 30, 2024 09:46

Danil-Grigorev force-pushed the class-namespace-addition branch 2 times, most recently from ae1cb19 to 43cb995 Compare October 30, 2024 11:59

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 30, 2024

Danil-Grigorev force-pushed the class-namespace-addition branch 2 times, most recently from 2bddeeb to 352fd66 Compare October 30, 2024 15:20

salasberryfin reviewed Oct 31, 2024

View reviewed changes

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md Outdated Show resolved Hide resolved

Danil-Grigorev force-pushed the class-namespace-addition branch from 352fd66 to bd8a56f Compare October 31, 2024 09:51

k8s-ci-robot assigned salasberryfin Oct 31, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 31, 2024

k8s-ci-robot assigned chrischdi Oct 31, 2024

Danil-Grigorev changed the title ~~✨ Add classNamespace to topology~~ [WIP] ✨ Add classNamespace to topology Oct 31, 2024

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 31, 2024

Danil-Grigorev force-pushed the class-namespace-addition branch from bd8a56f to 4bbb218 Compare October 31, 2024 18:34

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 31, 2024

k8s-ci-robot requested review from chrischdi and salasberryfin October 31, 2024 18:34

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 31, 2024

Danil-Grigorev force-pushed the class-namespace-addition branch from 4bbb218 to d450768 Compare October 31, 2024 18:44

Danil-Grigorev changed the title ~~[WIP] ✨ Add classNamespace to topology~~ ✨ Add classNamespace to topology Oct 31, 2024

k8s-ci-robot requested a review from furkatgofurov7 November 27, 2024 21:03

Danil-Grigorev force-pushed the class-namespace-addition branch from bbbddcf to b4b6131 Compare November 27, 2024 21:25

fabriziopandini reviewed Nov 28, 2024

View reviewed changes

Danil-Grigorev mentioned this pull request Nov 28, 2024

v1beta2: Class Namespace API change #11500

Open

Danil-Grigorev force-pushed the class-namespace-addition branch 4 times, most recently from c581444 to 3639364 Compare December 4, 2024 13:28

chrischdi reviewed Dec 10, 2024

View reviewed changes

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md Outdated Show resolved Hide resolved

docs/book/src/tasks/experimental-features/cluster-class/write-clusterclass.md Outdated Show resolved Hide resolved

Danil-Grigorev force-pushed the class-namespace-addition branch from 902e582 to 2730042 Compare January 7, 2025 19:49

Danil-Grigorev mentioned this pull request Jan 7, 2025

✨ clusterctl move support for a cross namespace ClusterClass reference #11649

Open

Danil-Grigorev force-pushed the class-namespace-addition branch 3 times, most recently from 03780fe to 1ae95a5 Compare January 9, 2025 21:07

sbueringer reviewed Jan 10, 2025

View reviewed changes

sbueringer mentioned this pull request Jan 10, 2025

[WIP] ✨ Extend scale test & improve controller-runtime dashboard #11667

Open

sbueringer added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jan 13, 2025

Danil-Grigorev force-pushed the class-namespace-addition branch 3 times, most recently from 067fcc5 to 21ec29a Compare January 14, 2025 07:52

sbueringer reviewed Jan 14, 2025

View reviewed changes

Danil-Grigorev force-pushed the class-namespace-addition branch from 8706ddc to 681bdbd Compare January 14, 2025 17:19

Add classNamespace to topology

ebdc21d

- Add documentation on securing cross-namespace access for CC - Add ByClusterClassRef index - Support cross-ns CC rebase Signed-off-by: Danil-Grigorev <[email protected]>

Danil-Grigorev force-pushed the class-namespace-addition branch from 681bdbd to ebdc21d Compare January 15, 2025 16:02

sbueringer reviewed Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Add classNamespace to topology #11352

✨ Add classNamespace to topology #11352

Danil-Grigorev commented Oct 30, 2024 •

edited

Loading

salasberryfin left a comment

salasberryfin commented Oct 31, 2024

k8s-ci-robot commented Oct 31, 2024

salasberryfin commented Oct 31, 2024

k8s-ci-robot commented Nov 27, 2024

Danil-Grigorev commented Dec 18, 2024

k8s-ci-robot commented Jan 7, 2025

sbueringer left a comment

sbueringer commented Jan 14, 2025

sbueringer Jan 15, 2025

sbueringer Jan 15, 2025

sbueringer Jan 15, 2025

sbueringer Jan 15, 2025

sbueringer Jan 15, 2025

sbueringer Jan 15, 2025 •

edited

Loading

	// ClusterByClusterClassRef contains the logic to index Clusters by ClusterClass name.
	// ClusterByClusterClassRef contains the logic to index Clusters by ClusterClass name and namespace.

		@@ -401,19 +401,19 @@ func TestClusterClassesAreCompatible(t *testing.T) {
		APIVersion: "group.test.io/foo",

	func ClusterClassRef(o client.Object) string {
	func ClusterClassRef(cc *clusterv1.ClusterClass) string {

✨ Add classNamespace to topology #11352

Are you sure you want to change the base?

✨ Add classNamespace to topology #11352

Conversation

Danil-Grigorev commented Oct 30, 2024 • edited Loading

salasberryfin left a comment

Choose a reason for hiding this comment

salasberryfin commented Oct 31, 2024

k8s-ci-robot commented Oct 31, 2024

salasberryfin commented Oct 31, 2024

k8s-ci-robot commented Nov 27, 2024

Danil-Grigorev commented Dec 18, 2024

k8s-ci-robot commented Jan 7, 2025

sbueringer left a comment

Choose a reason for hiding this comment

sbueringer commented Jan 14, 2025

sbueringer Jan 15, 2025

Choose a reason for hiding this comment

sbueringer Jan 15, 2025

Choose a reason for hiding this comment

sbueringer Jan 15, 2025

Choose a reason for hiding this comment

sbueringer Jan 15, 2025

Choose a reason for hiding this comment

sbueringer Jan 15, 2025

Choose a reason for hiding this comment

sbueringer Jan 15, 2025 • edited Loading

Choose a reason for hiding this comment

Danil-Grigorev commented Oct 30, 2024 •

edited

Loading

sbueringer Jan 15, 2025 •

edited

Loading