From 4db581c8eeda4ac357a885b2f66c43b69c59eca5 Mon Sep 17 00:00:00 2001 From: fabriziopandini Date: Mon, 14 Aug 2017 16:30:31 +0200 Subject: [PATCH] Move all staticpod utils to separate package --- cmd/kubeadm/app/util/staticpod/utils.go | 137 ++++++++++++ cmd/kubeadm/app/util/staticpod/utils_test.go | 219 +++++++++++++++++++ 2 files changed, 356 insertions(+) create mode 100644 cmd/kubeadm/app/util/staticpod/utils.go create mode 100644 cmd/kubeadm/app/util/staticpod/utils_test.go diff --git a/cmd/kubeadm/app/util/staticpod/utils.go b/cmd/kubeadm/app/util/staticpod/utils.go new file mode 100644 index 00000000000..bdeb09f657a --- /dev/null +++ b/cmd/kubeadm/app/util/staticpod/utils.go @@ -0,0 +1,137 @@ +/* +Copyright 2017 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 staticpod + +import ( + "fmt" + "io/ioutil" + "os" + + "github.com/ghodss/yaml" + + "k8s.io/api/core/v1" + "k8s.io/apimachinery/pkg/api/resource" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + "k8s.io/apimachinery/pkg/util/intstr" + kubeadmconstants "k8s.io/kubernetes/cmd/kubeadm/app/constants" + kubetypes "k8s.io/kubernetes/pkg/kubelet/types" +) + +// ComponentPod returns a Pod object from the container and volume specifications +func ComponentPod(container v1.Container, volumes []v1.Volume) v1.Pod { + return v1.Pod{ + TypeMeta: metav1.TypeMeta{ + APIVersion: "v1", + Kind: "Pod", + }, + ObjectMeta: metav1.ObjectMeta{ + Name: container.Name, + Namespace: metav1.NamespaceSystem, + Annotations: map[string]string{kubetypes.CriticalPodAnnotationKey: ""}, + }, + Spec: v1.PodSpec{ + Containers: []v1.Container{container}, + HostNetwork: true, + Volumes: volumes, + }, + } +} + +// ComponentResources returns the v1.ResourceRequirements object needed for allocating a specified amount of the CPU +func ComponentResources(cpu string) v1.ResourceRequirements { + return v1.ResourceRequirements{ + Requests: v1.ResourceList{ + v1.ResourceName(v1.ResourceCPU): resource.MustParse(cpu), + }, + } +} + +// ComponentProbe is a helper function building a ready v1.Probe object from some simple parameters +func ComponentProbe(port int, path string, scheme v1.URIScheme) *v1.Probe { + return &v1.Probe{ + Handler: v1.Handler{ + HTTPGet: &v1.HTTPGetAction{ + // Host has to be set to "127.0.0.1" here due to that our static Pods are on the host's network + Host: "127.0.0.1", + Path: path, + Port: intstr.FromInt(port), + Scheme: scheme, + }, + }, + InitialDelaySeconds: 15, + TimeoutSeconds: 15, + FailureThreshold: 8, + } +} + +// NewVolume creates a v1.Volume with a hostPath mount to the specified location +func NewVolume(name, path string) v1.Volume { + return v1.Volume{ + Name: name, + VolumeSource: v1.VolumeSource{ + HostPath: &v1.HostPathVolumeSource{Path: path}, + }, + } +} + +// NewVolumeMount creates a v1.VolumeMount to the specified location +func NewVolumeMount(name, path string, readOnly bool) v1.VolumeMount { + return v1.VolumeMount{ + Name: name, + MountPath: path, + ReadOnly: readOnly, + } +} + +// GetExtraParameters builds a list of flag arguments two string-string maps, one with default, base commands and one with overrides +func GetExtraParameters(overrides map[string]string, defaults map[string]string) []string { + var command []string + for k, v := range overrides { + if len(v) > 0 { + command = append(command, fmt.Sprintf("--%s=%s", k, v)) + } + } + for k, v := range defaults { + if _, overrideExists := overrides[k]; !overrideExists { + command = append(command, fmt.Sprintf("--%s=%s", k, v)) + } + } + return command +} + +// WriteStaticPodToDisk writes a static pod file to disk +func WriteStaticPodToDisk(componentName, manifestDir string, pod v1.Pod) error { + + // creates target folder if not already exists + if err := os.MkdirAll(manifestDir, 0700); err != nil { + return fmt.Errorf("failed to create directory %q: %v", manifestDir, err) + } + + // writes the pod to disk + serialized, err := yaml.Marshal(pod) + if err != nil { + return fmt.Errorf("failed to marshal manifest for %q to YAML: %v", componentName, err) + } + + filename := kubeadmconstants.GetStaticPodFilepath(componentName, manifestDir) + + if err := ioutil.WriteFile(filename, serialized, 0700); err != nil { + return fmt.Errorf("failed to write static pod manifest file for %q (%q): %v", componentName, filename, err) + } + + return nil +} diff --git a/cmd/kubeadm/app/util/staticpod/utils_test.go b/cmd/kubeadm/app/util/staticpod/utils_test.go new file mode 100644 index 00000000000..e0e844d8a9a --- /dev/null +++ b/cmd/kubeadm/app/util/staticpod/utils_test.go @@ -0,0 +1,219 @@ +/* +Copyright 2017 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 staticpod + +import ( + "reflect" + "sort" + "testing" + + "k8s.io/api/core/v1" + "k8s.io/apimachinery/pkg/util/intstr" +) + +func TestComponentResources(t *testing.T) { + a := ComponentResources("250m") + if a.Requests == nil { + t.Errorf( + "failed componentResources, return value was nil", + ) + } +} + +func TestComponentProbe(t *testing.T) { + var tests = []struct { + port int + path string + scheme v1.URIScheme + }{ + { + port: 1, + path: "foo", + scheme: v1.URISchemeHTTP, + }, + { + port: 2, + path: "bar", + scheme: v1.URISchemeHTTPS, + }, + } + for _, rt := range tests { + actual := ComponentProbe(rt.port, rt.path, rt.scheme) + if actual.Handler.HTTPGet.Port != intstr.FromInt(rt.port) { + t.Errorf( + "failed componentProbe:\n\texpected: %v\n\t actual: %v", + rt.port, + actual.Handler.HTTPGet.Port, + ) + } + if actual.Handler.HTTPGet.Path != rt.path { + t.Errorf( + "failed componentProbe:\n\texpected: %s\n\t actual: %s", + rt.path, + actual.Handler.HTTPGet.Path, + ) + } + if actual.Handler.HTTPGet.Scheme != rt.scheme { + t.Errorf( + "failed componentProbe:\n\texpected: %v\n\t actual: %v", + rt.scheme, + actual.Handler.HTTPGet.Scheme, + ) + } + } +} + +func TestComponentPod(t *testing.T) { + var tests = []struct { + n string + }{ + { + n: "foo", + }, + } + + for _, rt := range tests { + c := v1.Container{Name: rt.n} + v := []v1.Volume{} + actual := ComponentPod(c, v) + if actual.ObjectMeta.Name != rt.n { + t.Errorf( + "failed componentPod:\n\texpected: %s\n\t actual: %s", + rt.n, + actual.ObjectMeta.Name, + ) + } + } +} + +func TestNewVolume(t *testing.T) { + var tests = []struct { + name string + path string + expected v1.Volume + }{ + { + name: "foo", + path: "/etc/foo", + expected: v1.Volume{ + Name: "foo", + VolumeSource: v1.VolumeSource{ + HostPath: &v1.HostPathVolumeSource{Path: "/etc/foo"}, + }, + }, + }, + } + + for _, rt := range tests { + actual := NewVolume(rt.name, rt.path) + if !reflect.DeepEqual(actual, rt.expected) { + t.Errorf( + "failed newVolume:\n\texpected: %v\n\t actual: %v", + rt.expected, + actual, + ) + } + } +} + +func TestNewVolumeMount(t *testing.T) { + var tests = []struct { + name string + path string + ro bool + expected v1.VolumeMount + }{ + { + name: "foo", + path: "/etc/foo", + ro: false, + expected: v1.VolumeMount{ + Name: "foo", + MountPath: "/etc/foo", + ReadOnly: false, + }, + }, + { + name: "bar", + path: "/etc/foo/bar", + ro: true, + expected: v1.VolumeMount{ + Name: "bar", + MountPath: "/etc/foo/bar", + ReadOnly: true, + }, + }, + } + + for _, rt := range tests { + actual := NewVolumeMount(rt.name, rt.path, rt.ro) + if !reflect.DeepEqual(actual, rt.expected) { + t.Errorf( + "failed newVolumeMount:\n\texpected: %v\n\t actual: %v", + rt.expected, + actual, + ) + } + } +} + +func TestGetExtraParameters(t *testing.T) { + var tests = []struct { + overrides map[string]string + defaults map[string]string + expected []string + }{ + { + overrides: map[string]string{ + "admission-control": "NamespaceLifecycle,LimitRanger", + }, + defaults: map[string]string{ + "admission-control": "NamespaceLifecycle", + "insecure-bind-address": "127.0.0.1", + "allow-privileged": "true", + }, + expected: []string{ + "--admission-control=NamespaceLifecycle,LimitRanger", + "--insecure-bind-address=127.0.0.1", + "--allow-privileged=true", + }, + }, + { + overrides: map[string]string{ + "admission-control": "NamespaceLifecycle,LimitRanger", + }, + defaults: map[string]string{ + "insecure-bind-address": "127.0.0.1", + "allow-privileged": "true", + }, + expected: []string{ + "--admission-control=NamespaceLifecycle,LimitRanger", + "--insecure-bind-address=127.0.0.1", + "--allow-privileged=true", + }, + }, + } + + for _, rt := range tests { + actual := GetExtraParameters(rt.overrides, rt.defaults) + sort.Strings(actual) + sort.Strings(rt.expected) + if !reflect.DeepEqual(actual, rt.expected) { + t.Errorf("failed getExtraParameters:\nexpected:\n%v\nsaw:\n%v", rt.expected, actual) + } + } +}