/* Copyright 2018 The Kubernetes Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package webhook_test import ( "context" "net/http" "k8s.io/client-go/kubernetes/scheme" ctrl "sigs.k8s.io/controller-runtime" logf "sigs.k8s.io/controller-runtime/pkg/internal/log" "sigs.k8s.io/controller-runtime/pkg/manager/signals" . "sigs.k8s.io/controller-runtime/pkg/webhook" "sigs.k8s.io/controller-runtime/pkg/webhook/admission" ) var ( // Build webhooks used for the various server // configuration options // // These handlers could be also be implementations // of the AdmissionHandler interface for more complex // implementations. mutatingHook = &Admission{ Handler: admission.HandlerFunc(func(ctx context.Context, req AdmissionRequest) AdmissionResponse { return Patched("some changes", JSONPatchOp{Operation: "add", Path: "/metadata/annotations/access", Value: "granted"}, JSONPatchOp{Operation: "add", Path: "/metadata/annotations/reason", Value: "not so secret"}, ) }), } validatingHook = &Admission{ Handler: admission.HandlerFunc(func(ctx context.Context, req AdmissionRequest) AdmissionResponse { return Denied("none shall pass!") }), } ) // This example registers a webhooks to a webhook server // that gets ran by a controller manager. func Example() { // Create a manager // Note: GetConfigOrDie will os.Exit(1) w/o any message if no kube-config can be found mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{}) if err != nil { panic(err) } // Create a webhook server. hookServer := &Server{ Port: 8443, } if err := mgr.Add(hookServer); err != nil { panic(err) } // Register the webhooks in the server. hookServer.Register("/mutating", mutatingHook) hookServer.Register("/validating", validatingHook) // Start the server by starting a previously-set-up manager err = mgr.Start(ctrl.SetupSignalHandler()) if err != nil { // handle error panic(err) } } // This example creates a webhook server that can be // ran without a controller manager. // // Note that this assumes and requires a valid TLS // cert and key at the default locations // tls.crt and tls.key. func ExampleServer_StartStandalone() { // Create a webhook server hookServer := &Server{ Port: 8443, } // Register the webhooks in the server. hookServer.Register("/mutating", mutatingHook) hookServer.Register("/validating", validatingHook) // Start the server without a manger err := hookServer.StartStandalone(signals.SetupSignalHandler(), scheme.Scheme) if err != nil { // handle error panic(err) } } // This example creates a standalone webhook handler // and runs it on a vanilla go HTTP server to demonstrate // how you could run a webhook on an existing server // without a controller manager. func ExampleStandaloneWebhook() { // Assume you have an existing HTTP server at your disposal // configured as desired (e.g. with TLS). // For this example just create a basic http.ServeMux mux := http.NewServeMux() port := ":8000" // Create the standalone HTTP handlers from our webhooks mutatingHookHandler, err := admission.StandaloneWebhook(mutatingHook, admission.StandaloneOptions{ Scheme: scheme.Scheme, // Logger let's you optionally pass // a custom logger (defaults to log.Log global Logger) Logger: logf.RuntimeLog.WithName("mutating-webhook"), // MetricsPath let's you optionally // provide the path it will be served on // to be used for labelling prometheus metrics // If none is set, prometheus metrics will not be generated. MetricsPath: "/mutating", }) if err != nil { // handle error panic(err) } validatingHookHandler, err := admission.StandaloneWebhook(validatingHook, admission.StandaloneOptions{ Scheme: scheme.Scheme, Logger: logf.RuntimeLog.WithName("validating-webhook"), MetricsPath: "/validating", }) if err != nil { // handle error panic(err) } // Register the webhook handlers to your server mux.Handle("/mutating", mutatingHookHandler) mux.Handle("/validating", validatingHookHandler) // Run your handler if err := http.ListenAndServe(port, mux); err != nil { panic(err) } }