enable the use of an external control plane #4611

rpahli · 2024-03-01T10:05:32Z

What type of PR is this?

/kind feature

This PR enables the use off an external control plane (e.g. https://github.com/clastix/cluster-api-control-plane-provider-kamaji)

What this PR does / why we need it:

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

Special notes for your reviewer:

cherry-pick candidate

TODOs:

squashed commits
includes documentation
adds unit tests

Release note:

Enable the use of an external control plane

k8s-ci-robot · 2024-03-01T10:05:40Z

[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 assign sbueringer for approval. For more information see the Kubernetes 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

k8s-ci-robot · 2024-03-01T10:05:41Z

Welcome @rpahli!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-azure 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-azure has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-03-01T10:05:43Z

Hi @rpahli. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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/test-infra repository.

prometherion · 2024-04-02T15:45:35Z

api/v1beta1/types.go

-	APIServerLB LoadBalancerSpec `json:"apiServerLB,omitempty"`
+	APIServerLB *LoadBalancerSpec `json:"apiServerLB,omitempty"`


Instead of using a pointer, what about moving the additional field you introduced (ControlPlaneEnabled) here?

With such approach we could introduce the feature smoothly with no breaking changes, and maintain the current state of the pointers.

The "problem" is that der is a mutation inside the webhook and if this is no pointer then some fields will be filled which makes problems later. To me the question is omitempty means it can be null so the pointer also makes sense to me.

LGTM, it makes sense.

rpahli · 2024-04-16T13:28:43Z

@marosset @mboersma any updates on this? Can I get a first review?

k8s-triage-robot · 2024-07-15T14:17:32Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

rpahli · 2024-07-15T14:20:31Z

/remove-lifecycle stale

prometherion · 2024-07-23T08:38:56Z

api/v1beta1/azurecluster_default.go

-	c.setAPIServerLBDefaults()
+	if c.Spec.ControlPlaneEnabled {
+		c.setAPIServerLBDefaults()
+	}
 	c.SetNodeOutboundLBDefaults()
-	c.SetControlPlaneOutboundLBDefaults()


Does order here matter?

It would be cool if we could group these functions together to reduce cyclomatic complexity.

prometherion · 2024-07-23T08:40:45Z

api/v1beta1/azurecluster_default.go

+		c.SetControlPlaneOutboundLBDefaults()
+	}
+	if !c.Spec.ControlPlaneEnabled {
+		c.Spec.NetworkSpec.APIServerLB = nil
+	}


Rather than nulling values, it would be interesting to have a validation webhook complaining about the disparity of values: if the CP is disabled no values are allowed for the APIServerLB, if provided.

prometherion · 2024-07-23T08:45:04Z

api/v1beta1/azurecluster_default.go

@@ -249,7 +266,7 @@ func (c *AzureCluster) setAPIServerLBDefaults() {
 // SetNodeOutboundLBDefaults sets the default values for the NodeOutboundLB.
 func (c *AzureCluster) SetNodeOutboundLBDefaults() {


Do worker nodes use the node outbound LB too?

prometherion · 2024-07-23T08:45:27Z

api/v1beta1/azurecluster_types.go

+	// ControlPlaneEnabled enable control plane cluster components.
+	// +kubebuilder:default=true
+	// +optional
+	ControlPlaneEnabled bool `json:"controlPlaneEnabled"`


Suggested change

ControlPlaneEnabled bool `json:"controlPlaneEnabled"`

ControlPlaneEnabled bool `json:"controlPlaneEnabled,omitempty"`

prometherion · 2024-07-23T08:49:46Z

api/v1beta1/azurecluster_validation.go

 	requiredSubnetRoles := map[string]bool{
-		"control-plane": false,
+		"control-plane": !controlPlaneEnabled,
 		"node":          false,
 	}


This should be refactored this way:

requiredSubnetRoles := map[string]bool{ "node": false, } if controlPlaneEnabled { requiredSubnetRoles["control-plane"] = false }

The key control-plane must not be present when the Control Plane is externally managed.

prometherion · 2024-07-23T08:50:52Z

api/v1beta1/types.go

-	APIServerLB LoadBalancerSpec `json:"apiServerLB,omitempty"`
+	APIServerLB *LoadBalancerSpec `json:"apiServerLB,omitempty"`


LGTM, it makes sense.

prometherion · 2024-07-23T08:56:14Z

azure/scope/cluster.go

-			for _, ip := range s.ControlPlaneOutboundLB().FrontendIPs {
-				controlPlaneOutboundIPSpecs = append(controlPlaneOutboundIPSpecs, &publicips.PublicIPSpec{
-					Name:             ip.PublicIP.Name,
+	if s.ControlPlaneEnabled() {


We could avoid the multiple if nesting here, just having the IsAPIServerPrivate block, and put the ControlPlaneEnabled function in the else clause, since we need outbound LB only if the CP Load Balancer is enabled.

prometherion · 2024-07-23T08:59:11Z

azure/scope/cluster.go

-					PublicIP: &infrav1.PublicIPSpec{
-						Name:    ip,
-						DNSName: dns,
+	if s.ControlPlaneEnabled() {


Rather than nesting with if conditions, let's return if the Control Plane is not enabled.

if !s.ControlPlaneEnabled() { return }

prometherion · 2024-07-23T08:59:41Z

config/capz/manager_image_patch.yaml

@@ -8,5 +8,5 @@ spec:
    spec:
      containers:
      # Change the value of image field below to your controller image URL
-      - image: gcr.io/k8s-staging-cluster-api-azure/cluster-api-azure-controller:main
+      - image: localhost:5000/cluster-api-azure-controller-amd64:dev


Just a reminder, amend the changes here.

prometherion · 2024-07-23T09:06:12Z

controllers/azurecluster_controller.go

-	}
-	if azureCluster.Spec.ControlPlaneEndpoint.Port == 0 {
-		azureCluster.Spec.ControlPlaneEndpoint.Port = clusterScope.APIServerPort()
+	if azureCluster.Spec.ControlPlaneEnabled {


We need to check the values also when the Control Plane is externally managed, something like this:

if !azureCluster.Spec.ControlPlaneEnabled { if azureCluster.Spec.ControlPlaneEndpoint.Host == "" { conditions.MarkFalse(azureCluster, infrav1.NetworkInfrastructureReadyCondition, "ExternallyManagedControlPlane", clusterv1.ConditionSeverityInfo, "Waiting for the Control Plane host") return reconcile.Result{}, nil } else if azureCluster.Spec.ControlPlaneEndpoint.Port == 0 { conditions.MarkFalse(azureCluster, infrav1.NetworkInfrastructureReadyCondition, "ExternallyManagedControlPlane", clusterv1.ConditionSeverityInfo, "Waiting for the Control Plane port") return reconcile.Result{}, nil } }

mboersma · 2024-07-25T15:36:36Z

/ok-to-test

k8s-ci-robot · 2024-07-26T08:18:57Z

@rpahli: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-cluster-api-provider-azure-apidiff	`125c187`	link	false	`/test pull-cluster-api-provider-azure-apidiff`
pull-cluster-api-provider-azure-test	`125c187`	link	true	`/test pull-cluster-api-provider-azure-test`
pull-cluster-api-provider-azure-e2e-aks	`125c187`	link	true	`/test pull-cluster-api-provider-azure-e2e-aks`
pull-cluster-api-provider-azure-e2e	`125c187`	link	true	`/test pull-cluster-api-provider-azure-e2e`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

prometherion · 2024-07-26T14:23:00Z

There are still some unanswered questions, especially about grouping some functions (here) besides my personal question on the outbound LB: since the Control Plane is externally managed, is the said outbound used only for the worker nodes?

mboersma

This lgtm overall, thanks @rpahli and @prometherion. Maybe there's a way to have fewer if controlPlaneEnabled checks by deferring some validation to a webhook as suggested in one comment?

mboersma · 2024-07-29T15:22:48Z

api/v1beta1/azurecluster_types.go

+	// ControlPlaneEnabled enable control plane cluster components.
+	// +kubebuilder:default=true
+	// +optional
+	ControlPlaneEnabled bool `json:"controlPlaneEnabled,omitempty"`


Is ControlPlaneEnabled the same field name in other provider implementations? Would be good to keep that consistent if possible.

Unfortunately, there's no consistency across providers since this setting may vary.

e.g. on AWS:

apiVersion: infrastructure.cluster.x-k8s.io/v1beta2 kind: AWSCluster metadata: name: capi-quickstart namespace: default spec: region: us-east-1 sshKeyName: default controlPlaneLoadBalancer: loadBalancerType: disabled

enable the use off an external control plane

558454c

k8s-ci-robot requested review from Jont828 and mboersma March 1, 2024 10:05

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 1, 2024

rpahli mentioned this pull request Mar 1, 2024

feat: azure support clastix/cluster-api-control-plane-provider-kamaji#84

Open

prometherion reviewed Apr 2, 2024

View reviewed changes

rpahli added 2 commits April 8, 2024 13:52

cleanup

845077e

fix tests

18009a3

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 8, 2024

fix tests

0883d45

rpahli marked this pull request as ready for review April 9, 2024 07:12

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

k8s-ci-robot requested a review from marosset April 9, 2024 07:12

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 15, 2024

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 15, 2024

prometherion suggested changes Jul 23, 2024

View reviewed changes

k8s-ci-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Jul 25, 2024

k8s-ci-robot removed the do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. label Jul 25, 2024

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 25, 2024

mboersma added this to the v1.17 milestone Jul 25, 2024

PR comments

125c187

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 26, 2024

mboersma changed the title ~~enable the use off an external control plane~~ enable the use of an external control plane Jul 29, 2024

mboersma reviewed Jul 29, 2024

View reviewed changes

dtzar modified the milestones: v1.17, v1.18 Sep 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

enable the use of an external control plane #4611

enable the use of an external control plane #4611

rpahli commented Mar 1, 2024 •

edited by mboersma

Loading

k8s-ci-robot commented Mar 1, 2024

k8s-ci-robot commented Mar 1, 2024

k8s-ci-robot commented Mar 1, 2024

prometherion Apr 2, 2024

rpahli Apr 3, 2024

prometherion Jul 23, 2024

rpahli commented Apr 16, 2024

k8s-triage-robot commented Jul 15, 2024

rpahli commented Jul 15, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

prometherion Jul 23, 2024

mboersma commented Jul 25, 2024

k8s-ci-robot commented Jul 26, 2024

prometherion commented Jul 26, 2024

mboersma left a comment

mboersma Jul 29, 2024

prometherion Jul 29, 2024

		APIServerLB LoadBalancerSpec `json:"apiServerLB,omitempty"`
		APIServerLB *LoadBalancerSpec `json:"apiServerLB,omitempty"`

		@@ -249,7 +266,7 @@ func (c *AzureCluster) setAPIServerLBDefaults() {
		// SetNodeOutboundLBDefaults sets the default values for the NodeOutboundLB.
		func (c *AzureCluster) SetNodeOutboundLBDefaults() {

	ControlPlaneEnabled bool `json:"controlPlaneEnabled"`
	ControlPlaneEnabled bool `json:"controlPlaneEnabled,omitempty"`

enable the use of an external control plane #4611

Are you sure you want to change the base?

enable the use of an external control plane #4611

Conversation

rpahli commented Mar 1, 2024 • edited by mboersma Loading

k8s-ci-robot commented Mar 1, 2024

k8s-ci-robot commented Mar 1, 2024

k8s-ci-robot commented Mar 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rpahli commented Apr 16, 2024

k8s-triage-robot commented Jul 15, 2024

rpahli commented Jul 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mboersma commented Jul 25, 2024

k8s-ci-robot commented Jul 26, 2024

prometherion commented Jul 26, 2024

mboersma left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rpahli commented Mar 1, 2024 •

edited by mboersma

Loading