From cef787695235fb0fee1783f9e68edbc345147801 Mon Sep 17 00:00:00 2001 From: Yan Yao Date: Sat, 6 Jun 2020 19:57:21 -0700 Subject: [PATCH] Fix golint failures in pkg/kubelet/lifecycle Co-authored-by: Sergey Kanzhelev --- hack/.golint_failures | 1 - .../admission_failure_handler_stub.go | 2 ++ pkg/kubelet/lifecycle/doc.go | 4 ++-- pkg/kubelet/lifecycle/handlers.go | 19 +++++++++++++------ pkg/kubelet/lifecycle/predicate.go | 4 +++- 5 files changed, 20 insertions(+), 10 deletions(-) diff --git a/hack/.golint_failures b/hack/.golint_failures index b09e9d37fc9..df1b70922ee 100644 --- a/hack/.golint_failures +++ b/hack/.golint_failures @@ -106,7 +106,6 @@ pkg/kubelet/dockershim/network/hostport pkg/kubelet/dockershim/network/hostport/testing pkg/kubelet/dockershim/network/kubenet pkg/kubelet/dockershim/network/testing -pkg/kubelet/lifecycle pkg/kubelet/pluginmanager/pluginwatcher pkg/kubelet/pod/testing pkg/kubelet/preemption diff --git a/pkg/kubelet/lifecycle/admission_failure_handler_stub.go b/pkg/kubelet/lifecycle/admission_failure_handler_stub.go index 09f7dc1999d..d22df740955 100644 --- a/pkg/kubelet/lifecycle/admission_failure_handler_stub.go +++ b/pkg/kubelet/lifecycle/admission_failure_handler_stub.go @@ -26,10 +26,12 @@ type AdmissionFailureHandlerStub struct{} var _ AdmissionFailureHandler = &AdmissionFailureHandlerStub{} +// NewAdmissionFailureHandlerStub returns an instance of AdmissionFailureHandlerStub. func NewAdmissionFailureHandlerStub() *AdmissionFailureHandlerStub { return &AdmissionFailureHandlerStub{} } +// HandleAdmissionFailure simply passes admission rejection on, with no special handling. func (n *AdmissionFailureHandlerStub) HandleAdmissionFailure(admitPod *v1.Pod, failureReasons []PredicateFailureReason) ([]PredicateFailureReason, error) { return failureReasons, nil } diff --git a/pkg/kubelet/lifecycle/doc.go b/pkg/kubelet/lifecycle/doc.go index a6be2c40cc8..eab81169a0e 100644 --- a/pkg/kubelet/lifecycle/doc.go +++ b/pkg/kubelet/lifecycle/doc.go @@ -14,6 +14,6 @@ See the License for the specific language governing permissions and limitations under the License. */ -// Handlers for pod lifecycle events and interfaces to integrate -// with kubelet admission, synchronization, and eviction of pods. +// Package lifecycle contains handlers for pod lifecycle events and interfaces +// to integrate with kubelet admission, synchronization, and eviction of pods. package lifecycle // import "k8s.io/kubernetes/pkg/kubelet/lifecycle" diff --git a/pkg/kubelet/lifecycle/handlers.go b/pkg/kubelet/lifecycle/handlers.go index 4edd909ebfe..b71682f4beb 100644 --- a/pkg/kubelet/lifecycle/handlers.go +++ b/pkg/kubelet/lifecycle/handlers.go @@ -37,7 +37,7 @@ const ( maxRespBodyLength = 10 * 1 << 10 // 10KB ) -type HandlerRunner struct { +type handlerRunner struct { httpGetter kubetypes.HTTPGetter commandRunner kubecontainer.CommandRunner containerManager podStatusProvider @@ -47,15 +47,16 @@ type podStatusProvider interface { GetPodStatus(uid types.UID, name, namespace string) (*kubecontainer.PodStatus, error) } +// NewHandlerRunner returns a configured lifecycle handler for a container. func NewHandlerRunner(httpGetter kubetypes.HTTPGetter, commandRunner kubecontainer.CommandRunner, containerManager podStatusProvider) kubecontainer.HandlerRunner { - return &HandlerRunner{ + return &handlerRunner{ httpGetter: httpGetter, commandRunner: commandRunner, containerManager: containerManager, } } -func (hr *HandlerRunner) Run(containerID kubecontainer.ContainerID, pod *v1.Pod, container *v1.Container, handler *v1.Handler) (string, error) { +func (hr *handlerRunner) Run(containerID kubecontainer.ContainerID, pod *v1.Pod, container *v1.Container, handler *v1.Handler) (string, error) { switch { case handler.Exec != nil: var msg string @@ -104,7 +105,7 @@ func resolvePort(portReference intstr.IntOrString, container *v1.Container) (int return -1, fmt.Errorf("couldn't find port: %v in %v", portReference, container) } -func (hr *HandlerRunner) runHTTPHandler(pod *v1.Pod, container *v1.Container, handler *v1.Handler) (string, error) { +func (hr *handlerRunner) runHTTPHandler(pod *v1.Pod, container *v1.Container, handler *v1.Handler) (string, error) { host := handler.HTTPGet.Host if len(host) == 0 { status, err := hr.containerManager.GetPodStatus(pod.UID, pod.Name, pod.Namespace) @@ -129,10 +130,10 @@ func (hr *HandlerRunner) runHTTPHandler(pod *v1.Pod, container *v1.Container, ha } url := fmt.Sprintf("http://%s/%s", net.JoinHostPort(host, strconv.Itoa(port)), handler.HTTPGet.Path) resp, err := hr.httpGetter.Get(url) - return getHttpRespBody(resp), err + return getHTTPRespBody(resp), err } -func getHttpRespBody(resp *http.Response) string { +func getHTTPRespBody(resp *http.Response) string { if resp == nil { return "" } @@ -144,6 +145,8 @@ func getHttpRespBody(resp *http.Response) string { return "" } +// NewAppArmorAdmitHandler returns a PodAdmitHandler which is used to evaluate +// if a pod can be admitted from the perspective of AppArmor. func NewAppArmorAdmitHandler(validator apparmor.Validator) PodAdmitHandler { return &appArmorAdmitHandler{ Validator: validator, @@ -171,6 +174,8 @@ func (a *appArmorAdmitHandler) Admit(attrs *PodAdmitAttributes) PodAdmitResult { } } +// NewNoNewPrivsAdmitHandler returns a PodAdmitHandler which is used to evaluate +// if a pod can be admitted from the perspective of NoNewPrivs. func NewNoNewPrivsAdmitHandler(runtime kubecontainer.Runtime) PodAdmitHandler { return &noNewPrivsAdmitHandler{ Runtime: runtime, @@ -236,6 +241,8 @@ func noNewPrivsRequired(pod *v1.Pod) bool { return false } +// NewProcMountAdmitHandler returns a PodAdmitHandler which is used to evaluate +// if a pod can be admitted from the perspective of ProcMount. func NewProcMountAdmitHandler(runtime kubecontainer.Runtime) PodAdmitHandler { return &procMountAdmitHandler{ Runtime: runtime, diff --git a/pkg/kubelet/lifecycle/predicate.go b/pkg/kubelet/lifecycle/predicate.go index 866cce0f4d1..d6231299c11 100644 --- a/pkg/kubelet/lifecycle/predicate.go +++ b/pkg/kubelet/lifecycle/predicate.go @@ -49,7 +49,9 @@ type predicateAdmitHandler struct { var _ PodAdmitHandler = &predicateAdmitHandler{} -func NewPredicateAdmitHandler(getNodeAnyWayFunc getNodeAnyWayFuncType, admissionFailureHandler AdmissionFailureHandler, pluginResourceUpdateFunc pluginResourceUpdateFuncType) *predicateAdmitHandler { +// NewPredicateAdmitHandler returns a PodAdmitHandler which is used to evaluates +// if a pod can be admitted from the perspective of predicates. +func NewPredicateAdmitHandler(getNodeAnyWayFunc getNodeAnyWayFuncType, admissionFailureHandler AdmissionFailureHandler, pluginResourceUpdateFunc pluginResourceUpdateFuncType) PodAdmitHandler { return &predicateAdmitHandler{ getNodeAnyWayFunc, pluginResourceUpdateFunc,