k3s/vendor/k8s.io/kubernetes/pkg/kubelet/prober/prober.go

324 lines
10 KiB
Go
Raw Normal View History

2019-01-12 04:58:27 +00:00
/*
Copyright 2014 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 prober
import (
"fmt"
"io"
"net"
"net/http"
"net/url"
"strconv"
"strings"
"time"
2019-09-27 21:51:53 +00:00
v1 "k8s.io/api/core/v1"
2019-01-12 04:58:27 +00:00
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/client-go/tools/record"
kubecontainer "k8s.io/kubernetes/pkg/kubelet/container"
"k8s.io/kubernetes/pkg/kubelet/events"
"k8s.io/kubernetes/pkg/kubelet/prober/results"
"k8s.io/kubernetes/pkg/kubelet/util/format"
"k8s.io/kubernetes/pkg/probe"
execprobe "k8s.io/kubernetes/pkg/probe/exec"
2019-09-27 21:51:53 +00:00
httpprobe "k8s.io/kubernetes/pkg/probe/http"
tcpprobe "k8s.io/kubernetes/pkg/probe/tcp"
2019-01-12 04:58:27 +00:00
"k8s.io/utils/exec"
"k8s.io/klog"
)
const maxProbeRetries = 3
2019-09-27 21:51:53 +00:00
// Prober helps to check the liveness/readiness/startup of a container.
2019-01-12 04:58:27 +00:00
type prober struct {
exec execprobe.Prober
// probe types needs different httprobe instances so they don't
// share a connection pool which can cause collsions to the
// same host:port and transient failures. See #49740.
2019-09-27 21:51:53 +00:00
readinessHTTP httpprobe.Prober
livenessHTTP httpprobe.Prober
startupHTTP httpprobe.Prober
tcp tcpprobe.Prober
2019-01-12 04:58:27 +00:00
runner kubecontainer.ContainerCommandRunner
refManager *kubecontainer.RefManager
recorder record.EventRecorder
}
// NewProber creates a Prober, it takes a command runner and
// several container info managers.
func newProber(
runner kubecontainer.ContainerCommandRunner,
refManager *kubecontainer.RefManager,
recorder record.EventRecorder) *prober {
2019-04-07 17:07:55 +00:00
const followNonLocalRedirects = false
2019-01-12 04:58:27 +00:00
return &prober{
exec: execprobe.New(),
2019-09-27 21:51:53 +00:00
readinessHTTP: httpprobe.New(followNonLocalRedirects),
livenessHTTP: httpprobe.New(followNonLocalRedirects),
startupHTTP: httpprobe.New(followNonLocalRedirects),
tcp: tcpprobe.New(),
2019-01-12 04:58:27 +00:00
runner: runner,
refManager: refManager,
recorder: recorder,
}
}
2020-03-26 21:07:15 +00:00
// recordContainerEvent should be used by the prober for all container related events.
func (pb *prober) recordContainerEvent(pod *v1.Pod, container *v1.Container, containerID kubecontainer.ContainerID, eventType, reason, message string, args ...interface{}) {
var err error
ref, hasRef := pb.refManager.GetRef(containerID)
if !hasRef {
ref, err = kubecontainer.GenerateContainerRef(pod, container)
if err != nil {
klog.Errorf("Can't make a ref to pod %q, container %v: %v", format.Pod(pod), container.Name, err)
return
}
}
pb.recorder.Eventf(ref, eventType, reason, message, args...)
}
2019-01-12 04:58:27 +00:00
// probe probes the container.
func (pb *prober) probe(probeType probeType, pod *v1.Pod, status v1.PodStatus, container v1.Container, containerID kubecontainer.ContainerID) (results.Result, error) {
var probeSpec *v1.Probe
switch probeType {
case readiness:
probeSpec = container.ReadinessProbe
case liveness:
probeSpec = container.LivenessProbe
2019-09-27 21:51:53 +00:00
case startup:
probeSpec = container.StartupProbe
2019-01-12 04:58:27 +00:00
default:
2019-09-27 21:51:53 +00:00
return results.Failure, fmt.Errorf("unknown probe type: %q", probeType)
2019-01-12 04:58:27 +00:00
}
ctrName := fmt.Sprintf("%s:%s", format.Pod(pod), container.Name)
if probeSpec == nil {
klog.Warningf("%s probe for %s is nil", probeType, ctrName)
return results.Success, nil
}
result, output, err := pb.runProbeWithRetries(probeType, probeSpec, pod, status, container, containerID, maxProbeRetries)
2019-04-07 17:07:55 +00:00
if err != nil || (result != probe.Success && result != probe.Warning) {
2019-01-12 04:58:27 +00:00
// Probe failed in one way or another.
if err != nil {
klog.V(1).Infof("%s probe for %q errored: %v", probeType, ctrName, err)
2020-03-26 21:07:15 +00:00
pb.recordContainerEvent(pod, &container, containerID, v1.EventTypeWarning, events.ContainerUnhealthy, "%s probe errored: %v", probeType, err)
2019-01-12 04:58:27 +00:00
} else { // result != probe.Success
klog.V(1).Infof("%s probe for %q failed (%v): %s", probeType, ctrName, result, output)
2020-03-26 21:07:15 +00:00
pb.recordContainerEvent(pod, &container, containerID, v1.EventTypeWarning, events.ContainerUnhealthy, "%s probe failed: %v", probeType, output)
2019-01-12 04:58:27 +00:00
}
return results.Failure, err
}
2019-04-07 17:07:55 +00:00
if result == probe.Warning {
2020-03-26 21:07:15 +00:00
pb.recordContainerEvent(pod, &container, containerID, v1.EventTypeWarning, events.ContainerProbeWarning, "%s probe warning: %v", probeType, output)
2019-04-07 17:07:55 +00:00
klog.V(3).Infof("%s probe for %q succeeded with a warning: %s", probeType, ctrName, output)
} else {
klog.V(3).Infof("%s probe for %q succeeded", probeType, ctrName)
}
2019-01-12 04:58:27 +00:00
return results.Success, nil
}
// runProbeWithRetries tries to probe the container in a finite loop, it returns the last result
// if it never succeeds.
func (pb *prober) runProbeWithRetries(probeType probeType, p *v1.Probe, pod *v1.Pod, status v1.PodStatus, container v1.Container, containerID kubecontainer.ContainerID, retries int) (probe.Result, string, error) {
var err error
var result probe.Result
var output string
for i := 0; i < retries; i++ {
result, output, err = pb.runProbe(probeType, p, pod, status, container, containerID)
if err == nil {
return result, output, nil
}
}
return result, output, err
}
// buildHeaderMap takes a list of HTTPHeader <name, value> string
// pairs and returns a populated string->[]string http.Header map.
func buildHeader(headerList []v1.HTTPHeader) http.Header {
headers := make(http.Header)
for _, header := range headerList {
headers[header.Name] = append(headers[header.Name], header.Value)
}
return headers
}
func (pb *prober) runProbe(probeType probeType, p *v1.Probe, pod *v1.Pod, status v1.PodStatus, container v1.Container, containerID kubecontainer.ContainerID) (probe.Result, string, error) {
timeout := time.Duration(p.TimeoutSeconds) * time.Second
if p.Exec != nil {
klog.V(4).Infof("Exec-Probe Pod: %v, Container: %v, Command: %v", pod, container, p.Exec.Command)
command := kubecontainer.ExpandContainerCommandOnlyStatic(p.Exec.Command, container.Env)
return pb.exec.Probe(pb.newExecInContainer(container, containerID, command, timeout))
}
if p.HTTPGet != nil {
scheme := strings.ToLower(string(p.HTTPGet.Scheme))
host := p.HTTPGet.Host
if host == "" {
host = status.PodIP
}
port, err := extractPort(p.HTTPGet.Port, container)
if err != nil {
return probe.Unknown, "", err
}
path := p.HTTPGet.Path
klog.V(4).Infof("HTTP-Probe Host: %v://%v, Port: %v, Path: %v", scheme, host, port, path)
url := formatURL(scheme, host, port, path)
headers := buildHeader(p.HTTPGet.HTTPHeaders)
klog.V(4).Infof("HTTP-Probe Headers: %v", headers)
2019-09-27 21:51:53 +00:00
switch probeType {
case liveness:
return pb.livenessHTTP.Probe(url, headers, timeout)
case startup:
return pb.startupHTTP.Probe(url, headers, timeout)
default:
return pb.readinessHTTP.Probe(url, headers, timeout)
2019-01-12 04:58:27 +00:00
}
}
if p.TCPSocket != nil {
port, err := extractPort(p.TCPSocket.Port, container)
if err != nil {
return probe.Unknown, "", err
}
host := p.TCPSocket.Host
if host == "" {
host = status.PodIP
}
klog.V(4).Infof("TCP-Probe Host: %v, Port: %v, Timeout: %v", host, port, timeout)
return pb.tcp.Probe(host, port, timeout)
}
klog.Warningf("Failed to find probe builder for container: %v", container)
2019-09-27 21:51:53 +00:00
return probe.Unknown, "", fmt.Errorf("missing probe handler for %s:%s", format.Pod(pod), container.Name)
2019-01-12 04:58:27 +00:00
}
func extractPort(param intstr.IntOrString, container v1.Container) (int, error) {
port := -1
var err error
switch param.Type {
case intstr.Int:
port = param.IntValue()
case intstr.String:
if port, err = findPortByName(container, param.StrVal); err != nil {
// Last ditch effort - maybe it was an int stored as string?
if port, err = strconv.Atoi(param.StrVal); err != nil {
return port, err
}
}
default:
2019-09-27 21:51:53 +00:00
return port, fmt.Errorf("intOrString had no kind: %+v", param)
2019-01-12 04:58:27 +00:00
}
if port > 0 && port < 65536 {
return port, nil
}
return port, fmt.Errorf("invalid port number: %v", port)
}
// findPortByName is a helper function to look up a port in a container by name.
func findPortByName(container v1.Container, portName string) (int, error) {
for _, port := range container.Ports {
if port.Name == portName {
return int(port.ContainerPort), nil
}
}
return 0, fmt.Errorf("port %s not found", portName)
}
// formatURL formats a URL from args. For testability.
func formatURL(scheme string, host string, port int, path string) *url.URL {
u, err := url.Parse(path)
// Something is busted with the path, but it's too late to reject it. Pass it along as is.
if err != nil {
u = &url.URL{
Path: path,
}
}
u.Scheme = scheme
u.Host = net.JoinHostPort(host, strconv.Itoa(port))
return u
}
type execInContainer struct {
// run executes a command in a container. Combined stdout and stderr output is always returned. An
// error is returned if one occurred.
2019-10-16 05:42:28 +00:00
run func() ([]byte, error)
writer io.Writer
2019-01-12 04:58:27 +00:00
}
func (pb *prober) newExecInContainer(container v1.Container, containerID kubecontainer.ContainerID, cmd []string, timeout time.Duration) exec.Cmd {
2019-10-16 05:42:28 +00:00
return &execInContainer{run: func() ([]byte, error) {
2019-01-12 04:58:27 +00:00
return pb.runner.RunInContainer(containerID, cmd, timeout)
}}
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) Run() error {
return nil
2019-01-12 04:58:27 +00:00
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) CombinedOutput() ([]byte, error) {
2019-01-12 04:58:27 +00:00
return eic.run()
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) Output() ([]byte, error) {
2019-01-12 04:58:27 +00:00
return nil, fmt.Errorf("unimplemented")
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) SetDir(dir string) {
2019-01-12 04:58:27 +00:00
//unimplemented
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) SetStdin(in io.Reader) {
2019-01-12 04:58:27 +00:00
//unimplemented
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) SetStdout(out io.Writer) {
eic.writer = out
2019-01-12 04:58:27 +00:00
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) SetStderr(out io.Writer) {
eic.writer = out
2019-01-12 04:58:27 +00:00
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) SetEnv(env []string) {
2019-04-07 17:07:55 +00:00
//unimplemented
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) Stop() {
2019-01-12 04:58:27 +00:00
//unimplemented
}
2019-04-07 17:07:55 +00:00
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) Start() error {
data, err := eic.run()
if eic.writer != nil {
eic.writer.Write(data)
}
return err
2019-04-07 17:07:55 +00:00
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) Wait() error {
return nil
2019-04-07 17:07:55 +00:00
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) StdoutPipe() (io.ReadCloser, error) {
2019-04-07 17:07:55 +00:00
return nil, fmt.Errorf("unimplemented")
}
2019-10-16 05:42:28 +00:00
func (eic *execInContainer) StderrPipe() (io.ReadCloser, error) {
2019-04-07 17:07:55 +00:00
return nil, fmt.Errorf("unimplemented")
}