Feature: support DeleteOptions when deleting resources in member clusters #1355

RolandMa1986 · 2021-02-02T02:24:08Z

What this PR does / why we need it:
This PR implements PR #1348 to support DeleteOptions when deleting resources in member clusters. When deleting a federated resource with kubefed.io/deleteoptions annotation, it will be deserialized as a DeleteOptons object and apply to the delete operation.

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

k8s-ci-robot · 2021-02-02T02:24:11Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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

k8s-ci-robot · 2021-02-02T02:24:15Z

Welcome @RolandMa1986!

It looks like this is your first PR to kubernetes-sigs/kubefed 🎉. 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/kubefed 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 · 2021-02-03T00:56:24Z

@RolandMa1986: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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.

hectorj2f · 2021-02-09T23:14:59Z

I will review this PR during this week.

makkes

This might come in as a handy feature in general. Just some minor change requests. I will also comment on the associated issue with a question that came up while reviewing.

makkes · 2021-02-10T08:41:08Z

pkg/controller/util/deletionannotation.go

@@ -0,0 +1,67 @@
+/*
+Copyright 2019 The Kubernetes Authors.


Suggested change

Copyright 2019 The Kubernetes Authors.

Copyright 2021 The Kubernetes Authors.

makkes · 2021-02-10T08:41:56Z

pkg/controller/util/deletionannotation.go

+)
+
+// GetDeleteOptions return delete options from the annotation
+func GetDeleteOptions(obj *unstructured.Unstructured) []client.DeleteOption {


Suggested change

func GetDeleteOptions(obj *unstructured.Unstructured) []client.DeleteOption {

func GetDeleteOptions(obj *unstructured.Unstructured) ([]client.DeleteOption, error) {

makkes · 2021-02-10T08:45:07Z

pkg/controller/util/deletionannotation.go

+		if err := json.Unmarshal([]byte(optStr), opt); err == nil {
+			clientOpt := &client.DeleteOptions{}
+			clientOpt.GracePeriodSeconds = opt.GracePeriodSeconds
+			clientOpt.PropagationPolicy = opt.PropagationPolicy
+			clientOpt.Preconditions = opt.Preconditions
+			options = append(options, clientOpt)
+		}


As this is a user-supplied value, we should expect the unmarshalling to fail, e.g. because the user failed to supply valid JSON in the annotation:

Suggested change

if err := json.Unmarshal([]byte(optStr), opt); err == nil {

clientOpt := &client.DeleteOptions{}

clientOpt.GracePeriodSeconds = opt.GracePeriodSeconds

clientOpt.PropagationPolicy = opt.PropagationPolicy

clientOpt.Preconditions = opt.Preconditions

options = append(options, clientOpt)

}

if err := json.Unmarshal([]byte(optStr), opt); err != nil {

return fmt.Errorf("could not deserialize delete options from annotation value '%s': %w", optStr, err)

}

clientOpt := &client.DeleteOptions{}

clientOpt.GracePeriodSeconds = opt.GracePeriodSeconds

clientOpt.PropagationPolicy = opt.PropagationPolicy

clientOpt.Preconditions = opt.Preconditions

options = append(options, clientOpt)

I agree. Changes have been committed as you suggested.

makkes · 2021-02-10T08:45:24Z

pkg/controller/util/deletionannotation.go

+	options := make([]client.DeleteOption, 0)
+	annotations := obj.GetAnnotations()
+	if annotations == nil {
+		return options


Suggested change

return options

return options, nil

pkg/controller/util/deletionannotation.go

makkes · 2021-02-10T08:46:59Z

test/e2e/deleteoptions.go

+
+	fixture := typeConfigFixtures[typeConfigName]
+
+	It(`Deployment should be created and deleted successfully, but ReplicaSet that created by Deployment won't be deleted`, func() {


Suggested change

It(`Deployment should be created and deleted successfully, but ReplicaSet that created by Deployment won't be deleted`, func() {

It("Deployment should be created and deleted successfully, but ReplicaSet that created by Deployment won't be deleted", func() {

just a nit

makkes · 2021-02-10T08:51:54Z

/ok-to-test

makkes · 2021-02-11T10:23:08Z

pkg/controller/util/deletionannotation.go

+	if optStr, ok := annotations[DeleteOptionAnnotation]; ok {
+		opt := &metav1.DeleteOptions{}
+		if err := json.Unmarshal([]byte(optStr), opt); err != nil {
+			return nil, fmt.Errorf("could not deserialize delete options from annotation value '%s': %w", optStr, err)


Sorry, my suggestion actually made CI complain:

Suggested change

return nil, fmt.Errorf("could not deserialize delete options from annotation value '%s': %w", optStr, err)

return nil, errors.Wrapf(err, "could not deserialize delete options from annotation value '%s'", optStr)

pkg/controller/util/deletionannotation.go

hectorj2f · 2021-02-11T23:46:45Z

test/common/crudtester.go

+
+		kubeClient := kubeclientset.NewForConfigOrDie(clusterConfig)
+		WaitForNamespaceOrDie(c.tl, kubeClient, clusterName, fedObject.GetNamespace(),
+			c.waitInterval, 30*time.Second)


please use framework.PollInterval, framework.TestContext.SingleCallTimeout instead of c.waitInterval, 30*time.Second.

I guess the framework package depends on common, so it doesn't allow me to import framework in crudtester.go.
Any idea to resolve this? I'm pretty new to Golang.

I believe you faced some cycle go deps here. It is alright, I'll move those common attributes to a different package. Not a blocker.

hectorj2f

@RolandMa1986 Great work! Overall looks good to me, I just left some comments in addition to those from @makkes.

hectorj2f · 2021-02-11T23:49:02Z

The PR build failed due to:

+echo 'Checking that correct Error Package is used.'
Checking that correct Error Package is used.
+./hack/verify-errpkg.sh
Please Switch from fmt.errorf to github/pkg/errors to fix the following files:
./pkg/controller/util/deletionannotation.go

Signed-off-by: RolandMa1986 <[email protected]>

makkes · 2021-02-12T09:40:42Z

/retest
pull request limit hitting us again (see #1359)

makkes

lgtm now, but somehow I missed an ignored possible error. If that's addressed, I'm all ✅

pkg/controller/util/deletionannotation.go

hectorj2f · 2021-02-17T11:13:34Z

@RolandMa1986 lgtm too, let's just address these minor comments from @makkes

Signed-off-by: RolandMa1986 <[email protected]>

makkes · 2021-02-18T08:38:39Z

/lgtm

hectorj2f

/approve

k8s-ci-robot · 2021-02-18T09:28:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hectorj2f, makkes, RolandMa1986

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~~ [hectorj2f]

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

hectorj2f · 2021-02-18T09:29:14Z

Good job @RolandMa1986! Thanks for your contribution 👍🏻 !

hectorj2f · 2021-02-18T09:29:27Z

/lgtm

RolandMa1986 · 2021-02-18T09:44:53Z

Good job @RolandMa1986! Thanks for your contribution 👍🏻 !

Thanks for your help @hectorj2f and @makkes.

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Feb 2, 2021

k8s-ci-robot requested review from font and makkes February 2, 2021 02:24

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 2, 2021

RolandMa1986 force-pushed the feat/kubefed-deleteoption branch 3 times, most recently from 99c3f4e to 992cbfc Compare February 2, 2021 03:52

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Feb 2, 2021

RolandMa1986 force-pushed the feat/kubefed-deleteoption branch from 992cbfc to dae1472 Compare February 2, 2021 05:47

RolandMa1986 force-pushed the feat/kubefed-deleteoption branch 2 times, most recently from 967ce5b to fe0376a Compare February 5, 2021 07:49

makkes suggested changes Feb 10, 2021

View reviewed changes

k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Feb 10, 2021

RolandMa1986 force-pushed the feat/kubefed-deleteoption branch from fe0376a to 71bd13a Compare February 11, 2021 01:31

makkes reviewed Feb 11, 2021

View reviewed changes

hectorj2f reviewed Feb 11, 2021

View reviewed changes

pkg/controller/util/deletionannotation.go Show resolved Hide resolved

hectorj2f reviewed Feb 11, 2021

View reviewed changes

feat: delete resource with DeleteOptioins

25774fb

Signed-off-by: RolandMa1986 <[email protected]>

RolandMa1986 force-pushed the feat/kubefed-deleteoption branch from 71bd13a to 7e48784 Compare February 12, 2021 07:31

makkes suggested changes Feb 17, 2021

View reviewed changes

pkg/controller/util/deletionannotation.go Outdated Show resolved Hide resolved

pkg/controller/util/deletionannotation.go Outdated Show resolved Hide resolved

e2e test for DeleteOptioins

b7061be

Signed-off-by: RolandMa1986 <[email protected]>

RolandMa1986 force-pushed the feat/kubefed-deleteoption branch from 7e48784 to b7061be Compare February 18, 2021 02:11

makkes approved these changes Feb 18, 2021

View reviewed changes

k8s-ci-robot assigned makkes Feb 18, 2021

k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 18, 2021

hectorj2f reviewed Feb 18, 2021

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 18, 2021

k8s-ci-robot assigned hectorj2f Feb 18, 2021

k8s-ci-robot merged commit 485bcf0 into kubernetes-retired:master Feb 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: support DeleteOptions when deleting resources in member clusters #1355

Feature: support DeleteOptions when deleting resources in member clusters #1355

RolandMa1986 commented Feb 2, 2021

k8s-ci-robot commented Feb 2, 2021

k8s-ci-robot commented Feb 2, 2021

k8s-ci-robot commented Feb 3, 2021

hectorj2f commented Feb 9, 2021

makkes left a comment

makkes Feb 10, 2021

makkes Feb 10, 2021

makkes Feb 10, 2021

RolandMa1986 Feb 11, 2021

makkes Feb 10, 2021

makkes Feb 10, 2021

makkes commented Feb 10, 2021

makkes Feb 11, 2021

hectorj2f Feb 11, 2021

RolandMa1986 Feb 12, 2021

hectorj2f Feb 17, 2021

hectorj2f left a comment

hectorj2f commented Feb 11, 2021

makkes commented Feb 12, 2021

makkes left a comment

hectorj2f commented Feb 17, 2021

makkes commented Feb 18, 2021

hectorj2f left a comment

k8s-ci-robot commented Feb 18, 2021

hectorj2f commented Feb 18, 2021

hectorj2f commented Feb 18, 2021

RolandMa1986 commented Feb 18, 2021

	Copyright 2019 The Kubernetes Authors.
	Copyright 2021 The Kubernetes Authors.

	func GetDeleteOptions(obj *unstructured.Unstructured) []client.DeleteOption {
	func GetDeleteOptions(obj *unstructured.Unstructured) ([]client.DeleteOption, error) {


		fixture := typeConfigFixtures[typeConfigName]

		It(`Deployment should be created and deleted successfully, but ReplicaSet that created by Deployment won't be deleted`, func() {

	It(`Deployment should be created and deleted successfully, but ReplicaSet that created by Deployment won't be deleted`, func() {
	It("Deployment should be created and deleted successfully, but ReplicaSet that created by Deployment won't be deleted", func() {

	return nil, fmt.Errorf("could not deserialize delete options from annotation value '%s': %w", optStr, err)
	return nil, errors.Wrapf(err, "could not deserialize delete options from annotation value '%s'", optStr)

Feature: support DeleteOptions when deleting resources in member clusters #1355

Feature: support DeleteOptions when deleting resources in member clusters #1355

Conversation

RolandMa1986 commented Feb 2, 2021

k8s-ci-robot commented Feb 2, 2021

k8s-ci-robot commented Feb 2, 2021

k8s-ci-robot commented Feb 3, 2021

hectorj2f commented Feb 9, 2021

makkes left a 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

makkes commented Feb 10, 2021

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

hectorj2f left a comment

Choose a reason for hiding this comment

hectorj2f commented Feb 11, 2021

makkes commented Feb 12, 2021

makkes left a comment

Choose a reason for hiding this comment

hectorj2f commented Feb 17, 2021

makkes commented Feb 18, 2021

hectorj2f left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 18, 2021

hectorj2f commented Feb 18, 2021

hectorj2f commented Feb 18, 2021

RolandMa1986 commented Feb 18, 2021