webhook

Documentation

Index

• func CreateCerts(ctx context.Context, name, namespace string) (serverKey, serverCert, caCert []byte, err error)
• func SetUserInfoAnnotations(resource apis.HasSpec, ctx context.Context, groupName string)
• type AdmissionController
  • func NewAdmissionController(client kubernetes.Interface, opts ControllerOptions, ...) (*AdmissionController, error)
  • func (ac *AdmissionController) Run(stop <-chan struct{}) error
  • func (ac *AdmissionController) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type ControllerOptions
• type GenericCRD
• type ResourceCallback
• type ResourceDefaulter
• type StatsReporter
  • func NewStatsReporter() (StatsReporter, error)

Functions

func CreateCerts

func CreateCerts(ctx context.Context, name, namespace string) (serverKey, serverCert, caCert []byte, err error)

CreateCerts creates and returns a CA certificate and certificate and key for the server. serverKey and serverCert are used by the server to establish trust for clients, CA certificate is used by the client to verify the server authentication chain.

func SetUserInfoAnnotations

func SetUserInfoAnnotations(resource apis.HasSpec, ctx context.Context, groupName string)

SetUserInfoAnnotations sets creator and updater annotations on a resource.

Types

type AdmissionController

type AdmissionController struct {
	Client   kubernetes.Interface
	Options  ControllerOptions
	Handlers map[schema.GroupVersionKind]GenericCRD
	Logger   *zap.SugaredLogger

	WithContext           func(context.Context) context.Context
	DisallowUnknownFields bool
}

AdmissionController implements the external admission webhook for validation of pilot configuration.

func NewAdmissionController

func NewAdmissionController(
	client kubernetes.Interface,
	opts ControllerOptions,
	handlers map[schema.GroupVersionKind]GenericCRD,
	logger *zap.SugaredLogger,
	ctx func(context.Context) context.Context,
	disallowUnknownFields bool) (*AdmissionController, error)

NewAdmissionController constructs an AdmissionController

func (*AdmissionController) Run

func (ac *AdmissionController) Run(stop <-chan struct{}) error

Run implements the admission controller run loop.

func (*AdmissionController) ServeHTTP

func (ac *AdmissionController) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements the external admission webhook for mutating serving resources.

type ControllerOptions

type ControllerOptions struct {
	// WebhookName is the name of the webhook we create to handle
	// mutations before they get stored in the storage.
	WebhookName string

	// ServiceName is the service name of the webhook.
	ServiceName string

	// DeploymentName is the service name of the webhook.
	DeploymentName string

	// SecretName is the name of k8s secret that contains the webhook
	// server key/cert and corresponding CA cert that signed them. The
	// server key/cert are used to serve the webhook and the CA cert
	// is provided to k8s apiserver during admission controller
	// registration.
	SecretName string

	// Namespace is the namespace in which everything above lives.
	Namespace string

	// Port where the webhook is served. Per k8s admission
	// registration requirements this should be 443 unless there is
	// only a single port for the service.
	Port int

	// RegistrationDelay controls how long admission registration
	// occurs after the webhook is started. This is used to avoid
	// potential races where registration completes and k8s apiserver
	// invokes the webhook before the HTTP server is started.
	RegistrationDelay time.Duration

	// ClientAuthType declares the policy the webhook server will follow for
	// TLS Client Authentication.
	// The default value is tls.NoClientCert.
	ClientAuth tls.ClientAuthType

	// StatsReporter reports metrics about the webhook.
	// This will be automatically initialized by the constructor if left uninitialized.
	StatsReporter StatsReporter
}

ControllerOptions contains the configuration for the webhook

type GenericCRD

type GenericCRD interface {
	apis.Defaultable
	apis.Validatable
	runtime.Object
}

GenericCRD is the interface definition that allows us to perform the generic CRD actions like deciding whether to increment generation and so forth.

type ResourceCallback

type ResourceCallback func(patches *[]jsonpatch.JsonPatchOperation, old GenericCRD, new GenericCRD) error

ResourceCallback defines a signature for resource specific (Route, Configuration, etc.) handlers that can validate and mutate an object. If non-nil error is returned, object creation is denied. Mutations should be appended to the patches operations.

type ResourceDefaulter

type ResourceDefaulter func(patches *[]jsonpatch.JsonPatchOperation, crd GenericCRD) error

ResourceDefaulter defines a signature for resource specific (Route, Configuration, etc.) handlers that can set defaults on an object. If non-nil error is returned, object creation is denied. Mutations should be appended to the patches operations.

type StatsReporter

type StatsReporter interface {
	ReportRequest(request *admissionv1beta1.AdmissionRequest, response *admissionv1beta1.AdmissionResponse, d time.Duration) error
}

StatsReporter reports webhook metrics

func NewStatsReporter

func NewStatsReporter() (StatsReporter, error)

NewStatsReporter creaters a reporter for webhook metrics