blob: 993c6e50660814ae2e6db01f178a8c49254cc02c [file] [log] [blame]
Zack Williamse940c7a2019-08-21 14:25:39 -07001/*
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 (
Zack Williamse940c7a2019-08-21 14:25:39 -070020 metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
21)
22
23// +genclient
24// +genclient:nonNamespaced
25// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
26
27// RuntimeClass defines a class of container runtime supported in the cluster.
28// The RuntimeClass is used to determine which container runtime is used to run
29// all containers in a pod. RuntimeClasses are (currently) manually defined by a
30// user or cluster provisioner, and referenced in the PodSpec. The Kubelet is
31// responsible for resolving the RuntimeClassName reference before running the
32// pod. For more details, see
33// https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md
34type RuntimeClass struct {
35 metav1.TypeMeta `json:",inline"`
36 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
37 // +optional
38 metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
39
40 // Handler specifies the underlying runtime and configuration that the CRI
41 // implementation will use to handle pods of this class. The possible values
42 // are specific to the node & CRI configuration. It is assumed that all
43 // handlers are available on every node, and handlers of the same name are
44 // equivalent on every node.
45 // For example, a handler called "runc" might specify that the runc OCI
46 // runtime (using native Linux containers) will be used to run the containers
47 // in a pod.
48 // The Handler must conform to the DNS Label (RFC 1123) requirements, and is
49 // immutable.
50 Handler string `json:"handler" protobuf:"bytes,2,opt,name=handler"`
Zack Williamse940c7a2019-08-21 14:25:39 -070051}
52
53// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
54
55// RuntimeClassList is a list of RuntimeClass objects.
56type RuntimeClassList struct {
57 metav1.TypeMeta `json:",inline"`
58 // Standard list metadata.
59 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
60 // +optional
61 metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
62
63 // Items is a list of schema objects.
64 Items []RuntimeClass `json:"items" protobuf:"bytes,2,rep,name=items"`
65}