blob: 05c48aeed747e4f34603a1bf86625b9196872062 [file] [log] [blame]
Zack Williamse940c7a2019-08-21 14:25:39 -07001/*
2Copyright The Kubernetes Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17
18// This file was autogenerated by go-to-protobuf. Do not edit it manually!
19
20syntax = 'proto2';
21
22package k8s.io.api.node.v1alpha1;
23
24import "k8s.io/api/core/v1/generated.proto";
25import "k8s.io/apimachinery/pkg/api/resource/generated.proto";
26import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
27import "k8s.io/apimachinery/pkg/runtime/generated.proto";
28import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
29
30// Package-wide variables from generator "generated".
31option go_package = "v1alpha1";
32
33// Overhead structure represents the resource overhead associated with running a pod.
34message Overhead {
35 // PodFixed represents the fixed resource overhead associated with running a pod.
36 // +optional
37 map<string, k8s.io.apimachinery.pkg.api.resource.Quantity> podFixed = 1;
38}
39
40// RuntimeClass defines a class of container runtime supported in the cluster.
41// The RuntimeClass is used to determine which container runtime is used to run
42// all containers in a pod. RuntimeClasses are (currently) manually defined by a
43// user or cluster provisioner, and referenced in the PodSpec. The Kubelet is
44// responsible for resolving the RuntimeClassName reference before running the
45// pod. For more details, see
46// https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md
47message RuntimeClass {
48 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
49 // +optional
50 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
51
52 // Specification of the RuntimeClass
53 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
54 optional RuntimeClassSpec spec = 2;
55}
56
57// RuntimeClassList is a list of RuntimeClass objects.
58message RuntimeClassList {
59 // Standard list metadata.
60 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
61 // +optional
62 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
63
64 // Items is a list of schema objects.
65 repeated RuntimeClass items = 2;
66}
67
68// RuntimeClassSpec is a specification of a RuntimeClass. It contains parameters
69// that are required to describe the RuntimeClass to the Container Runtime
70// Interface (CRI) implementation, as well as any other components that need to
71// understand how the pod will be run. The RuntimeClassSpec is immutable.
72message RuntimeClassSpec {
73 // RuntimeHandler specifies the underlying runtime and configuration that the
74 // CRI implementation will use to handle pods of this class. The possible
75 // values are specific to the node & CRI configuration. It is assumed that
76 // all handlers are available on every node, and handlers of the same name are
77 // equivalent on every node.
78 // For example, a handler called "runc" might specify that the runc OCI
79 // runtime (using native Linux containers) will be used to run the containers
80 // in a pod.
81 // The RuntimeHandler must conform to the DNS Label (RFC 1123) requirements
82 // and is immutable.
83 optional string runtimeHandler = 1;
84
85 // Overhead represents the resource overhead associated with running a pod for a
86 // given RuntimeClass. For more details, see
87 // https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md
88 // This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.
89 // +optional
90 optional Overhead overhead = 2;
91}
92