Merge pull request #104627 from arajkumar/add-doc-metrics-kinds

NodeMetrics, PodMetrics: Add doc for metav1.ObjectMeta

staging/src/k8s.io/metrics/pkg/apis/metrics/types.go

@@ -30,6 +30,9 @@ import (
 // NodeMetrics sets resource usage metrics of a node.
 type NodeMetrics struct {
 	metav1.TypeMeta
+	// Standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta
 
 	// The following fields define time interval from which metrics were
@@ -62,6 +65,9 @@ type NodeMetricsList struct {
 // PodMetrics sets resource usage metrics of a pod.
 type PodMetrics struct {
 	metav1.TypeMeta
+	// Standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta
 
 	// The following fields define time interval from which metrics were

staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/generated.proto

@@ -41,6 +41,9 @@ message ContainerMetrics {
 
 // NodeMetrics sets resource usage metrics of a node.
 message NodeMetrics {
+  // Standard object's metadata.
+  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+  // +optional
   optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
 
   // The following fields define time interval from which metrics were
@@ -65,6 +68,9 @@ message NodeMetricsList {
 
 // PodMetrics sets resource usage metrics of a pod.
 message PodMetrics {
+  // Standard object's metadata.
+  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+  // +optional
   optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
 
   // The following fields define time interval from which metrics were

staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go

@@ -17,7 +17,7 @@ limitations under the License.
 package v1alpha1
 
 import (
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -30,6 +30,9 @@ import (
 // NodeMetrics sets resource usage metrics of a node.
 type NodeMetrics struct {
 	metav1.TypeMeta `json:",inline"`
+	// Standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
 
 	// The following fields define time interval from which metrics were
@@ -62,6 +65,9 @@ type NodeMetricsList struct {
 // PodMetrics sets resource usage metrics of a pod.
 type PodMetrics struct {
 	metav1.TypeMeta `json:",inline"`
+	// Standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
 
 	// The following fields define time interval from which metrics were

staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/generated.proto

@@ -41,6 +41,9 @@ message ContainerMetrics {
 
 // NodeMetrics sets resource usage metrics of a node.
 message NodeMetrics {
+  // Standard object's metadata.
+  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+  // +optional
   optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
 
   // The following fields define time interval from which metrics were
@@ -65,6 +68,9 @@ message NodeMetricsList {
 
 // PodMetrics sets resource usage metrics of a pod.
 message PodMetrics {
+  // Standard object's metadata.
+  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+  // +optional
   optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
 
   // The following fields define time interval from which metrics were

staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/types.go

@@ -17,7 +17,7 @@ limitations under the License.
 package v1beta1
 
 import (
-	"k8s.io/api/core/v1"
+	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -30,6 +30,9 @@ import (
 // NodeMetrics sets resource usage metrics of a node.
 type NodeMetrics struct {
 	metav1.TypeMeta `json:",inline"`
+	// Standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
 
 	// The following fields define time interval from which metrics were
@@ -62,6 +65,9 @@ type NodeMetricsList struct {
 // PodMetrics sets resource usage metrics of a pod.
 type PodMetrics struct {
 	metav1.TypeMeta `json:",inline"`
+	// Standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
 
 	// The following fields define time interval from which metrics were