1/*
2Copyright 2019 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
17package v1beta1
18
19import (
20	corev1 "k8s.io/api/core/v1"
21	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
22)
23
24// +genclient
25// +genclient:nonNamespaced
26// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
27
28// RuntimeClass defines a class of container runtime supported in the cluster.
29// The RuntimeClass is used to determine which container runtime is used to run
30// all containers in a pod. RuntimeClasses are (currently) manually defined by a
31// user or cluster provisioner, and referenced in the PodSpec. The Kubelet is
32// responsible for resolving the RuntimeClassName reference before running the
33// pod.  For more details, see
34// https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md
35type RuntimeClass struct {
36	metav1.TypeMeta `json:",inline"`
37	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
38	// +optional
39	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
40
41	// Handler specifies the underlying runtime and configuration that the CRI
42	// implementation will use to handle pods of this class. The possible values
43	// are specific to the node & CRI configuration.  It is assumed that all
44	// handlers are available on every node, and handlers of the same name are
45	// equivalent on every node.
46	// For example, a handler called "runc" might specify that the runc OCI
47	// runtime (using native Linux containers) will be used to run the containers
48	// in a pod.
49	// The Handler must conform to the DNS Label (RFC 1123) requirements, and is
50	// immutable.
51	Handler string `json:"handler" protobuf:"bytes,2,opt,name=handler"`
52
53	// Overhead represents the resource overhead associated with running a pod for a
54	// given RuntimeClass. For more details, see
55	// https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md
56	// This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.
57	// +optional
58	Overhead *Overhead `json:"overhead,omitempty" protobuf:"bytes,3,opt,name=overhead"`
59
60	// Scheduling holds the scheduling constraints to ensure that pods running
61	// with this RuntimeClass are scheduled to nodes that support it.
62	// If scheduling is nil, this RuntimeClass is assumed to be supported by all
63	// nodes.
64	// +optional
65	Scheduling *Scheduling `json:"scheduling,omitempty" protobuf:"bytes,4,opt,name=scheduling"`
66}
67
68// Overhead structure represents the resource overhead associated with running a pod.
69type Overhead struct {
70	// PodFixed represents the fixed resource overhead associated with running a pod.
71	// +optional
72	PodFixed corev1.ResourceList `json:"podFixed,omitempty" protobuf:"bytes,1,opt,name=podFixed,casttype=k8s.io/api/core/v1.ResourceList,castkey=k8s.io/api/core/v1.ResourceName,castvalue=k8s.io/apimachinery/pkg/api/resource.Quantity"`
73}
74
75// Scheduling specifies the scheduling constraints for nodes supporting a
76// RuntimeClass.
77type Scheduling struct {
78	// nodeSelector lists labels that must be present on nodes that support this
79	// RuntimeClass. Pods using this RuntimeClass can only be scheduled to a
80	// node matched by this selector. The RuntimeClass nodeSelector is merged
81	// with a pod's existing nodeSelector. Any conflicts will cause the pod to
82	// be rejected in admission.
83	// +optional
84	NodeSelector map[string]string `json:"nodeSelector,omitempty" protobuf:"bytes,1,opt,name=nodeSelector"`
85
86	// tolerations are appended (excluding duplicates) to pods running with this
87	// RuntimeClass during admission, effectively unioning the set of nodes
88	// tolerated by the pod and the RuntimeClass.
89	// +optional
90	// +listType=atomic
91	Tolerations []corev1.Toleration `json:"tolerations,omitempty" protobuf:"bytes,2,rep,name=tolerations"`
92}
93
94// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
95
96// RuntimeClassList is a list of RuntimeClass objects.
97type RuntimeClassList struct {
98	metav1.TypeMeta `json:",inline"`
99	// Standard list metadata.
100	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
101	// +optional
102	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
103
104	// Items is a list of schema objects.
105	Items []RuntimeClass `json:"items" protobuf:"bytes,2,rep,name=items"`
106}
107