webhook

Documentation

Overview

Package webhook is a generated GoMock package.

Package webhook implements utility routines related to Kubernetes' admission webhook.

Index

• Variables
• func AdmissionError(err error) *admissionv1.AdmissionResponse
• func DefaultingWebhookFor(defaulter Defaulter) *admission.Webhook
• func GetAdmissionRequestBody(w http.ResponseWriter, req *http.Request) ([]byte, error)
• func IsValidHostname(hostname string) error
• func IsValidIPOrCIDR(value string) []string
• func RecordAdmissionMetrics(req *admissionv1.AdmissionRequest, resp *admissionv1.AdmissionResponse)
• func ValidateParentRefs(refs []gwv1beta1.ParentReference) field.ErrorList
• func ValidateRouteHostnames(hostnames []gwv1beta1.Hostname) field.ErrorList
• func ValidatingWebhookFor(validator Validator) *admission.Webhook
• type CertRotatedFunc
• type Defaulter
• type MockRegister
  • func NewMockRegister(ctrl *gomock.Controller) *MockRegister
  • func (m *MockRegister) EXPECT() *MockRegisterMockRecorder
  • func (m *MockRegister) GetHandlers() map[string]http.Handler
  • func (m *MockRegister) GetWebhooks() ([]v1.MutatingWebhook, []v1.ValidatingWebhook)
• type MockRegisterMockRecorder
  • func (mr *MockRegisterMockRecorder) GetHandlers() *gomock.Call
  • func (mr *MockRegisterMockRecorder) GetWebhooks() *gomock.Call
• type Object
• type Register
• type RegisterConfig
• type Server
  • func NewServer(name, namespace string, port int, cm *certificate.Manager, ...) (*Server, error)
  • func (s *Server) Run(ctx context.Context)
• type Validator

Variables

var (

	// ContentTypeJSON is the supported content type for HTTP requests
	ContentTypeJSON = "application/json"

	// HTTPHeaderContentType is the Content-Type HTTP header key
	HTTPHeaderContentType = "Content-Type"

	// Deserializer is used to decode the admission request body
	Deserializer = codecs.UniversalDeserializer()
)

Functions

func AdmissionError

func AdmissionError(err error) *admissionv1.AdmissionResponse

AdmissionError wraps error as AdmissionResponse

func DefaultingWebhookFor

func DefaultingWebhookFor(defaulter Defaulter) *admission.Webhook

DefaultingWebhookFor returns a webhook that defaults the given object.

func GetAdmissionRequestBody

func GetAdmissionRequestBody(w http.ResponseWriter, req *http.Request) ([]byte, error)

GetAdmissionRequestBody returns the body of the admission request

func IsValidHostname

func IsValidHostname(hostname string) error

IsValidHostname validates the hostname of gateway route resource

func IsValidIPOrCIDR

func IsValidIPOrCIDR(value string) []string

IsValidIPOrCIDR tests that the argument is a valid IP address.

func RecordAdmissionMetrics

func RecordAdmissionMetrics(req *admissionv1.AdmissionRequest, resp *admissionv1.AdmissionResponse)

RecordAdmissionMetrics records metrics for the given admission response

func ValidateParentRefs

func ValidateParentRefs(refs []gwv1beta1.ParentReference) field.ErrorList

ValidateParentRefs validates the parent refs of gateway route resource

func ValidateRouteHostnames

func ValidateRouteHostnames(hostnames []gwv1beta1.Hostname) field.ErrorList

ValidateRouteHostnames validates the hostnames of gateway route resource

func ValidatingWebhookFor

func ValidatingWebhookFor(validator Validator) *admission.Webhook

ValidatingWebhookFor returns a new validating webhook for the given validator.

Types

type CertRotatedFunc

type CertRotatedFunc func(cert *certificate.Certificate) error

CertRotatedFunc is a callback to perform other actions when the server's HTTPS cert gets rotated.

type Defaulter

type Defaulter interface {
	Object
	SetDefaults(obj interface{})
}

Defaulter is the interface for webhook defaulters

type MockRegister

type MockRegister struct {
	// contains filtered or unexported fields
}

MockRegister is a mock of Register interface.

func NewMockRegister

func NewMockRegister(ctrl *gomock.Controller) *MockRegister

NewMockRegister creates a new mock instance.

func (*MockRegister) EXPECT

func (m *MockRegister) EXPECT() *MockRegisterMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockRegister) GetHandlers

func (m *MockRegister) GetHandlers() map[string]http.Handler

GetHandlers mocks base method.

func (*MockRegister) GetWebhooks

func (m *MockRegister) GetWebhooks() ([]v1.MutatingWebhook, []v1.ValidatingWebhook)

GetWebhooks mocks base method.

type MockRegisterMockRecorder

type MockRegisterMockRecorder struct {
	// contains filtered or unexported fields
}

MockRegisterMockRecorder is the mock recorder for MockRegister.

func (*MockRegisterMockRecorder) GetHandlers

func (mr *MockRegisterMockRecorder) GetHandlers() *gomock.Call

GetHandlers indicates an expected call of GetHandlers.

func (*MockRegisterMockRecorder) GetWebhooks

func (mr *MockRegisterMockRecorder) GetWebhooks() *gomock.Call

GetWebhooks indicates an expected call of GetWebhooks.

type Object

type Object interface {
	RuntimeObject() runtime.Object
}

Object is the interface for webhook objects

type Register

type Register interface {
	GetWebhooks() ([]admissionregv1.MutatingWebhook, []admissionregv1.ValidatingWebhook)
	GetHandlers() map[string]http.Handler
}

Register is the interface for webhook registers

type RegisterConfig

type RegisterConfig struct {
	*fctx.ControllerContext
	WebhookSvcNs   string
	WebhookSvcName string
	CaBundle       []byte
}

RegisterConfig is the configuration for webhook registers

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is a construct to run generic HTTPS webhook servers.

func NewServer

func NewServer(name, namespace string, port int, cm *certificate.Manager, handlers map[string]http.HandlerFunc, onCertChange CertRotatedFunc) (*Server, error)

NewServer returns a new server based on the input. Run() must be called to start the server.

func (*Server) Run

func (s *Server) Run(ctx context.Context)

Run actually starts the server. It blocks until the passed in context is done.

type Validator

type Validator interface {
	Object
	ValidateCreate(obj interface{}) error
	ValidateUpdate(oldObj, obj interface{}) error
	ValidateDelete(obj interface{}) error
}

Validator is the interface for webhook validators