https://github.com/snorwin/k8s-generic-webhook
The k8s-generic-webhook is a library to simplify the implementation of webhooks for arbitrary customer resources (CR) in the operator-sdk or controller-runtime.
https://github.com/snorwin/k8s-generic-webhook
admission-webhook controller-runtime k8s kubernetes openshift operator-sdk webhook
Last synced: about 2 months ago
JSON representation
The k8s-generic-webhook is a library to simplify the implementation of webhooks for arbitrary customer resources (CR) in the operator-sdk or controller-runtime.
- Host: GitHub
- URL: https://github.com/snorwin/k8s-generic-webhook
- Owner: snorwin
- License: apache-2.0
- Created: 2021-08-14T12:40:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-19T07:06:09.000Z (about 2 months ago)
- Last Synced: 2025-08-19T09:44:55.956Z (about 2 months ago)
- Topics: admission-webhook, controller-runtime, k8s, kubernetes, openshift, operator-sdk, webhook
- Language: Go
- Homepage:
- Size: 291 KB
- Stars: 16
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# k8s-generic-webhook
[](https://github.com/features/actions)
[](https://pkg.go.dev/github.com/snorwin/k8s-generic-webhook/pkg/webhook)
[](https://github.com/snorwin/k8s-generic-webhook/actions)
[](https://goreportcard.com/report/github.com/snorwin/k8s-generic-webhook)
[](https://coveralls.io/github/snorwin/k8s-generic-webhook?branch=main)
[](https://github.com/snorwin/k8s-generic-webhook/releases)
[](https://opensource.org/licenses/Apache-2.0)
The **k8s-generic-webhook** is a library to simplify the implementation of webhooks for arbitrary customer resources (CR) in the [operator-sdk](https://sdk.operatorframework.io/) or [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime).
Furthermore, it provides full access to the `AdmissionReview` request and decodes the `Object` in the request automatically. More sophistic webhook logic is facilitated by using the injected `Client` of the webhook which provides full access to the Kubernetes API.
## Quickstart
1. Initialize a new manager using the [operator-sdk](https://sdk.operatorframework.io/).
2. Create a pkg (e.g. `webhooks/pod`) and implement your webhook logic by embedding either the `ValidatingWebhook` or the `MuatatingWebhook`.
#### Example `ValidatingWebhook`
```go
package pod
import (
"context"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
"github.com/snorwin/k8s-generic-webhook/pkg/webhook"
)
type Webhook struct {
webhook.ValidatingWebhook
}
func (w *Webhook) SetupWebhookWithManager(mgr manager.Manager) error {
return webhook.NewGenericWebhookManagedBy(mgr).
For(&corev1.Pod{}).
Complete(w)
}
func (w *Webhook) ValidateCreate(ctx context.Context, request admission.Request, object runtime.Object) admission.Response {
_ = log.FromContext(ctx)
pod := object.(*corev1.Pod)
// TODO add your programmatic validation logic here
return admission.Allowed("")
}
```
#### Example `MutatingWebhook`
```go
package pod
import (
"context"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/runtime"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
"github.com/snorwin/k8s-generic-webhook/pkg/webhook"
)
type Webhook struct {
webhook.MutatingWebhook
}
func (w *Webhook) SetupWebhookWithManager(mgr manager.Manager) error {
return webhook.NewGenericWebhookManagedBy(mgr).
For(&corev1.Pod{}).
Complete(w)
}
func (w *Webhook) Mutate(ctx context.Context, request admission.Request, object runtime.Object) admission.Response {
_ = log.FromContext(ctx)
pod := object.(*corev1.Pod)
// TODO add your programmatic mutation logic here
return admission.Allowed("")
}
```
3. Add the following snippet to `main()` in `main.go` in order to register the webhook in the manager.
```go
if err = (&pod.Webhook{}).SetupWebhookWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create webhook", "webhook", "Pod")
os.Exit(1)
}
```