From 6616655b7b6c469ad20d919371ef00f035845e2f Mon Sep 17 00:00:00 2001 From: Indeed Date: Wed, 7 Jul 2021 14:20:13 -0700 Subject: [PATCH] create common interface for controllers. --- .../controller/interfaces.go | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 staging/src/k8s.io/controller-manager/controller/interfaces.go diff --git a/staging/src/k8s.io/controller-manager/controller/interfaces.go b/staging/src/k8s.io/controller-manager/controller/interfaces.go new file mode 100644 index 00000000000..6c9c0b96b61 --- /dev/null +++ b/staging/src/k8s.io/controller-manager/controller/interfaces.go @@ -0,0 +1,38 @@ +/* +Copyright 2021 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 controller + +import "net/http" + +// Interface defines the base of a controller managed by a controller manager +type Interface interface { + // Name returns the canonical name of the controller. + Name() string +} + +// Debuggable defines a controller that allows the controller manager +// to expose a debugging handler for the controller +// +// If a controller implements Debuggable, and the returned handler is +// not nil, the controller manager can mount the handler during startup. +type Debuggable interface { + // DebuggingHandler returns a Handler that expose debugging information + // for the controller, or nil if a debugging handler is not desired. + // + // The handler will be accessible at "/debug/controllers/{controllerName}/". + DebuggingHandler() http.Handler +}