Skip to content

Add webhook.create: false warning comment#4579

Merged
gusfcarvalho merged 1 commit intoexternal-secrets:mainfrom
thecosmicfrog:add-webhook-false-warning-comment
Mar 22, 2025
Merged

Add webhook.create: false warning comment#4579
gusfcarvalho merged 1 commit intoexternal-secrets:mainfrom
thecosmicfrog:add-webhook-false-warning-comment

Conversation

@thecosmicfrog
Copy link
Copy Markdown
Contributor

  • Duplicated crds.conversion.enabled: false comment stating that webhook.create should be set to false.
  • This coupling is easy missable when creating an override values.yaml file.

Problem Statement

It's easy to miss that, when setting webhook.create: false, you should also set crds.conversion.enabled: false to avoid hammering the kubeapi. We noticed a lot of nuisance logs because we missed this when installing ESO.

Proposed Changes

Just a minor duplication of an already-existing comment (above crds.conversion.enabled) to try and avoid this problem for future users.

Checklist

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage
  • All tests pass with make test
  • I ensured my PR is ready for review with make reviewable

@thecosmicfrog thecosmicfrog force-pushed the add-webhook-false-warning-comment branch from 40a6025 to b8756bc Compare March 22, 2025 21:37
@thecosmicfrog thecosmicfrog marked this pull request as ready for review March 22, 2025 21:38
@thecosmicfrog thecosmicfrog requested a review from a team as a code owner March 22, 2025 21:38
gusfcarvalho
gusfcarvalho previously approved these changes Mar 22, 2025
| webhook.certManager.cert.revisionHistoryLimit | int | `0` | Set the revisionHistoryLimit on the Certificate. See https://cert-manager.io/docs/reference/api-docs/#cert-manager.io/v1.CertificateSpec Defaults to 0 (ignored). |
| webhook.certManager.enabled | bool | `false` | Enabling cert-manager support will disable the built in secret and switch to using cert-manager (installed separately) to automatically issue and renew the webhook certificate. This chart does not install cert-manager for you, See https://cert-manager.io/docs/ |
| webhook.create | bool | `true` | Specifies whether a webhook deployment be created. |
| webhook.create | bool | `true` | If set to false, crds.conversion.enabled should also be set to false otherwise the kubeapi will be hammered because the conversion is looking for a webhook endpoint. |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems the original flag explaining the webhook was taken away. I think youll need to make this a single line

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem - I'll fix now. Thanks @gusfcarvalho.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's now fixed - thanks @gusfcarvalho.

@gusfcarvalho
Copy link
Copy Markdown
Member

Sorry for the misapproval! I think the generation didn't quite work as you expected @thecosmicfrog

* Duplicated `crds.conversion.enabled: false` comment stating
  that `webhook.create` should be set to `false`.
* This coupling is easy missable when creating an override `values.yaml`
  file.

Signed-off-by: Aaron Hastings <aaron@aaronhastings.me>
@sonarqubecloud
Copy link
Copy Markdown

@gusfcarvalho gusfcarvalho merged commit 7b9fa17 into external-secrets:main Mar 22, 2025
3 checks passed
@thecosmicfrog
Copy link
Copy Markdown
Contributor Author

Thanks for the merge @gusfcarvalho!

aakashagg pushed a commit to aakashagg/external-secrets that referenced this pull request Mar 23, 2025
* Duplicated `crds.conversion.enabled: false` comment stating
  that `webhook.create` should be set to `false`.
* This coupling is easy missable when creating an override `values.yaml`
  file.

Signed-off-by: Aaron Hastings <aaron@aaronhastings.me>
Signed-off-by: aakashagg <agarwalaakash202@gmail.com>
aakashagg pushed a commit to aakashagg/external-secrets that referenced this pull request Mar 23, 2025
* Duplicated `crds.conversion.enabled: false` comment stating
  that `webhook.create` should be set to `false`.
* This coupling is easy missable when creating an override `values.yaml`
  file.

Signed-off-by: Aaron Hastings <aaron@aaronhastings.me>
Signed-off-by: aakashagg <agarwalaakash202@gmail.com>
aakashagg pushed a commit to aakashagg/external-secrets that referenced this pull request Mar 23, 2025
* Duplicated `crds.conversion.enabled: false` comment stating
  that `webhook.create` should be set to `false`.
* This coupling is easy missable when creating an override `values.yaml`
  file.

Signed-off-by: Aaron Hastings <aaron@aaronhastings.me>
Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

Revert "Add `webhook.create: false` warning comment (external-secrets#4579)"

This reverts commit 41f8344.
Skarlso added a commit that referenced this pull request Mar 23, 2025
* adding conjur description

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

* adding into Golang Struct models

Your commit message

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

* Add `webhook.create: false` warning comment (#4579)

* Duplicated `crds.conversion.enabled: false` comment stating
  that `webhook.create` should be set to `false`.
* This coupling is easy missable when creating an override `values.yaml`
  file.

Signed-off-by: Aaron Hastings <aaron@aaronhastings.me>
Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

Revert "Add `webhook.create: false` warning comment (#4579)"

This reverts commit 41f8344.

* generating API doc

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>

---------

Signed-off-by: aakashagg <agarwalaakash202@gmail.com>
Co-authored-by: Aaron Hastings <thecosmicfrog@users.noreply.github.com>
Co-authored-by: Gergely Brautigam <182850+Skarlso@users.noreply.github.com>
ivankatliarchuk added a commit to gofogo/external-secrets-fork that referenced this pull request Mar 25, 2025
* main:
  update dependencies (external-secrets#4589)
  chore(deps): bump fossas/fossa-action from 1.5.0 to 1.6.0 (external-secrets#4586)
  chore(deps): bump mkdocs-material from 9.6.8 to 9.6.9 in /hack/api-docs (external-secrets#4588)
  chore(deps): bump platformdirs from 4.3.6 to 4.3.7 in /hack/api-docs (external-secrets#4587)
  chore(deps): bump github/codeql-action from 3.28.11 to 3.28.12 (external-secrets#4585)
  chore(deps): bump actions/setup-go from 5.3.0 to 5.4.0 (external-secrets#4584)
  chore(deps): bump golangci/golangci-lint-action from 6.5.1 to 6.5.2 (external-secrets#4583)
  chore(deps): bump actions/cache from 4.2.2 to 4.2.3 (external-secrets#4582)
  chore(deps): bump ubi8/ubi from `5993454` to `8bd1b63` (external-secrets#4581)
  Lookup cluster identity from instance metadata (external-secrets#4575)
  adding conjur description (external-secrets#4578)
  fix: bump jwt for cve fix (external-secrets#4580)
  Add `webhook.create: false` warning comment (external-secrets#4579)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants