diff --git a/cmd/kubeadm/app/util/system/cgroup_validator.go b/cmd/kubeadm/app/util/system/cgroup_validator.go index 851884aff6..84dd007c34 100644 --- a/cmd/kubeadm/app/util/system/cgroup_validator.go +++ b/cmd/kubeadm/app/util/system/cgroup_validator.go @@ -26,10 +26,12 @@ import ( var _ Validator = &CgroupsValidator{} +// CgroupsValidator validates cgroup configuration. type CgroupsValidator struct { Reporter Reporter } +// Name is part of the system.Validator interface. func (c *CgroupsValidator) Name() string { return "cgroups" } @@ -38,6 +40,7 @@ const ( cgroupsConfigPrefix = "CGROUPS_" ) +// Validate is part of the system.Validator interface. func (c *CgroupsValidator) Validate(spec SysSpec) (error, error) { subsystems, err := c.getCgroupSubsystems() if err != nil { diff --git a/cmd/kubeadm/app/util/system/docker_validator.go b/cmd/kubeadm/app/util/system/docker_validator.go index e9b02da18c..7eea21296d 100644 --- a/cmd/kubeadm/app/util/system/docker_validator.go +++ b/cmd/kubeadm/app/util/system/docker_validator.go @@ -32,6 +32,7 @@ type DockerValidator struct { Reporter Reporter } +// Name is part of the system.Validator interface. func (d *DockerValidator) Name() string { return "docker" } @@ -41,6 +42,7 @@ const ( latestValidatedDockerVersion = "18.09" ) +// Validate is part of the system.Validator interface. // TODO(random-liu): Add more validating items. func (d *DockerValidator) Validate(spec SysSpec) (error, error) { if spec.RuntimeSpec.DockerSpec == nil { diff --git a/cmd/kubeadm/app/util/system/kernel_validator.go b/cmd/kubeadm/app/util/system/kernel_validator.go index 869464a165..c63c4de21b 100644 --- a/cmd/kubeadm/app/util/system/kernel_validator.go +++ b/cmd/kubeadm/app/util/system/kernel_validator.go @@ -44,6 +44,7 @@ type KernelValidator struct { Reporter Reporter } +// Name is part of the system.Validator interface. func (k *KernelValidator) Name() string { return "kernel" } @@ -58,10 +59,11 @@ const ( // validKConfigRegex is the regex matching kernel configuration line. validKConfigRegex = "^CONFIG_[A-Z0-9_]+=[myn]" - // kConfigPrefix is the prefix of kernel configuration. - kConfigPrefix = "CONFIG_" + // kernelConfigPrefix is the prefix of kernel configuration. + kernelConfigPrefix = "CONFIG_" ) +// Validate is part of the system.Validator interface. func (k *KernelValidator) Validate(spec SysSpec) (error, error) { helper := KernelValidatorHelperImpl{} release, err := helper.GetKernelReleaseVersion() @@ -135,7 +137,7 @@ func (k *KernelValidator) validateCachedKernelConfig(allConfig map[string]kConfi var opt kConfigOption var ok bool for _, name = range append([]string{config.Name}, config.Aliases...) { - name = kConfigPrefix + name + name = kernelConfigPrefix + name if opt, ok = allConfig[name]; ok { break } diff --git a/cmd/kubeadm/app/util/system/kernel_validator_test.go b/cmd/kubeadm/app/util/system/kernel_validator_test.go index e1cfedb5cf..a967ad5ec0 100644 --- a/cmd/kubeadm/app/util/system/kernel_validator_test.go +++ b/cmd/kubeadm/app/util/system/kernel_validator_test.go @@ -173,7 +173,7 @@ func TestValidateCachedKernelConfig(t *testing.T) { // Add kernel config prefix. for k, v := range test.config { delete(test.config, k) - test.config[kConfigPrefix+k] = v + test.config[kernelConfigPrefix+k] = v } err := v.validateCachedKernelConfig(test.config, testKernelSpec) if !test.err { diff --git a/cmd/kubeadm/app/util/system/os_validator.go b/cmd/kubeadm/app/util/system/os_validator.go index 50cfb82ed8..e4372b8975 100644 --- a/cmd/kubeadm/app/util/system/os_validator.go +++ b/cmd/kubeadm/app/util/system/os_validator.go @@ -25,14 +25,17 @@ import ( var _ Validator = &OSValidator{} +// OSValidator validates OS. type OSValidator struct { Reporter Reporter } +// Name is part of the system.Validator interface. func (o *OSValidator) Name() string { return "os" } +// Validate is part of the system.Validator interface. func (o *OSValidator) Validate(spec SysSpec) (error, error) { os, err := exec.Command("uname").CombinedOutput() if err != nil { diff --git a/cmd/kubeadm/app/util/system/report.go b/cmd/kubeadm/app/util/system/report.go index dfeb445ea6..7eaba09739 100644 --- a/cmd/kubeadm/app/util/system/report.go +++ b/cmd/kubeadm/app/util/system/report.go @@ -47,12 +47,13 @@ func colorize(s string, c color) string { return fmt.Sprintf("\033[0;%dm%s\033[0m", c, s) } -// The default reporter for the system verification test +// StreamReporter is the default reporter for the system verification test. type StreamReporter struct { // The stream that this reporter is writing to WriteStream io.Writer } +// Report reports validation result in different color depending on the result type. func (dr *StreamReporter) Report(key, value string, resultType ValidationResultType) error { var c color switch resultType { diff --git a/hack/.golint_failures b/hack/.golint_failures index edc0f01fba..708080a8cb 100644 --- a/hack/.golint_failures +++ b/hack/.golint_failures @@ -3,7 +3,6 @@ cmd/kube-apiserver/app cmd/kube-controller-manager/app cmd/kube-proxy/app cmd/kubeadm/app/apis/kubeadm/v1beta1 -cmd/kubeadm/app/util/system pkg/apis/abac/latest pkg/apis/admission pkg/apis/admissionregistration