Matteo Scandolo | a428586 | 2020-12-01 18:10:10 -0800 | [diff] [blame] | 1 | /* |
| 2 | Copyright 2018 The Kubernetes Authors. |
| 3 | |
| 4 | Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | you may not use this file except in compliance with the License. |
| 6 | You may obtain a copy of the License at |
| 7 | |
| 8 | http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | |
| 10 | Unless required by applicable law or agreed to in writing, software |
| 11 | distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | See the License for the specific language governing permissions and |
| 14 | limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package v1alpha1 |
| 18 | |
| 19 | import ( |
| 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 |
| 35 | type 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 | // Specification of the RuntimeClass |
| 42 | // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| 43 | Spec RuntimeClassSpec `json:"spec" protobuf:"bytes,2,name=spec"` |
| 44 | } |
| 45 | |
| 46 | // RuntimeClassSpec is a specification of a RuntimeClass. It contains parameters |
| 47 | // that are required to describe the RuntimeClass to the Container Runtime |
| 48 | // Interface (CRI) implementation, as well as any other components that need to |
| 49 | // understand how the pod will be run. The RuntimeClassSpec is immutable. |
| 50 | type RuntimeClassSpec struct { |
| 51 | // RuntimeHandler specifies the underlying runtime and configuration that the |
| 52 | // CRI implementation will use to handle pods of this class. The possible |
| 53 | // values are specific to the node & CRI configuration. It is assumed that |
| 54 | // all handlers are available on every node, and handlers of the same name are |
| 55 | // equivalent on every node. |
| 56 | // For example, a handler called "runc" might specify that the runc OCI |
| 57 | // runtime (using native Linux containers) will be used to run the containers |
| 58 | // in a pod. |
| 59 | // The RuntimeHandler must conform to the DNS Label (RFC 1123) requirements |
| 60 | // and is immutable. |
| 61 | RuntimeHandler string `json:"runtimeHandler" protobuf:"bytes,1,opt,name=runtimeHandler"` |
| 62 | |
| 63 | // Overhead represents the resource overhead associated with running a pod for a |
| 64 | // given RuntimeClass. For more details, see |
| 65 | // https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md |
| 66 | // This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. |
| 67 | // +optional |
| 68 | Overhead *Overhead `json:"overhead,omitempty" protobuf:"bytes,2,opt,name=overhead"` |
| 69 | |
| 70 | // Scheduling holds the scheduling constraints to ensure that pods running |
| 71 | // with this RuntimeClass are scheduled to nodes that support it. |
| 72 | // If scheduling is nil, this RuntimeClass is assumed to be supported by all |
| 73 | // nodes. |
| 74 | // +optional |
| 75 | Scheduling *Scheduling `json:"scheduling,omitempty" protobuf:"bytes,3,opt,name=scheduling"` |
| 76 | } |
| 77 | |
| 78 | // Overhead structure represents the resource overhead associated with running a pod. |
| 79 | type Overhead struct { |
| 80 | // PodFixed represents the fixed resource overhead associated with running a pod. |
| 81 | // +optional |
| 82 | 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"` |
| 83 | } |
| 84 | |
| 85 | // Scheduling specifies the scheduling constraints for nodes supporting a |
| 86 | // RuntimeClass. |
| 87 | type Scheduling struct { |
| 88 | // nodeSelector lists labels that must be present on nodes that support this |
| 89 | // RuntimeClass. Pods using this RuntimeClass can only be scheduled to a |
| 90 | // node matched by this selector. The RuntimeClass nodeSelector is merged |
| 91 | // with a pod's existing nodeSelector. Any conflicts will cause the pod to |
| 92 | // be rejected in admission. |
| 93 | // +optional |
| 94 | NodeSelector map[string]string `json:"nodeSelector,omitempty" protobuf:"bytes,1,opt,name=nodeSelector"` |
| 95 | |
| 96 | // tolerations are appended (excluding duplicates) to pods running with this |
| 97 | // RuntimeClass during admission, effectively unioning the set of nodes |
| 98 | // tolerated by the pod and the RuntimeClass. |
| 99 | // +optional |
| 100 | // +listType=atomic |
| 101 | Tolerations []corev1.Toleration `json:"tolerations,omitempty" protobuf:"bytes,2,rep,name=tolerations"` |
| 102 | } |
| 103 | |
| 104 | // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| 105 | |
| 106 | // RuntimeClassList is a list of RuntimeClass objects. |
| 107 | type RuntimeClassList struct { |
| 108 | metav1.TypeMeta `json:",inline"` |
| 109 | // Standard list metadata. |
| 110 | // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| 111 | // +optional |
| 112 | metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| 113 | |
| 114 | // Items is a list of schema objects. |
| 115 | Items []RuntimeClass `json:"items" protobuf:"bytes,2,rep,name=items"` |
| 116 | } |