Do not delete bastion floating ip if set in spec #2257

anders-elastisys · 2024-11-18T07:56:08Z

What this PR does / why we need it:

This PR makes it so that if an floatingIP is set in the openstackcluster.spec.bastion.floatingIP, and it is the same as set in the status of the openstackcluster resource, it will not be deleted when deleting the cluster.

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 #2157

Special notes for your reviewer:

My issue got stale so I am creating this PR so that hopefully this feature does not get forgotten.

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

TODOs:

squashed commits
if necessary:
- includes documentation
- adds unit tests

/hold

k8s-ci-robot · 2024-11-18T07:56:17Z

Welcome @anders-elastisys!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-openstack 🎉. 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-openstack 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-11-18T07:56:18Z

Hi @anders-elastisys. 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-sigs/prow repository.

netlify · 2024-11-18T07:56:23Z

✅ Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!

Name	Link
🔨 Latest commit	`c1fe7b8`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-cluster-api-openstack/deploys/673af31a1ef44f000848fa8a
😎 Deploy Preview	https://deploy-preview-2257--kubernetes-sigs-cluster-api-openstack.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mdbooth

/ok-to-test
/lgtm

@EmilienM I think you're the expert in this code.

k8s-ci-robot · 2024-11-26T14:05:08Z

@anders-elastisys: 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-openstack-test	`c1fe7b8`	link	true	`/test pull-cluster-api-provider-openstack-test`
pull-cluster-api-provider-openstack-e2e-test	`c1fe7b8`	link	true	`/test pull-cluster-api-provider-openstack-e2e-test`

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.

EmilienM · 2024-11-26T15:23:00Z

controllers/openstackcluster_controller.go

 	if openStackCluster.Status.Bastion != nil && openStackCluster.Status.Bastion.FloatingIP != "" {
+		// Floating IP set in status


Please remove that comment, I think it's too obvious.

EmilienM · 2024-11-26T15:23:05Z

controllers/openstackcluster_controller.go

+		statusFloatingIP = &openStackCluster.Status.Bastion.FloatingIP
+	}
+	if openStackCluster.Spec.Bastion.FloatingIP != nil {
+		// Floating IP from the spec


Please remove that comment, I think it's too obvious.

EmilienM · 2024-11-26T15:25:02Z

controllers/openstackcluster_controller.go

+		specFloatingIP = openStackCluster.Spec.Bastion.FloatingIP
+	}
+
+	if statusFloatingIP != nil && (specFloatingIP == nil || *statusFloatingIP != *specFloatingIP) {


Here please add a comment on what opinionated decision we make.

We only remove the bastion's floating IP if it exists and if it's the not same value defined both in the spec and in status. This decision was made so if a user specifies a pre-created floating IP that is intended to be used for the bastion, the floating IP won't get removed once the bastion is destroyed.

Or something like that.

EmilienM · 2024-11-26T15:25:51Z

controllers/openstackcluster_controller.go

@@ -270,6 +281,10 @@ func (r *OpenStackClusterReconciler) deleteBastion(ctx context.Context, scope *s

 		for _, address := range addresses {
 			if address.Type == corev1.NodeExternalIP {
+				// If a floating IP is set for the bastion spec, skip deleting it


same here, put more context in this comment.

EmilienM

Thanks for your contribution.

I've put some comments inline.
I don't want to be picky but I honestly think we should have e2e coverage for this PR, simply because the code around bastion has proven to break quite easily and I've spent hours fixing it.

Please have a look at how we test a flavor change for the bastion:

cluster-api-provider-openstack/test/e2e/suites/e2e/e2e_test.go

Line 277 in 300f850

shared.Logf("Create the bastion with a new flavor")

and see if we can do the same kind of testing:

Create a FIP using Gophercloud
Update the cluster spec to provide that FIP in Bastion
Check that the bastion uses that FIP
Delete the Bastion, make sure the FIP was not deleted
Delete the FIP

Let me know if it's too much asked, I can help.
If you want to do the tests as a follow-up, we can also do that and in that case I'll approve this PR.

k8s-ci-robot · 2024-11-26T15:29:00Z

[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 mdbooth. 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

anders-elastisys · 2024-11-26T16:26:51Z

Let me know if it's too much asked, I can help. If you want to do the tests as a follow-up, we can also do that and in that case I'll approve this PR.

Thanks for the comments, I will take try to add e2e tests when I get the time, if I am not successful in this I'll let you know.

EmilienM · 2024-11-26T16:38:38Z

Let me know if it's too much asked, I can help. If you want to do the tests as a follow-up, we can also do that and in that case I'll approve this PR.

Thanks for the comments, I will take try to add e2e tests when I get the time, if I am not successful in this I'll let you know.

awesome; thanks. And if we don't manage it to do it in a timely manner, I can merge as is and do the tests afterwards.

Do not delete bastion floating ip if set in spec

c1fe7b8

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 18, 2024

k8s-ci-robot requested review from EmilienM and mdbooth November 18, 2024 07:56

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 18, 2024

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 18, 2024

mdbooth reviewed Nov 26, 2024

View reviewed changes

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 Nov 26, 2024

k8s-ci-robot assigned mdbooth Nov 26, 2024

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

EmilienM reviewed Nov 26, 2024

View reviewed changes

EmilienM requested changes Nov 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not delete bastion floating ip if set in spec #2257

Do not delete bastion floating ip if set in spec #2257

anders-elastisys commented Nov 18, 2024

k8s-ci-robot commented Nov 18, 2024

k8s-ci-robot commented Nov 18, 2024

netlify bot commented Nov 18, 2024 •

edited

Loading

mdbooth left a comment

k8s-ci-robot commented Nov 26, 2024

EmilienM Nov 26, 2024 •

edited

Loading

EmilienM Nov 26, 2024 •

edited

Loading

EmilienM Nov 26, 2024

EmilienM Nov 26, 2024

EmilienM left a comment •

edited

Loading

k8s-ci-robot commented Nov 26, 2024

anders-elastisys commented Nov 26, 2024

EmilienM commented Nov 26, 2024

		if openStackCluster.Status.Bastion != nil && openStackCluster.Status.Bastion.FloatingIP != "" {
		// Floating IP set in status

Do not delete bastion floating ip if set in spec #2257

Are you sure you want to change the base?

Do not delete bastion floating ip if set in spec #2257

Conversation

anders-elastisys commented Nov 18, 2024

k8s-ci-robot commented Nov 18, 2024

k8s-ci-robot commented Nov 18, 2024

netlify bot commented Nov 18, 2024 • edited Loading

✅ Deploy Preview for kubernetes-sigs-cluster-api-openstack ready!

mdbooth left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 26, 2024

EmilienM Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

EmilienM Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

EmilienM Nov 26, 2024

Choose a reason for hiding this comment

EmilienM Nov 26, 2024

Choose a reason for hiding this comment

EmilienM left a comment • edited Loading

Choose a reason for hiding this comment

k8s-ci-robot commented Nov 26, 2024

anders-elastisys commented Nov 26, 2024

EmilienM commented Nov 26, 2024

netlify bot commented Nov 18, 2024 •

edited

Loading

EmilienM Nov 26, 2024 •

edited

Loading

EmilienM Nov 26, 2024 •

edited

Loading

EmilienM left a comment •

edited

Loading