blob: ca4e5e53506a541125fd0e70b49f5415258b9e0d [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
Zack Williamse940c7a2019-08-21 14:25:39 -070024import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
25import "k8s.io/apimachinery/pkg/runtime/generated.proto";
26import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
27
28// Package-wide variables from generator "generated".
29option go_package = "v1alpha1";
30
Zack Williamse940c7a2019-08-21 14:25:39 -070031// RuntimeClass defines a class of container runtime supported in the cluster.
32// The RuntimeClass is used to determine which container runtime is used to run
33// all containers in a pod. RuntimeClasses are (currently) manually defined by a
34// user or cluster provisioner, and referenced in the PodSpec. The Kubelet is
35// responsible for resolving the RuntimeClassName reference before running the
36// pod. For more details, see
37// https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md
38message RuntimeClass {
39 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
40 // +optional
41 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
42
43 // Specification of the RuntimeClass
44 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
45 optional RuntimeClassSpec spec = 2;
46}
47
48// RuntimeClassList is a list of RuntimeClass objects.
49message RuntimeClassList {
50 // Standard list metadata.
51 // More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
52 // +optional
53 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
54
55 // Items is a list of schema objects.
56 repeated RuntimeClass items = 2;
57}
58
59// RuntimeClassSpec is a specification of a RuntimeClass. It contains parameters
60// that are required to describe the RuntimeClass to the Container Runtime
61// Interface (CRI) implementation, as well as any other components that need to
62// understand how the pod will be run. The RuntimeClassSpec is immutable.
63message RuntimeClassSpec {
64 // RuntimeHandler specifies the underlying runtime and configuration that the
65 // CRI implementation will use to handle pods of this class. The possible
66 // values are specific to the node & CRI configuration. It is assumed that
67 // all handlers are available on every node, and handlers of the same name are
68 // equivalent on every node.
69 // For example, a handler called "runc" might specify that the runc OCI
70 // runtime (using native Linux containers) will be used to run the containers
71 // in a pod.
72 // The RuntimeHandler must conform to the DNS Label (RFC 1123) requirements
73 // and is immutable.
74 optional string runtimeHandler = 1;
Zack Williamse940c7a2019-08-21 14:25:39 -070075}
76