github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-28 14:07:14 +00:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
NodeMetrics, PodMetrics: Add doc for metav1.ObjectMeta
This commit is contained in:
Kubernetes Prow Robot 2021-09-16 11:35:26 -07:00 committed by GitHub
commit 139a50c5d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 36 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
staging/src/k8s.io/metrics/pkg/apis/metrics/types.go
View File

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

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

@ -41,6 +41,9 @@ message ContainerMetrics {
// NodeMetrics sets resource usage metrics of a node. // NodeMetrics sets resource usage metrics of a node.
message NodeMetrics { 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; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// The following fields define time interval from which metrics were // The following fields define time interval from which metrics were
@ -65,6 +68,9 @@ message NodeMetricsList {
// PodMetrics sets resource usage metrics of a pod. // PodMetrics sets resource usage metrics of a pod.
message PodMetrics { 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; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// The following fields define time interval from which metrics were // The following fields define time interval from which metrics were

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

@ -17,7 +17,7 @@ limitations under the License.
package v1alpha1 package v1alpha1
import ( import (
"k8s.io/api/core/v1" v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
) )
@ -30,6 +30,9 @@ import (
// NodeMetrics sets resource usage metrics of a node. // NodeMetrics sets resource usage metrics of a node.
type NodeMetrics struct { type NodeMetrics struct {
metav1.TypeMeta `json:",inline"` 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"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// The following fields define time interval from which metrics were // 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. // PodMetrics sets resource usage metrics of a pod.
type PodMetrics struct { type PodMetrics struct {
metav1.TypeMeta `json:",inline"` 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"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// The following fields define time interval from which metrics were // The following fields define time interval from which metrics were

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

@ -41,6 +41,9 @@ message ContainerMetrics {
// NodeMetrics sets resource usage metrics of a node. // NodeMetrics sets resource usage metrics of a node.
message NodeMetrics { 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; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// The following fields define time interval from which metrics were // The following fields define time interval from which metrics were
@ -65,6 +68,9 @@ message NodeMetricsList {
// PodMetrics sets resource usage metrics of a pod. // PodMetrics sets resource usage metrics of a pod.
message PodMetrics { 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; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// The following fields define time interval from which metrics were // The following fields define time interval from which metrics were

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

@ -17,7 +17,7 @@ limitations under the License.
package v1beta1 package v1beta1
import ( import (
"k8s.io/api/core/v1" v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
) )
@ -30,6 +30,9 @@ import (
// NodeMetrics sets resource usage metrics of a node. // NodeMetrics sets resource usage metrics of a node.
type NodeMetrics struct { type NodeMetrics struct {
metav1.TypeMeta `json:",inline"` 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"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// The following fields define time interval from which metrics were // 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. // PodMetrics sets resource usage metrics of a pod.
type PodMetrics struct { type PodMetrics struct {
metav1.TypeMeta `json:",inline"` 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"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// The following fields define time interval from which metrics were // The following fields define time interval from which metrics were