🐛 stop to generate crd webhooks patches and cainjetions for any CRD/API and projects without webhooks #3647

camilamacedo86 · 2023-10-01T18:04:30Z

Description

What Problem This PR Solves

Projects without webhooks currently malfunction because we are scaffolding configurations during API creation that are exclusively valid for webhooks.

Details

Currently, our process automatically scaffolds config/crd/patches and CA injections for every CRD, without taking into consideration if webhooks are enabled in the project. These configurations are, in fact, only applicable when the project has webhooks enabled.

This one-size-fits-all approach causes failures in projects without webhooks, as observed by @lowang-bh in their attempt to rectify the situation with kubebuilder pull request #3585.

While the intention behind PR #3585 was sound, the implementation was not thorough. The proposed solution merely added an extra space and missed uncommenting the option when generating webhooks. This oversight meant that the necessary patches were not scaffolded for each API (CRD) created. These patches are only relevant for APIs (CRDs) that have webhooks:

In addition to the primary fix, this PR introduces a new end-to-end test to validate our changes and prevent such issues from reoccurring. This test generates a project without webhooks and verifies that everything functions as expected:

Given the comprehensive nature of this fix, the following issues and pull requests can now be closed:

camilamacedo86 · 2023-10-01T21:55:20Z

...s/common/kustomize/v2/scaffolds/internal/templates/config/crd/patches/enablewebhook_patch.go

@@ -49,30 +49,19 @@ func (f *EnableWebhookPatch) SetTemplateDefaults() error {
 }

 const enableWebhookPatchTemplate = `# The following patch enables a conversion webhook for the CRD
-{{- if ne .Resource.API.CRDVersion "v1" }}


CRD v1beat1 is no longer supported
We are removing because the subCommend webhook has not the implementation to return it. Due the fact of that the code under the condition cannot be used since k8s 1.22 make no sense keep it and change the subCommand to get the value from the resources tracked in the PROJECT config.

camilamacedo86 · 2023-10-01T21:55:27Z

pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/crd/kustomizeconfig.go


 namespace:
 - kind: CustomResourceDefinition
-  version: {{ .Resource.API.CRDVersion }}


CRD v1beta1 is now unsupported. It's being removed as the subCommand webhook lacks the necessary implementation to retrieve it. Given that the related code has been unusable since k8s 1.22, there's no rationale to maintain it and modify the subCommand to extract values from resources in the PROJECT config.

camilamacedo86 · 2023-10-01T22:20:24Z

pkg/plugins/common/kustomize/v2/scaffolds/api.go

@@ -76,8 +75,6 @@ func (s *apiScaffolder) Scaffold() error {
 			&samples.CRDSample{Force: s.force},
 			&rbac.CRDEditorRole{},
 			&rbac.CRDViewerRole{},
-			&patches.EnableWebhookPatch{},
-			&patches.EnableCAInjectionPatch{},


It should only be generated with the scaffolding of a webhook. Hence, it's been moved to the webhook subcommand.

camilamacedo86 · 2023-10-01T22:43:11Z

@lowang

See that I added your PR here and address a few nits on top of that to make work.
Could you please give a hand on the review of this one?

camilamacedo86 · 2023-10-01T22:47:57Z

pkg/plugins/common/kustomize/v2/scaffolds/webhook.go

+		&patches.EnableCAInjectionPatch{},
+	); err != nil {
+		return fmt.Errorf("error scaffolding kustomize webhook manifests: %v", err)
+	}


We are just putting the execution here to occur before we start uncomment the pacthes and etc. We have not the scaffold to uncomment before the execution.

However the only chnage here is to add the following generations that should be made ONLY when we scaffold a webhook for the API and not for each API:

&patches.EnableWebhookPatch{},
&patches.EnableCAInjectionPatch{},

camilamacedo86 · 2023-10-02T06:50:59Z

...s/common/kustomize/v2/scaffolds/internal/templates/config/crd/patches/enablewebhook_patch.go

-        namespace: system
-        name: webhook-service
-        path: /convert
-    {{- else }}


Same of: https://github.com/kubernetes-sigs/kubebuilder/pull/3647/files#r1342193166

camilamacedo86 · 2023-10-02T06:53:48Z

pkg/plugins/common/kustomize/v2/scaffolds/webhook.go

+		if !hasWebHookUncommented || err != nil {
+			log.Errorf("Unable to find the target(s) #configurations:\n#- kustomizeconfig.yaml to uncomment in the file "+
+				"%s.", crdKustomizationsFilePath)
+		}


It will uncomment the
configurations:

kustomizeconfig

When webhooks are scaffold
The kustomizeconfig has the patches under config/crd/patches which are relevant only when we scaffold webhooks for the CRD

camilamacedo86 · 2023-10-02T06:56:55Z

test/e2e/v4/generate_test.go

 func GenerateV4(kbc *utils.TestContext) {
-	var err error
+	initingTheProject(kbc)
+	creatingAPI(kbc)


In the e2e tests, we've made the following modifications:

Refactored the code for initializing and creating an API into a function, enabling reuse in both the existing and new tests.

Moved the code segment for uncommenting when webhooks/certmanager is disabled into a constant.

Introduced a new test that replicates all the standard checks (excluding webhook-specific ones) to validate that a project without enabled webhooks deploys and operates as intended.

… and projects without webhooks At present, we scaffold config/crd/patches, kustomizations, and CA injections for every CRD, irrespective of whether webhooks are enabled in the project or not. However, these configurations are only relevant and valid if the project has webhooks. Consequently, for projects without webhooks, this leads to failures as documented in kubebuilder pull request kubernetes-sigs#3585. To address this, we are now introducing a test to ensure that projects without enabled webhooks function correctly and as anticipated. Signed-off-by: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Co-authored-by: lowang-bh <lhui_wang@163.com>

varshaprasad96

These changes look good to me. Thanks @camilamacedo86 and @lowang-bh for finding and fixing this.

/lgtm
/approve

I haven't tested this with other plugin versions, but a small question - if this is happening with go/v4, does this happen with v3 also? I know we have deprecated it, but just wanted to verify. I am believing apart from the project structure the scaffolding logic is the same for both the versions.

k8s-ci-robot · 2023-10-12T22:24:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, varshaprasad96

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~~ [camilamacedo86,varshaprasad96]

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

camilamacedo86 · 2023-10-13T13:51:24Z

Hi @varshaprasad96,

Thank you for your support and thorough review. I'd like to address your question:

if this is happening with go/v4, does this happen with v3 also? I know we have deprecated it, but just wanted to verify. I am believing apart from the project structure the scaffolding logic is the same for both the versions.

We deprecated go/v3 some time ago. As a result, we don't currently run tests against this version. In my opinion, we should avoid making changes to the deprecated version unless we encounter a very critical issue that necessitates a fix specifically for that version. (Honest, I am not able to think of a scenario where would be mandatory for us to backport the fix)

Those fix does not change go/v3, it utilizes kustomize/v1 (reference: here). All ongoing changes made are on kustomize/v2 (used by go/v4 only).

varshaprasad96 · 2023-10-13T16:13:10Z

Thanks for the info @camilamacedo86

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 1, 2023

k8s-ci-robot requested review from everettraven and Kavinjsir October 1, 2023 18:04

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

camilamacedo86 requested a review from Sajiyah-Salat October 1, 2023 18:05

camilamacedo86 mentioned this pull request Oct 1, 2023

Enhance e2e Test by Adding a Method to Generate Project without Webhooks #3618

Closed

camilamacedo86 force-pushed the add-test-without-webhook branch from 8e788f7 to 96508c3 Compare October 1, 2023 18:19

camilamacedo86 changed the title ~~🌱 add new test to check projects without webhooks~~ WIP : 🌱 add new test to check projects without webhooks Oct 1, 2023

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 1, 2023

camilamacedo86 force-pushed the add-test-without-webhook branch from 96508c3 to 2407612 Compare October 1, 2023 19:59

camilamacedo86 changed the title ~~WIP : 🌱 add new test to check projects without webhooks~~ WIP : 🐛 not enable configurations kustomize config when webhooks are not enabled Oct 1, 2023

kubernetes-sigs deleted a comment from k8s-ci-robot Oct 1, 2023

camilamacedo86 force-pushed the add-test-without-webhook branch from 2407612 to 7841f64 Compare October 1, 2023 20:29

camilamacedo86 changed the title ~~WIP : 🐛 not enable configurations kustomize config when webhooks are not enabled~~ WIP : 🐛 not enable configurations into crd kustomize config to teach webhooks when those are not enabled Oct 1, 2023

camilamacedo86 changed the title ~~WIP : 🐛 not enable configurations into crd kustomize config to teach webhooks when those are not enabled~~ 🐛 (kustomize/v2,go/v4): not enable configurations into crd kustomize config to teach webhooks when those are not enabled Oct 1, 2023

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 Oct 1, 2023

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. 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 Oct 1, 2023

camilamacedo86 changed the title ~~WIP: 🐛 (kustomize/v2,go/v4): not enable configurations into crd kustomize config to teach webhooks when those are not enabled~~ 🐛just generate crd webhooks patches and ca injestions when webhooks are created for those Oct 1, 2023

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 Oct 1, 2023

camilamacedo86 force-pushed the add-test-without-webhook branch from 97bf0df to fb61d82 Compare October 1, 2023 21:50

camilamacedo86 changed the title ~~🐛just generate crd webhooks patches and ca injestions when webhooks are created for those~~ 🐛only generate crd webhooks patches and cainjetions when webhooks are created for those Oct 1, 2023

camilamacedo86 changed the title ~~🐛only generate crd webhooks patches and cainjetions when webhooks are created for those~~ 🐛 stop to generate crd webhooks patches and cainjetions for any CRD/API and projects without webhooks Oct 1, 2023

kubernetes-sigs deleted a comment from k8s-ci-robot Oct 1, 2023

camilamacedo86 force-pushed the add-test-without-webhook branch from fb61d82 to fdfab55 Compare October 1, 2023 21:54

camilamacedo86 commented Oct 1, 2023

View reviewed changes

camilamacedo86 force-pushed the add-test-without-webhook branch from fdfab55 to 6d5ae4e Compare October 1, 2023 21:57

camilamacedo86 mentioned this pull request Oct 1, 2023

Patches for webhooks has been created for any API #3630

Closed

camilamacedo86 force-pushed the add-test-without-webhook branch from 6d5ae4e to c8e81ac Compare October 1, 2023 22:19

camilamacedo86 commented Oct 1, 2023

View reviewed changes

camilamacedo86 commented Oct 2, 2023

View reviewed changes

camilamacedo86 requested review from rashmigottipati and varshaprasad96 October 2, 2023 06:52

camilamacedo86 commented Oct 2, 2023

View reviewed changes

camilamacedo86 mentioned this pull request Oct 2, 2023

🐛 (kustomize/v2, go/v4): fix issue to don't set kustomizeconfig.yaml when Webhooks are not enable into the project #3585

Closed

camilamacedo86 force-pushed the add-test-without-webhook branch from c8e81ac to a4ad443 Compare October 10, 2023 08:03

varshaprasad96 approved these changes Oct 12, 2023

View reviewed changes

k8s-ci-robot assigned varshaprasad96 Oct 12, 2023

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

k8s-ci-robot merged commit 45546a9 into kubernetes-sigs:master Oct 12, 2023
18 checks passed

camilamacedo86 deleted the add-test-without-webhook branch October 13, 2023 13:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐛 stop to generate crd webhooks patches and cainjetions for any CRD/API and projects without webhooks #3647

🐛 stop to generate crd webhooks patches and cainjetions for any CRD/API and projects without webhooks #3647

camilamacedo86 commented Oct 1, 2023 •

edited

camilamacedo86 Oct 1, 2023 •

edited

camilamacedo86 Oct 1, 2023 •

edited

camilamacedo86 Oct 1, 2023 •

edited

camilamacedo86 commented Oct 1, 2023

camilamacedo86 Oct 1, 2023 •

edited

camilamacedo86 Oct 2, 2023

camilamacedo86 Oct 2, 2023

camilamacedo86 Oct 2, 2023

varshaprasad96 left a comment

k8s-ci-robot commented Oct 12, 2023

camilamacedo86 commented Oct 13, 2023

varshaprasad96 commented Oct 13, 2023 •

edited

🐛 stop to generate crd webhooks patches and cainjetions for any CRD/API and projects without webhooks #3647

🐛 stop to generate crd webhooks patches and cainjetions for any CRD/API and projects without webhooks #3647

Conversation

camilamacedo86 commented Oct 1, 2023 • edited

Description

What Problem This PR Solves

Details

camilamacedo86 Oct 1, 2023 • edited

Choose a reason for hiding this comment

camilamacedo86 Oct 1, 2023 • edited

Choose a reason for hiding this comment

camilamacedo86 Oct 1, 2023 • edited

Choose a reason for hiding this comment

camilamacedo86 commented Oct 1, 2023

camilamacedo86 Oct 1, 2023 • edited

Choose a reason for hiding this comment

camilamacedo86 Oct 2, 2023

Choose a reason for hiding this comment

camilamacedo86 Oct 2, 2023

Choose a reason for hiding this comment

camilamacedo86 Oct 2, 2023

Choose a reason for hiding this comment

varshaprasad96 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 12, 2023

camilamacedo86 commented Oct 13, 2023

varshaprasad96 commented Oct 13, 2023 • edited

camilamacedo86 commented Oct 1, 2023 •

edited

camilamacedo86 Oct 1, 2023 •

edited

camilamacedo86 Oct 1, 2023 •

edited

camilamacedo86 Oct 1, 2023 •

edited

camilamacedo86 Oct 1, 2023 •

edited

varshaprasad96 commented Oct 13, 2023 •

edited