✨ Move the webhookcainjection_patch.yaml file creation from init project to webhook creation #1728

prafull01 · 2020-10-19T16:37:12Z

Description of the Change:
webhookcainjection_patch.yaml file is created at the init of the project, I have changed that to be created at the time of webhook creation.

Motivation:
I am a consumer of the kubebuilder plugins would like that each plugin only scaffold manifests which are related to its domain so that, I can decide what plugins I'd like to consume or not.

Fixes: #1727

k8s-ci-robot · 2020-10-19T16:37:21Z

Hi @prafull01. 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.

prafull01 · 2020-10-19T16:37:34Z

/cc @camilamacedo86

estroz · 2020-10-19T16:44:54Z

pkg/plugin/v3/scaffolds/internal/templates/config/webhook/enablecainection_patch.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */

-package kdefault
+package webhook


This file will still be scaffolded in config/default, so should remain in the config/kdefault package.

estroz · 2020-10-19T16:45:16Z

pkg/plugin/v2/scaffolds/internal/templates/webhook/enablecainection_patch.go

@@ -37,7 +37,8 @@ func (f *InjectCAPatch) SetTemplateDefaults() error {

 	f.TemplateBody = injectCAPatchTemplate

-	f.IfExistsAction = file.Error
+	// If file webhookcainjection_patch.yaml exist, skip its creation


Only the v3 plugin should be changed, so revert changes in pkg/plugin/v2.

IMO would be fine do it for v2+ since it shows a bug introduced instead of a RFE. However, I would be ok with change only for v3+

If I understand correctly, scaffolding this patch during init is intentional because it is directly referenced in config/default/kustomization.yaml. @DirectXMan12 is that correct?

Hi @estroz,

I do not think that it was intentional. Note that, it may be hurting concepts such as encapsulation, single responsibility principle and almost for sure cohesion that may cause unexpected sides effects such difficulty to read, maintain/improve and extend, to mention a few. Also, IMO:

As @pwittrock spoke well another day, it is very hard for users to know and maintain so many config files, in this way, allow the init create/delete/update webhooks manifests not make harder ONLY for us(contributors) but also for users since it means more unnecessary config files for their scenarios. So, a use case that it hurts, for example, would be I am an operator dev would like to see specific manifests which are required/useful for the webhooks only/if my project has webhooks

Also, note that when we introduce the plugin design we start to allow the plugins to be consumed for the other projects. Then, it means that as a developer I can decide to consume only the init and the create the plugin as well which means that my projects would NOT support webhooks then, would not make sense have webhooks flags or scaffolded manifests in the init command/plugin. It shows hurt the domains of responsibility as described in #1644.

To clarify what I mean: the choice to scaffold this file in init may have been sub-optimal, but it was a conscious (intentional) one. Regardless the right move is to move this to create webhook.

estroz

If we're only making these changes to support the outcome of #1644's discussion about flags, we should hold off on reviewing this PR until that discussion is finalized. If we decide to go with create webhook --webhook-version over init --webhook-version, then this PR can go ahead for review.

/hold

camilamacedo86 · 2020-10-19T21:59:45Z

/ok-to-test

camilamacedo86 · 2020-10-20T19:10:22Z

I think we can :
/hold cancel

based on the discussion made in the bug triage meeting.

camilamacedo86 · 2020-10-20T19:11:21Z

pkg/plugin/v3/scaffolds/webhook.go

@@ -19,6 +19,8 @@ package scaffolds
 import (
 	"fmt"

+	"sigs.k8s.io/kubebuilder/pkg/plugin/v3/scaffolds/internal/templates/config/kdefault"


Nit: Sort the import. It needs to be at the end.

camilamacedo86 · 2020-10-20T19:12:38Z

pkg/plugin/v3/scaffolds/internal/templates/config/kdefault/enablecainection_patch.go

@@ -37,7 +37,8 @@ func (f *InjectCAPatch) SetTemplateDefaults() error {

 	f.TemplateBody = injectCAPatchTemplate

-	f.IfExistsAction = file.Error
+	// If file webhookcainjection_patch.yaml exist, skip its creation
+	f.IfExistsAction = file.Skip


I liked that 👍
Great work

camilamacedo86 · 2020-10-20T19:17:26Z

pkg/plugin/v3/scaffolds/init.go

 		&webhook.Kustomization{},
 		&webhook.KustomizeConfigWebhook{},
 		&webhook.Service{},


IMO, I think we need also move these ones to the webhook plugin as well since they are specific to the webhook plugin and are not useful to projects which as not in the webhooks. I mean, it shows to be the same scenario.

Yes, I also thinks the same.. Should I move all the webhook related scaffolding in this PR itself? Or should we wait for discussion to be finalized on #1644 ?

I understood that we agreed to move forward with into the bug triage. However, let's see if @estroz would like to hold on that until we finalized on #1644.

…ct to webhook creation

estroz

/lgtm

k8s-ci-robot · 2020-10-20T23:55:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: estroz, prafull01

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

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

estroz · 2020-10-20T23:56:00Z

I don't think this is a bug. @prafull01 can you remove :bug: and add :sparkles: to the title?

/hold

camilamacedo86 · 2020-10-21T19:55:08Z

Since @estroz /lgtm this one and just hold until the author be able to update its title with ✨ then, shows that all is done to get it merged. IMO: We will still require a follow up for https://github.com/kubernetes-sigs/kubebuilder/pull/1728/files#r508778432. To address that the issue #1734 was raised.
However, it shows fine we move forward with so

/hold cancel

estroz · 2020-10-21T19:56:25Z

The PR will merge with the wrong commit message if you remove the hold @camilamacedo86

/hold

estroz · 2020-10-21T19:57:27Z

Ah didn’t see the title was updated.

/hold cancel

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 19, 2020

k8s-ci-robot requested review from DirectXMan12 and joelanford October 19, 2020 16:37

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 19, 2020

k8s-ci-robot requested a review from camilamacedo86 October 19, 2020 16:37

estroz reviewed Oct 19, 2020

View reviewed changes

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

prafull01 force-pushed the webhook-cainjection branch from 19a7bd7 to ab3f59d Compare October 19, 2020 16:58

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

prafull01 force-pushed the webhook-cainjection branch from ab3f59d to 39bf637 Compare October 19, 2020 17:03

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 Oct 19, 2020

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 20, 2020

camilamacedo86 reviewed Oct 20, 2020

View reviewed changes

🐛 Fix the webhookcainjection_patch.yaml file creation from init proje…

54194e1

…ct to webhook creation

prafull01 force-pushed the webhook-cainjection branch from 39bf637 to 54194e1 Compare October 20, 2020 19:18

prafull01 requested a review from estroz October 20, 2020 20:28

estroz approved these changes Oct 20, 2020

View reviewed changes

k8s-ci-robot assigned estroz Oct 20, 2020

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

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 20, 2020

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

prafull01 changed the title ~~🐛 Fix the webhookcainjection_patch.yaml file creation from init project to webhook creation~~ ✨ Fix the webhookcainjection_patch.yaml file creation from init project to webhook creation Oct 21, 2020

prafull01 changed the title ~~✨ Fix the webhookcainjection_patch.yaml file creation from init project to webhook creation~~ ✨ Move the webhookcainjection_patch.yaml file creation from init project to webhook creation Oct 21, 2020

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 21, 2020

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

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 21, 2020

k8s-ci-robot merged commit 5439752 into kubernetes-sigs:master Oct 21, 2020

prafull01 deleted the webhook-cainjection branch October 21, 2020 20:19

camilamacedo86 mentioned this pull request Feb 18, 2021

New Release - proposing 3.0.0 stable #2029

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Move the webhookcainjection_patch.yaml file creation from init project to webhook creation #1728

✨ Move the webhookcainjection_patch.yaml file creation from init project to webhook creation #1728

prafull01 commented Oct 19, 2020 •

edited

Loading

k8s-ci-robot commented Oct 19, 2020

prafull01 commented Oct 19, 2020

estroz Oct 19, 2020

prafull01 Oct 19, 2020

estroz Oct 19, 2020

camilamacedo86 Oct 19, 2020 •

edited

Loading

estroz Oct 19, 2020

camilamacedo86 Oct 20, 2020 •

edited

Loading

estroz Oct 21, 2020

estroz left a comment

camilamacedo86 commented Oct 19, 2020

camilamacedo86 commented Oct 20, 2020

camilamacedo86 Oct 20, 2020

prafull01 Oct 20, 2020

camilamacedo86 Oct 20, 2020 •

edited

Loading

camilamacedo86 Oct 20, 2020

prafull01 Oct 20, 2020

camilamacedo86 Oct 20, 2020

estroz left a comment

k8s-ci-robot commented Oct 20, 2020

estroz commented Oct 20, 2020 •

edited

Loading

camilamacedo86 commented Oct 21, 2020 •

edited

Loading

estroz commented Oct 21, 2020 •

edited

Loading

estroz commented Oct 21, 2020

✨ Move the webhookcainjection_patch.yaml file creation from init project to webhook creation #1728

✨ Move the webhookcainjection_patch.yaml file creation from init project to webhook creation #1728

Conversation

prafull01 commented Oct 19, 2020 • edited Loading

k8s-ci-robot commented Oct 19, 2020

prafull01 commented Oct 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Oct 19, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Oct 20, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

estroz left a comment

Choose a reason for hiding this comment

camilamacedo86 commented Oct 19, 2020

camilamacedo86 commented Oct 20, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Oct 20, 2020 • edited Loading

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

estroz left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 20, 2020

estroz commented Oct 20, 2020 • edited Loading

camilamacedo86 commented Oct 21, 2020 • edited Loading

estroz commented Oct 21, 2020 • edited Loading

estroz commented Oct 21, 2020

prafull01 commented Oct 19, 2020 •

edited

Loading

camilamacedo86 Oct 19, 2020 •

edited

Loading

camilamacedo86 Oct 20, 2020 •

edited

Loading

camilamacedo86 Oct 20, 2020 •

edited

Loading

estroz commented Oct 20, 2020 •

edited

Loading

camilamacedo86 commented Oct 21, 2020 •

edited

Loading

estroz commented Oct 21, 2020 •

edited

Loading