mirror of https://github.com/k3s-io/k3s
451 lines
17 KiB
Go
451 lines
17 KiB
Go
/*
|
|
Copyright 2016 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 e2e_node
|
|
|
|
import (
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os/exec"
|
|
"strings"
|
|
"time"
|
|
|
|
"k8s.io/api/core/v1"
|
|
"k8s.io/apimachinery/pkg/api/resource"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
stats "k8s.io/kubernetes/pkg/kubelet/apis/stats/v1alpha1"
|
|
"k8s.io/kubernetes/test/e2e/framework"
|
|
|
|
systemdutil "github.com/coreos/go-systemd/util"
|
|
. "github.com/onsi/ginkgo"
|
|
. "github.com/onsi/gomega"
|
|
"github.com/onsi/gomega/gstruct"
|
|
"github.com/onsi/gomega/types"
|
|
)
|
|
|
|
var _ = framework.KubeDescribe("Summary API [NodeConformance]", func() {
|
|
f := framework.NewDefaultFramework("summary-test")
|
|
Context("when querying /stats/summary", func() {
|
|
AfterEach(func() {
|
|
if !CurrentGinkgoTestDescription().Failed {
|
|
return
|
|
}
|
|
if framework.TestContext.DumpLogsOnFailure {
|
|
framework.LogFailedContainers(f.ClientSet, f.Namespace.Name, framework.Logf)
|
|
}
|
|
By("Recording processes in system cgroups")
|
|
recordSystemCgroupProcesses()
|
|
})
|
|
It("should report resource usage through the stats api", func() {
|
|
const pod0 = "stats-busybox-0"
|
|
const pod1 = "stats-busybox-1"
|
|
|
|
By("Creating test pods")
|
|
numRestarts := int32(1)
|
|
pods := getSummaryTestPods(f, numRestarts, pod0, pod1)
|
|
f.PodClient().CreateBatch(pods)
|
|
|
|
Eventually(func() error {
|
|
for _, pod := range pods {
|
|
err := verifyPodRestartCount(f, pod.Name, len(pod.Spec.Containers), numRestarts)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}, time.Minute, 5*time.Second).Should(BeNil())
|
|
|
|
// Wait for cAdvisor to collect 2 stats points
|
|
time.Sleep(15 * time.Second)
|
|
|
|
// Setup expectations.
|
|
const (
|
|
maxStartAge = time.Hour * 24 * 365 // 1 year
|
|
maxStatsAge = time.Minute
|
|
)
|
|
// fetch node so we can know proper node memory bounds for unconstrained cgroups
|
|
node := getLocalNode(f)
|
|
memoryCapacity := node.Status.Capacity["memory"]
|
|
memoryLimit := memoryCapacity.Value()
|
|
fsCapacityBounds := bounded(100*framework.Mb, 10*framework.Tb)
|
|
// Expectations for system containers.
|
|
sysContExpectations := func() types.GomegaMatcher {
|
|
return gstruct.MatchAllFields(gstruct.Fields{
|
|
"Name": gstruct.Ignore(),
|
|
"StartTime": recent(maxStartAge),
|
|
"CPU": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"UsageNanoCores": bounded(10000, 2E9),
|
|
"UsageCoreNanoSeconds": bounded(10000000, 1E15),
|
|
}),
|
|
"Memory": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
// We don't limit system container memory.
|
|
"AvailableBytes": BeNil(),
|
|
"UsageBytes": bounded(1*framework.Mb, memoryLimit),
|
|
"WorkingSetBytes": bounded(1*framework.Mb, memoryLimit),
|
|
// this now returns /sys/fs/cgroup/memory.stat total_rss
|
|
"RSSBytes": bounded(1*framework.Mb, memoryLimit),
|
|
"PageFaults": bounded(1000, 1E9),
|
|
"MajorPageFaults": bounded(0, 100000),
|
|
}),
|
|
"Accelerators": BeEmpty(),
|
|
"Rootfs": BeNil(),
|
|
"Logs": BeNil(),
|
|
"UserDefinedMetrics": BeEmpty(),
|
|
})
|
|
}
|
|
podsContExpectations := sysContExpectations().(*gstruct.FieldsMatcher)
|
|
podsContExpectations.Fields["Memory"] = ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
// Pods are limited by Node Allocatable
|
|
"AvailableBytes": bounded(1*framework.Kb, memoryLimit),
|
|
"UsageBytes": bounded(10*framework.Kb, memoryLimit),
|
|
"WorkingSetBytes": bounded(10*framework.Kb, memoryLimit),
|
|
"RSSBytes": bounded(1*framework.Kb, memoryLimit),
|
|
"PageFaults": bounded(0, 1000000),
|
|
"MajorPageFaults": bounded(0, 10),
|
|
})
|
|
runtimeContExpectations := sysContExpectations().(*gstruct.FieldsMatcher)
|
|
if systemdutil.IsRunningSystemd() && framework.TestContext.ContainerRuntime == "docker" {
|
|
// Some Linux distributions still ship a docker.service that is missing
|
|
// a `Delegate=yes` setting (or equivalent CPUAccounting= and MemoryAccounting=)
|
|
// that allows us to monitor the container runtime resource usage through
|
|
// the "cpu" and "memory" cgroups.
|
|
//
|
|
// Make an exception here for those distros, only for Docker, so that they
|
|
// can pass the full node e2e tests even in that case.
|
|
//
|
|
// For newer container runtimes (using CRI) and even distros that still
|
|
// ship Docker, we should encourage them to always set `Delegate=yes` in
|
|
// order to make monitoring of the runtime possible.
|
|
stdout, err := exec.Command("systemctl", "show", "-p", "Delegate", "docker.service").CombinedOutput()
|
|
if err == nil && strings.TrimSpace(string(stdout)) == "Delegate=no" {
|
|
// Only make these optional if we can successfully confirm that
|
|
// Delegate is set to "no" (in other words, unset.) If we fail
|
|
// to check that, default to requiring it, which might cause
|
|
// false positives, but that should be the safer approach.
|
|
By("Making runtime container expectations optional, since systemd was not configured to Delegate=yes the cgroups")
|
|
runtimeContExpectations.Fields["Memory"] = Or(BeNil(), runtimeContExpectations.Fields["Memory"])
|
|
runtimeContExpectations.Fields["CPU"] = Or(BeNil(), runtimeContExpectations.Fields["CPU"])
|
|
}
|
|
}
|
|
systemContainers := gstruct.Elements{
|
|
"kubelet": sysContExpectations(),
|
|
"runtime": runtimeContExpectations,
|
|
"pods": podsContExpectations,
|
|
}
|
|
// The Kubelet only manages the 'misc' system container if the host is not running systemd.
|
|
if !systemdutil.IsRunningSystemd() {
|
|
framework.Logf("Host not running systemd; expecting 'misc' system container.")
|
|
miscContExpectations := sysContExpectations().(*gstruct.FieldsMatcher)
|
|
// Misc processes are system-dependent, so relax the memory constraints.
|
|
miscContExpectations.Fields["Memory"] = ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
// We don't limit system container memory.
|
|
"AvailableBytes": BeNil(),
|
|
"UsageBytes": bounded(100*framework.Kb, memoryLimit),
|
|
"WorkingSetBytes": bounded(100*framework.Kb, memoryLimit),
|
|
"RSSBytes": bounded(100*framework.Kb, memoryLimit),
|
|
"PageFaults": bounded(1000, 1E9),
|
|
"MajorPageFaults": bounded(0, 100000),
|
|
})
|
|
systemContainers["misc"] = miscContExpectations
|
|
}
|
|
// Expectations for pods.
|
|
podExpectations := gstruct.MatchAllFields(gstruct.Fields{
|
|
"PodRef": gstruct.Ignore(),
|
|
"StartTime": recent(maxStartAge),
|
|
"Containers": gstruct.MatchAllElements(summaryObjectID, gstruct.Elements{
|
|
"busybox-container": gstruct.MatchAllFields(gstruct.Fields{
|
|
"Name": Equal("busybox-container"),
|
|
"StartTime": recent(maxStartAge),
|
|
"CPU": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"UsageNanoCores": bounded(10000, 1E9),
|
|
"UsageCoreNanoSeconds": bounded(10000000, 1E11),
|
|
}),
|
|
"Memory": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": bounded(1*framework.Kb, 80*framework.Mb),
|
|
"UsageBytes": bounded(10*framework.Kb, 80*framework.Mb),
|
|
"WorkingSetBytes": bounded(10*framework.Kb, 80*framework.Mb),
|
|
"RSSBytes": bounded(1*framework.Kb, 80*framework.Mb),
|
|
"PageFaults": bounded(100, 1000000),
|
|
"MajorPageFaults": bounded(0, 10),
|
|
}),
|
|
"Accelerators": BeEmpty(),
|
|
"Rootfs": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": fsCapacityBounds,
|
|
"CapacityBytes": fsCapacityBounds,
|
|
"UsedBytes": bounded(framework.Kb, 10*framework.Mb),
|
|
"InodesFree": bounded(1E4, 1E8),
|
|
"Inodes": bounded(1E4, 1E8),
|
|
"InodesUsed": bounded(0, 1E8),
|
|
}),
|
|
"Logs": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": fsCapacityBounds,
|
|
"CapacityBytes": fsCapacityBounds,
|
|
"UsedBytes": bounded(framework.Kb, 10*framework.Mb),
|
|
"InodesFree": bounded(1E4, 1E8),
|
|
"Inodes": bounded(1E4, 1E8),
|
|
"InodesUsed": bounded(0, 1E8),
|
|
}),
|
|
"UserDefinedMetrics": BeEmpty(),
|
|
}),
|
|
}),
|
|
"Network": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"InterfaceStats": gstruct.MatchAllFields(gstruct.Fields{
|
|
"Name": Equal("eth0"),
|
|
"RxBytes": bounded(10, 10*framework.Mb),
|
|
"RxErrors": bounded(0, 1000),
|
|
"TxBytes": bounded(10, 10*framework.Mb),
|
|
"TxErrors": bounded(0, 1000),
|
|
}),
|
|
"Interfaces": Not(BeNil()),
|
|
}),
|
|
"CPU": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"UsageNanoCores": bounded(10000, 1E9),
|
|
"UsageCoreNanoSeconds": bounded(10000000, 1E11),
|
|
}),
|
|
"Memory": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": bounded(1*framework.Kb, 80*framework.Mb),
|
|
"UsageBytes": bounded(10*framework.Kb, 80*framework.Mb),
|
|
"WorkingSetBytes": bounded(10*framework.Kb, 80*framework.Mb),
|
|
"RSSBytes": bounded(1*framework.Kb, 80*framework.Mb),
|
|
"PageFaults": bounded(0, 1000000),
|
|
"MajorPageFaults": bounded(0, 10),
|
|
}),
|
|
"VolumeStats": gstruct.MatchAllElements(summaryObjectID, gstruct.Elements{
|
|
"test-empty-dir": gstruct.MatchAllFields(gstruct.Fields{
|
|
"Name": Equal("test-empty-dir"),
|
|
"PVCRef": BeNil(),
|
|
"FsStats": gstruct.MatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": fsCapacityBounds,
|
|
"CapacityBytes": fsCapacityBounds,
|
|
"UsedBytes": bounded(framework.Kb, 1*framework.Mb),
|
|
"InodesFree": bounded(1E4, 1E8),
|
|
"Inodes": bounded(1E4, 1E8),
|
|
"InodesUsed": bounded(0, 1E8),
|
|
}),
|
|
}),
|
|
}),
|
|
"EphemeralStorage": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": fsCapacityBounds,
|
|
"CapacityBytes": fsCapacityBounds,
|
|
"UsedBytes": bounded(framework.Kb, 21*framework.Mb),
|
|
"InodesFree": bounded(1E4, 1E8),
|
|
"Inodes": bounded(1E4, 1E8),
|
|
"InodesUsed": bounded(0, 1E8),
|
|
}),
|
|
})
|
|
|
|
matchExpectations := ptrMatchAllFields(gstruct.Fields{
|
|
"Node": gstruct.MatchAllFields(gstruct.Fields{
|
|
"NodeName": Equal(framework.TestContext.NodeName),
|
|
"StartTime": recent(maxStartAge),
|
|
"SystemContainers": gstruct.MatchAllElements(summaryObjectID, systemContainers),
|
|
"CPU": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"UsageNanoCores": bounded(100E3, 2E9),
|
|
"UsageCoreNanoSeconds": bounded(1E9, 1E15),
|
|
}),
|
|
"Memory": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": bounded(100*framework.Mb, memoryLimit),
|
|
"UsageBytes": bounded(10*framework.Mb, memoryLimit),
|
|
"WorkingSetBytes": bounded(10*framework.Mb, memoryLimit),
|
|
// this now returns /sys/fs/cgroup/memory.stat total_rss
|
|
"RSSBytes": bounded(1*framework.Kb, memoryLimit),
|
|
"PageFaults": bounded(1000, 1E9),
|
|
"MajorPageFaults": bounded(0, 100000),
|
|
}),
|
|
// TODO(#28407): Handle non-eth0 network interface names.
|
|
"Network": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"InterfaceStats": gstruct.MatchAllFields(gstruct.Fields{
|
|
"Name": Or(BeEmpty(), Equal("eth0")),
|
|
"RxBytes": Or(BeNil(), bounded(1*framework.Mb, 100*framework.Gb)),
|
|
"RxErrors": Or(BeNil(), bounded(0, 100000)),
|
|
"TxBytes": Or(BeNil(), bounded(10*framework.Kb, 10*framework.Gb)),
|
|
"TxErrors": Or(BeNil(), bounded(0, 100000)),
|
|
}),
|
|
"Interfaces": Not(BeNil()),
|
|
}),
|
|
"Fs": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": fsCapacityBounds,
|
|
"CapacityBytes": fsCapacityBounds,
|
|
// we assume we are not running tests on machines < 10tb of disk
|
|
"UsedBytes": bounded(framework.Kb, 10*framework.Tb),
|
|
"InodesFree": bounded(1E4, 1E8),
|
|
"Inodes": bounded(1E4, 1E8),
|
|
"InodesUsed": bounded(0, 1E8),
|
|
}),
|
|
"Runtime": ptrMatchAllFields(gstruct.Fields{
|
|
"ImageFs": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"AvailableBytes": fsCapacityBounds,
|
|
"CapacityBytes": fsCapacityBounds,
|
|
// we assume we are not running tests on machines < 10tb of disk
|
|
"UsedBytes": bounded(framework.Kb, 10*framework.Tb),
|
|
"InodesFree": bounded(1E4, 1E8),
|
|
"Inodes": bounded(1E4, 1E8),
|
|
"InodesUsed": bounded(0, 1E8),
|
|
}),
|
|
}),
|
|
"Rlimit": ptrMatchAllFields(gstruct.Fields{
|
|
"Time": recent(maxStatsAge),
|
|
"MaxPID": bounded(0, 1E8),
|
|
"NumOfRunningProcesses": bounded(0, 1E8),
|
|
}),
|
|
}),
|
|
// Ignore extra pods since the tests run in parallel.
|
|
"Pods": gstruct.MatchElements(summaryObjectID, gstruct.IgnoreExtras, gstruct.Elements{
|
|
fmt.Sprintf("%s::%s", f.Namespace.Name, pod0): podExpectations,
|
|
fmt.Sprintf("%s::%s", f.Namespace.Name, pod1): podExpectations,
|
|
}),
|
|
})
|
|
|
|
By("Validating /stats/summary")
|
|
// Give pods a minute to actually start up.
|
|
Eventually(getNodeSummary, 1*time.Minute, 15*time.Second).Should(matchExpectations)
|
|
// Then the summary should match the expectations a few more times.
|
|
Consistently(getNodeSummary, 30*time.Second, 15*time.Second).Should(matchExpectations)
|
|
})
|
|
})
|
|
})
|
|
|
|
func getSummaryTestPods(f *framework.Framework, numRestarts int32, names ...string) []*v1.Pod {
|
|
pods := make([]*v1.Pod, 0, len(names))
|
|
for _, name := range names {
|
|
pods = append(pods, &v1.Pod{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: name,
|
|
},
|
|
Spec: v1.PodSpec{
|
|
RestartPolicy: v1.RestartPolicyAlways,
|
|
Containers: []v1.Container{
|
|
{
|
|
Name: "busybox-container",
|
|
Image: busyboxImage,
|
|
Command: getRestartingContainerCommand("/test-empty-dir-mnt", 0, numRestarts, "echo 'some bytes' >/outside_the_volume.txt; ping -c 1 google.com; echo 'hello world' >> /test-empty-dir-mnt/file;"),
|
|
Resources: v1.ResourceRequirements{
|
|
Limits: v1.ResourceList{
|
|
// Must set memory limit to get MemoryStats.AvailableBytes
|
|
v1.ResourceMemory: resource.MustParse("80M"),
|
|
},
|
|
},
|
|
VolumeMounts: []v1.VolumeMount{
|
|
{MountPath: "/test-empty-dir-mnt", Name: "test-empty-dir"},
|
|
},
|
|
},
|
|
},
|
|
SecurityContext: &v1.PodSecurityContext{
|
|
SELinuxOptions: &v1.SELinuxOptions{
|
|
Level: "s0",
|
|
},
|
|
},
|
|
Volumes: []v1.Volume{
|
|
// TODO(#28393): Test secret volumes
|
|
// TODO(#28394): Test hostpath volumes
|
|
{Name: "test-empty-dir", VolumeSource: v1.VolumeSource{EmptyDir: &v1.EmptyDirVolumeSource{}}},
|
|
},
|
|
},
|
|
})
|
|
}
|
|
return pods
|
|
}
|
|
|
|
// Mapping function for gstruct.MatchAllElements
|
|
func summaryObjectID(element interface{}) string {
|
|
switch el := element.(type) {
|
|
case stats.PodStats:
|
|
return fmt.Sprintf("%s::%s", el.PodRef.Namespace, el.PodRef.Name)
|
|
case stats.ContainerStats:
|
|
return el.Name
|
|
case stats.VolumeStats:
|
|
return el.Name
|
|
case stats.UserDefinedMetric:
|
|
return el.Name
|
|
default:
|
|
framework.Failf("Unknown type: %T", el)
|
|
return "???"
|
|
}
|
|
}
|
|
|
|
// Convenience functions for common matcher combinations.
|
|
func ptrMatchAllFields(fields gstruct.Fields) types.GomegaMatcher {
|
|
return gstruct.PointTo(gstruct.MatchAllFields(fields))
|
|
}
|
|
|
|
func bounded(lower, upper interface{}) types.GomegaMatcher {
|
|
return gstruct.PointTo(And(
|
|
BeNumerically(">=", lower),
|
|
BeNumerically("<=", upper)))
|
|
}
|
|
|
|
func recent(d time.Duration) types.GomegaMatcher {
|
|
return WithTransform(func(t metav1.Time) time.Time {
|
|
return t.Time
|
|
}, And(
|
|
BeTemporally(">=", time.Now().Add(-d)),
|
|
// Now() is the test start time, not the match time, so permit a few extra minutes.
|
|
BeTemporally("<", time.Now().Add(2*time.Minute))))
|
|
}
|
|
|
|
func recordSystemCgroupProcesses() {
|
|
cfg, err := getCurrentKubeletConfig()
|
|
if err != nil {
|
|
framework.Logf("Failed to read kubelet config: %v", err)
|
|
return
|
|
}
|
|
cgroups := map[string]string{
|
|
"kubelet": cfg.KubeletCgroups,
|
|
"misc": cfg.SystemCgroups,
|
|
}
|
|
for name, cgroup := range cgroups {
|
|
if cgroup == "" {
|
|
framework.Logf("Skipping unconfigured cgroup %s", name)
|
|
continue
|
|
}
|
|
|
|
pids, err := ioutil.ReadFile(fmt.Sprintf("/sys/fs/cgroup/cpu/%s/cgroup.procs", cgroup))
|
|
if err != nil {
|
|
framework.Logf("Failed to read processes in cgroup %s: %v", name, err)
|
|
continue
|
|
}
|
|
|
|
framework.Logf("Processes in %s cgroup (%s):", name, cgroup)
|
|
for _, pid := range strings.Fields(string(pids)) {
|
|
path := fmt.Sprintf("/proc/%s/cmdline", pid)
|
|
cmd, err := ioutil.ReadFile(path)
|
|
if err != nil {
|
|
framework.Logf(" Failed to read %s: %v", path, err)
|
|
} else {
|
|
framework.Logf(" %s", cmd)
|
|
}
|
|
}
|
|
}
|
|
}
|