...

Text file src/k8s.io/api/node/v1alpha1/generated.proto

Documentation: k8s.io/api/node/v1alpha1

     1/*
     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 = "k8s.io/api/node/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/585-runtime-class
    47message RuntimeClass {
    48  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    49  // +optional
    50  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
    51
    52  // spec represents specification of the RuntimeClass
    53  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/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/sig-architecture/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 be lowercase, conform to the DNS Label (RFC 1123)
    82  // requirements, 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/688-pod-overhead/README.md
    88  // +optional
    89  optional Overhead overhead = 2;
    90
    91  // scheduling holds the scheduling constraints to ensure that pods running
    92  // with this RuntimeClass are scheduled to nodes that support it.
    93  // If scheduling is nil, this RuntimeClass is assumed to be supported by all
    94  // nodes.
    95  // +optional
    96  optional Scheduling scheduling = 3;
    97}
    98
    99// Scheduling specifies the scheduling constraints for nodes supporting a
   100// RuntimeClass.
   101message Scheduling {
   102  // nodeSelector lists labels that must be present on nodes that support this
   103  // RuntimeClass. Pods using this RuntimeClass can only be scheduled to a
   104  // node matched by this selector. The RuntimeClass nodeSelector is merged
   105  // with a pod's existing nodeSelector. Any conflicts will cause the pod to
   106  // be rejected in admission.
   107  // +optional
   108  // +mapType=atomic
   109  map<string, string> nodeSelector = 1;
   110
   111  // tolerations are appended (excluding duplicates) to pods running with this
   112  // RuntimeClass during admission, effectively unioning the set of nodes
   113  // tolerated by the pod and the RuntimeClass.
   114  // +optional
   115  // +listType=atomic
   116  repeated k8s.io.api.core.v1.Toleration tolerations = 2;
   117}
   118

View as plain text