From 696c98a5e672a071955fff7fc5ebae27ba8f2236 Mon Sep 17 00:00:00 2001 From: danielqsj Date: Fri, 1 Mar 2019 17:36:20 +0800 Subject: [PATCH 1/2] fix golint failures for metrics api --- hack/.golint_failures | 4 ---- .../metrics/pkg/apis/custom_metrics/v1beta1/register.go | 4 +++- .../k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/types.go | 6 +++--- .../metrics/pkg/apis/custom_metrics/v1beta2/register.go | 4 +++- .../metrics/pkg/apis/external_metrics/v1beta1/register.go | 4 +++- .../metrics/pkg/apis/external_metrics/v1beta1/types.go | 4 ++-- .../k8s.io/metrics/pkg/apis/metrics/v1alpha1/register.go | 4 +++- .../src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go | 6 +++--- .../src/k8s.io/metrics/pkg/apis/metrics/v1beta1/register.go | 4 +++- .../src/k8s.io/metrics/pkg/apis/metrics/v1beta1/types.go | 6 +++--- 10 files changed, 26 insertions(+), 20 deletions(-) diff --git a/hack/.golint_failures b/hack/.golint_failures index c028ddbbcc0..91f2b65e9b5 100644 --- a/hack/.golint_failures +++ b/hack/.golint_failures @@ -615,12 +615,8 @@ staging/src/k8s.io/kube-proxy/config/v1alpha1 staging/src/k8s.io/kubelet/config/v1beta1 staging/src/k8s.io/metrics/pkg/apis/custom_metrics staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1 -staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2 staging/src/k8s.io/metrics/pkg/apis/external_metrics -staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1 staging/src/k8s.io/metrics/pkg/apis/metrics -staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1 -staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1 staging/src/k8s.io/metrics/pkg/client/custom_metrics staging/src/k8s.io/metrics/pkg/client/custom_metrics/fake staging/src/k8s.io/metrics/pkg/client/custom_metrics/scheme diff --git a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/register.go b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/register.go index f1b43e9cb60..6811f0632ef 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/register.go +++ b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/register.go @@ -34,9 +34,11 @@ func Resource(resource string) schema.GroupResource { } var ( + // SchemeBuilder points to a list of functions added to Scheme. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addConversionFuncs) localSchemeBuilder = &SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme applies all the stored functions to the scheme. + AddToScheme = localSchemeBuilder.AddToScheme ) func addKnownTypes(scheme *runtime.Scheme) error { diff --git a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/types.go b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/types.go index aa97053ca62..469ad18c8a8 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/types.go +++ b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/types.go @@ -24,7 +24,7 @@ import ( // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// a list of values for a given metric for some set of objects +// MetricValueList is a list of values for a given metric for some set of objects type MetricValueList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` @@ -35,7 +35,7 @@ type MetricValueList struct { // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// a metric value for some object +// MetricValue is a metric value for some object type MetricValue struct { metav1.TypeMeta `json:",inline"` @@ -81,6 +81,6 @@ type MetricListOptions struct { MetricLabelSelector string `json:"metricLabelSelector,omitempty" protobuf:"bytes,2,opt,name=metricLabelSelector"` } -// allObjects is a wildcard used to select metrics +// AllObjects is a wildcard used to select metrics // for all objects matching the given label selector const AllObjects = "*" diff --git a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/register.go b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/register.go index 69357d43ed7..69e6cb02511 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/register.go +++ b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/register.go @@ -34,9 +34,11 @@ func Resource(resource string) schema.GroupResource { } var ( + // SchemeBuilder points to a list of functions added to Scheme. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) localSchemeBuilder = &SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme applies all the stored functions to the scheme. + AddToScheme = localSchemeBuilder.AddToScheme ) func addKnownTypes(scheme *runtime.Scheme) error { diff --git a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/register.go b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/register.go index 83f1e9e6121..85dfc5b1d9d 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/register.go +++ b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/register.go @@ -34,9 +34,11 @@ func Resource(resource string) schema.GroupResource { } var ( + // SchemeBuilder points to a list of functions added to Scheme. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) localSchemeBuilder = &SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme applies all the stored functions to the scheme. + AddToScheme = localSchemeBuilder.AddToScheme ) func addKnownTypes(scheme *runtime.Scheme) error { diff --git a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/types.go b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/types.go index edf78ed43d2..56210539a5b 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/types.go +++ b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/types.go @@ -23,7 +23,7 @@ import ( // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// a list of values for a given metric for some set labels +// ExternalMetricValueList is a list of values for a given metric for some set labels type ExternalMetricValueList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` @@ -34,7 +34,7 @@ type ExternalMetricValueList struct { // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// a metric value for external metric +// ExternalMetricValue is a metric value for external metric // A single metric value is identified by metric name and a set of string labels. // For one metric there can be multiple values with different sets of labels. type ExternalMetricValue struct { diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/register.go b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/register.go index 306ed8c3df2..3e5359a8ee3 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/register.go +++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/register.go @@ -34,9 +34,11 @@ func Resource(resource string) schema.GroupResource { } var ( + // SchemeBuilder points to a list of functions added to Scheme. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) localSchemeBuilder = &SchemeBuilder - AddToScheme = SchemeBuilder.AddToScheme + // AddToScheme applies all the stored functions to the scheme. + AddToScheme = SchemeBuilder.AddToScheme ) func addKnownTypes(scheme *runtime.Scheme) error { diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go index 64d70682455..ddb15f5f4e9 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go +++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go @@ -27,7 +27,7 @@ import ( // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// resource usage metrics of a node. +// NodeMetrics sets resource usage metrics of a node. type NodeMetrics struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` @@ -59,7 +59,7 @@ type NodeMetricsList struct { // +genclient:readonly // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// resource usage metrics of a pod. +// PodMetrics sets resource usage metrics of a pod. type PodMetrics struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` @@ -86,7 +86,7 @@ type PodMetricsList struct { Items []PodMetrics `json:"items" protobuf:"bytes,2,rep,name=items"` } -// resource usage metrics of a container. +// ContainerMetrics sets resource usage metrics of a container. type ContainerMetrics struct { // Container name corresponding to the one from pod.spec.containers. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/register.go b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/register.go index 0db1e78b395..205d253c779 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/register.go +++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/register.go @@ -34,9 +34,11 @@ func Resource(resource string) schema.GroupResource { } var ( + // SchemeBuilder points to a list of functions added to Scheme. SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) localSchemeBuilder = &SchemeBuilder - AddToScheme = SchemeBuilder.AddToScheme + // AddToScheme applies all the stored functions to the scheme. + AddToScheme = SchemeBuilder.AddToScheme ) func addKnownTypes(scheme *runtime.Scheme) error { diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/types.go b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/types.go index a1f15395081..a0f1f53a583 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/types.go +++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/types.go @@ -27,7 +27,7 @@ import ( // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// resource usage metrics of a node. +// NodeMetrics sets resource usage metrics of a node. type NodeMetrics struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` @@ -59,7 +59,7 @@ type NodeMetricsList struct { // +genclient:readonly // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// resource usage metrics of a pod. +// PodMetrics sets resource usage metrics of a pod. type PodMetrics struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` @@ -86,7 +86,7 @@ type PodMetricsList struct { Items []PodMetrics `json:"items" protobuf:"bytes,2,rep,name=items"` } -// resource usage metrics of a container. +// ContainerMetrics sets resource usage metrics of a container. type ContainerMetrics struct { // Container name corresponding to the one from pod.spec.containers. Name string `json:"name" protobuf:"bytes,1,opt,name=name"` From 6a27a4a5b9a5fd0bdfd5e4075a0b9c430f9eaf52 Mon Sep 17 00:00:00 2001 From: danielqsj Date: Fri, 1 Mar 2019 06:41:09 -0700 Subject: [PATCH 2/2] update generated file --- .../metrics/pkg/apis/custom_metrics/v1beta1/generated.proto | 4 ++-- .../pkg/apis/external_metrics/v1beta1/generated.proto | 4 ++-- .../metrics/pkg/apis/metrics/v1alpha1/generated.proto | 6 +++--- .../k8s.io/metrics/pkg/apis/metrics/v1beta1/generated.proto | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/generated.proto b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/generated.proto index 9d4d2596798..56480ebb957 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/generated.proto +++ b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/generated.proto @@ -42,7 +42,7 @@ message MetricListOptions { optional string metricLabelSelector = 2; } -// a metric value for some object +// MetricValue is a metric value for some object message MetricValue { // a reference to the described object optional k8s.io.api.core.v1.ObjectReference describedObject = 1; @@ -70,7 +70,7 @@ message MetricValue { optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 6; } -// a list of values for a given metric for some set of objects +// MetricValueList is a list of values for a given metric for some set of objects message MetricValueList { optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; diff --git a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/generated.proto b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/generated.proto index 53aec67e6a9..61ab0de649d 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/generated.proto +++ b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/generated.proto @@ -29,7 +29,7 @@ import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto"; // Package-wide variables from generator "generated". option go_package = "v1beta1"; -// a metric value for external metric +// ExternalMetricValue is a metric value for external metric // A single metric value is identified by metric name and a set of string labels. // For one metric there can be multiple values with different sets of labels. message ExternalMetricValue { @@ -52,7 +52,7 @@ message ExternalMetricValue { optional k8s.io.apimachinery.pkg.api.resource.Quantity value = 5; } -// a list of values for a given metric for some set labels +// ExternalMetricValueList is a list of values for a given metric for some set labels message ExternalMetricValueList { optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/generated.proto b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/generated.proto index 41b8f2e106c..a7d46f46dbd 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/generated.proto +++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/generated.proto @@ -30,7 +30,7 @@ import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto"; // Package-wide variables from generator "generated". option go_package = "v1alpha1"; -// resource usage metrics of a container. +// ContainerMetrics sets resource usage metrics of a container. message ContainerMetrics { // Container name corresponding to the one from pod.spec.containers. optional string name = 1; @@ -39,7 +39,7 @@ message ContainerMetrics { map usage = 2; } -// resource usage metrics of a node. +// NodeMetrics sets resource usage metrics of a node. message NodeMetrics { optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; @@ -63,7 +63,7 @@ message NodeMetricsList { repeated NodeMetrics items = 2; } -// resource usage metrics of a pod. +// PodMetrics sets resource usage metrics of a pod. message PodMetrics { optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/generated.proto b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/generated.proto index 86167a10dc5..2f62317f030 100644 --- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/generated.proto +++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/generated.proto @@ -30,7 +30,7 @@ import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto"; // Package-wide variables from generator "generated". option go_package = "v1beta1"; -// resource usage metrics of a container. +// ContainerMetrics sets resource usage metrics of a container. message ContainerMetrics { // Container name corresponding to the one from pod.spec.containers. optional string name = 1; @@ -39,7 +39,7 @@ message ContainerMetrics { map usage = 2; } -// resource usage metrics of a node. +// NodeMetrics sets resource usage metrics of a node. message NodeMetrics { optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; @@ -63,7 +63,7 @@ message NodeMetricsList { repeated NodeMetrics items = 2; } -// resource usage metrics of a pod. +// PodMetrics sets resource usage metrics of a pod. message PodMetrics { optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;