...

Text file src/k8s.io/api/extensions/v1beta1/generated.proto

Documentation: k8s.io/api/extensions/v1beta1

     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.extensions.v1beta1;
    23
    24import "k8s.io/api/core/v1/generated.proto";
    25import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
    26import "k8s.io/apimachinery/pkg/runtime/generated.proto";
    27import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";
    28import "k8s.io/apimachinery/pkg/util/intstr/generated.proto";
    29
    30// Package-wide variables from generator "generated".
    31option go_package = "k8s.io/api/extensions/v1beta1";
    32
    33// DEPRECATED - This group version of DaemonSet is deprecated by apps/v1beta2/DaemonSet. See the release notes for
    34// more information.
    35// DaemonSet represents the configuration of a daemon set.
    36message DaemonSet {
    37  // Standard object's metadata.
    38  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    39  // +optional
    40  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
    41
    42  // The desired behavior of this daemon set.
    43  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    44  // +optional
    45  optional DaemonSetSpec spec = 2;
    46
    47  // The current status of this daemon set. This data may be
    48  // out of date by some window of time.
    49  // Populated by the system.
    50  // Read-only.
    51  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
    52  // +optional
    53  optional DaemonSetStatus status = 3;
    54}
    55
    56// DaemonSetCondition describes the state of a DaemonSet at a certain point.
    57message DaemonSetCondition {
    58  // Type of DaemonSet condition.
    59  optional string type = 1;
    60
    61  // Status of the condition, one of True, False, Unknown.
    62  optional string status = 2;
    63
    64  // Last time the condition transitioned from one status to another.
    65  // +optional
    66  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
    67
    68  // The reason for the condition's last transition.
    69  // +optional
    70  optional string reason = 4;
    71
    72  // A human readable message indicating details about the transition.
    73  // +optional
    74  optional string message = 5;
    75}
    76
    77// DaemonSetList is a collection of daemon sets.
    78message DaemonSetList {
    79  // Standard list metadata.
    80  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
    81  // +optional
    82  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
    83
    84  // A list of daemon sets.
    85  repeated DaemonSet items = 2;
    86}
    87
    88// DaemonSetSpec is the specification of a daemon set.
    89message DaemonSetSpec {
    90  // A label query over pods that are managed by the daemon set.
    91  // Must match in order to be controlled.
    92  // If empty, defaulted to labels on Pod template.
    93  // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
    94  // +optional
    95  optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 1;
    96
    97  // An object that describes the pod that will be created.
    98  // The DaemonSet will create exactly one copy of this pod on every node
    99  // that matches the template's node selector (or on every node if no node
   100  // selector is specified).
   101  // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
   102  optional k8s.io.api.core.v1.PodTemplateSpec template = 2;
   103
   104  // An update strategy to replace existing DaemonSet pods with new pods.
   105  // +optional
   106  optional DaemonSetUpdateStrategy updateStrategy = 3;
   107
   108  // The minimum number of seconds for which a newly created DaemonSet pod should
   109  // be ready without any of its container crashing, for it to be considered
   110  // available. Defaults to 0 (pod will be considered available as soon as it
   111  // is ready).
   112  // +optional
   113  optional int32 minReadySeconds = 4;
   114
   115  // DEPRECATED.
   116  // A sequence number representing a specific generation of the template.
   117  // Populated by the system. It can be set only during the creation.
   118  // +optional
   119  optional int64 templateGeneration = 5;
   120
   121  // The number of old history to retain to allow rollback.
   122  // This is a pointer to distinguish between explicit zero and not specified.
   123  // Defaults to 10.
   124  // +optional
   125  optional int32 revisionHistoryLimit = 6;
   126}
   127
   128// DaemonSetStatus represents the current status of a daemon set.
   129message DaemonSetStatus {
   130  // The number of nodes that are running at least 1
   131  // daemon pod and are supposed to run the daemon pod.
   132  // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
   133  optional int32 currentNumberScheduled = 1;
   134
   135  // The number of nodes that are running the daemon pod, but are
   136  // not supposed to run the daemon pod.
   137  // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
   138  optional int32 numberMisscheduled = 2;
   139
   140  // The total number of nodes that should be running the daemon
   141  // pod (including nodes correctly running the daemon pod).
   142  // More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
   143  optional int32 desiredNumberScheduled = 3;
   144
   145  // The number of nodes that should be running the daemon pod and have one
   146  // or more of the daemon pod running and ready.
   147  optional int32 numberReady = 4;
   148
   149  // The most recent generation observed by the daemon set controller.
   150  // +optional
   151  optional int64 observedGeneration = 5;
   152
   153  // The total number of nodes that are running updated daemon pod
   154  // +optional
   155  optional int32 updatedNumberScheduled = 6;
   156
   157  // The number of nodes that should be running the
   158  // daemon pod and have one or more of the daemon pod running and
   159  // available (ready for at least spec.minReadySeconds)
   160  // +optional
   161  optional int32 numberAvailable = 7;
   162
   163  // The number of nodes that should be running the
   164  // daemon pod and have none of the daemon pod running and available
   165  // (ready for at least spec.minReadySeconds)
   166  // +optional
   167  optional int32 numberUnavailable = 8;
   168
   169  // Count of hash collisions for the DaemonSet. The DaemonSet controller
   170  // uses this field as a collision avoidance mechanism when it needs to
   171  // create the name for the newest ControllerRevision.
   172  // +optional
   173  optional int32 collisionCount = 9;
   174
   175  // Represents the latest available observations of a DaemonSet's current state.
   176  // +optional
   177  // +patchMergeKey=type
   178  // +patchStrategy=merge
   179  // +listType=map
   180  // +listMapKey=type
   181  repeated DaemonSetCondition conditions = 10;
   182}
   183
   184// DaemonSetUpdateStrategy indicates the strategy that the DaemonSet
   185// controller will use to perform updates. It includes any additional parameters
   186// necessary to perform the update for the indicated strategy.
   187message DaemonSetUpdateStrategy {
   188  // Type of daemon set update. Can be "RollingUpdate" or "OnDelete".
   189  // Default is OnDelete.
   190  // +optional
   191  optional string type = 1;
   192
   193  // Rolling update config params. Present only if type = "RollingUpdate".
   194  // ---
   195  // TODO: Update this to follow our convention for oneOf, whatever we decide it
   196  // to be. Same as Deployment `strategy.rollingUpdate`.
   197  // See https://github.com/kubernetes/kubernetes/issues/35345
   198  // +optional
   199  optional RollingUpdateDaemonSet rollingUpdate = 2;
   200}
   201
   202// DEPRECATED - This group version of Deployment is deprecated by apps/v1beta2/Deployment. See the release notes for
   203// more information.
   204// Deployment enables declarative updates for Pods and ReplicaSets.
   205message Deployment {
   206  // Standard object metadata.
   207  // +optional
   208  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
   209
   210  // Specification of the desired behavior of the Deployment.
   211  // +optional
   212  optional DeploymentSpec spec = 2;
   213
   214  // Most recently observed status of the Deployment.
   215  // +optional
   216  optional DeploymentStatus status = 3;
   217}
   218
   219// DeploymentCondition describes the state of a deployment at a certain point.
   220message DeploymentCondition {
   221  // Type of deployment condition.
   222  optional string type = 1;
   223
   224  // Status of the condition, one of True, False, Unknown.
   225  optional string status = 2;
   226
   227  // The last time this condition was updated.
   228  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastUpdateTime = 6;
   229
   230  // Last time the condition transitioned from one status to another.
   231  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 7;
   232
   233  // The reason for the condition's last transition.
   234  optional string reason = 4;
   235
   236  // A human readable message indicating details about the transition.
   237  optional string message = 5;
   238}
   239
   240// DeploymentList is a list of Deployments.
   241message DeploymentList {
   242  // Standard list metadata.
   243  // +optional
   244  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
   245
   246  // Items is the list of Deployments.
   247  repeated Deployment items = 2;
   248}
   249
   250// DEPRECATED.
   251// DeploymentRollback stores the information required to rollback a deployment.
   252message DeploymentRollback {
   253  // Required: This must match the Name of a deployment.
   254  optional string name = 1;
   255
   256  // The annotations to be updated to a deployment
   257  // +optional
   258  map<string, string> updatedAnnotations = 2;
   259
   260  // The config of this deployment rollback.
   261  optional RollbackConfig rollbackTo = 3;
   262}
   263
   264// DeploymentSpec is the specification of the desired behavior of the Deployment.
   265message DeploymentSpec {
   266  // Number of desired pods. This is a pointer to distinguish between explicit
   267  // zero and not specified. Defaults to 1.
   268  // +optional
   269  optional int32 replicas = 1;
   270
   271  // Label selector for pods. Existing ReplicaSets whose pods are
   272  // selected by this will be the ones affected by this deployment.
   273  // +optional
   274  optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
   275
   276  // Template describes the pods that will be created.
   277  optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
   278
   279  // The deployment strategy to use to replace existing pods with new ones.
   280  // +optional
   281  // +patchStrategy=retainKeys
   282  optional DeploymentStrategy strategy = 4;
   283
   284  // Minimum number of seconds for which a newly created pod should be ready
   285  // without any of its container crashing, for it to be considered available.
   286  // Defaults to 0 (pod will be considered available as soon as it is ready)
   287  // +optional
   288  optional int32 minReadySeconds = 5;
   289
   290  // The number of old ReplicaSets to retain to allow rollback.
   291  // This is a pointer to distinguish between explicit zero and not specified.
   292  // This is set to the max value of int32 (i.e. 2147483647) by default, which
   293  // means "retaining all old ReplicaSets".
   294  // +optional
   295  optional int32 revisionHistoryLimit = 6;
   296
   297  // Indicates that the deployment is paused and will not be processed by the
   298  // deployment controller.
   299  // +optional
   300  optional bool paused = 7;
   301
   302  // DEPRECATED.
   303  // The config this deployment is rolling back to. Will be cleared after rollback is done.
   304  // +optional
   305  optional RollbackConfig rollbackTo = 8;
   306
   307  // The maximum time in seconds for a deployment to make progress before it
   308  // is considered to be failed. The deployment controller will continue to
   309  // process failed deployments and a condition with a ProgressDeadlineExceeded
   310  // reason will be surfaced in the deployment status. Note that progress will
   311  // not be estimated during the time a deployment is paused. This is set to
   312  // the max value of int32 (i.e. 2147483647) by default, which means "no deadline".
   313  // +optional
   314  optional int32 progressDeadlineSeconds = 9;
   315}
   316
   317// DeploymentStatus is the most recently observed status of the Deployment.
   318message DeploymentStatus {
   319  // The generation observed by the deployment controller.
   320  // +optional
   321  optional int64 observedGeneration = 1;
   322
   323  // Total number of non-terminated pods targeted by this deployment (their labels match the selector).
   324  // +optional
   325  optional int32 replicas = 2;
   326
   327  // Total number of non-terminated pods targeted by this deployment that have the desired template spec.
   328  // +optional
   329  optional int32 updatedReplicas = 3;
   330
   331  // Total number of ready pods targeted by this deployment.
   332  // +optional
   333  optional int32 readyReplicas = 7;
   334
   335  // Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.
   336  // +optional
   337  optional int32 availableReplicas = 4;
   338
   339  // Total number of unavailable pods targeted by this deployment. This is the total number of
   340  // pods that are still required for the deployment to have 100% available capacity. They may
   341  // either be pods that are running but not yet available or pods that still have not been created.
   342  // +optional
   343  optional int32 unavailableReplicas = 5;
   344
   345  // Represents the latest available observations of a deployment's current state.
   346  // +patchMergeKey=type
   347  // +patchStrategy=merge
   348  // +listType=map
   349  // +listMapKey=type
   350  repeated DeploymentCondition conditions = 6;
   351
   352  // Count of hash collisions for the Deployment. The Deployment controller uses this
   353  // field as a collision avoidance mechanism when it needs to create the name for the
   354  // newest ReplicaSet.
   355  // +optional
   356  optional int32 collisionCount = 8;
   357}
   358
   359// DeploymentStrategy describes how to replace existing pods with new ones.
   360message DeploymentStrategy {
   361  // Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
   362  // +optional
   363  optional string type = 1;
   364
   365  // Rolling update config params. Present only if DeploymentStrategyType =
   366  // RollingUpdate.
   367  // ---
   368  // TODO: Update this to follow our convention for oneOf, whatever we decide it
   369  // to be.
   370  // +optional
   371  optional RollingUpdateDeployment rollingUpdate = 2;
   372}
   373
   374// HTTPIngressPath associates a path with a backend. Incoming urls matching the
   375// path are forwarded to the backend.
   376message HTTPIngressPath {
   377  // Path is matched against the path of an incoming request. Currently it can
   378  // contain characters disallowed from the conventional "path" part of a URL
   379  // as defined by RFC 3986. Paths must begin with a '/'. When unspecified,
   380  // all paths from incoming requests are matched.
   381  // +optional
   382  optional string path = 1;
   383
   384  // PathType determines the interpretation of the Path matching. PathType can
   385  // be one of the following values:
   386  // * Exact: Matches the URL path exactly.
   387  // * Prefix: Matches based on a URL path prefix split by '/'. Matching is
   388  //   done on a path element by element basis. A path element refers is the
   389  //   list of labels in the path split by the '/' separator. A request is a
   390  //   match for path p if every p is an element-wise prefix of p of the
   391  //   request path. Note that if the last element of the path is a substring
   392  //   of the last element in request path, it is not a match (e.g. /foo/bar
   393  //   matches /foo/bar/baz, but does not match /foo/barbaz).
   394  // * ImplementationSpecific: Interpretation of the Path matching is up to
   395  //   the IngressClass. Implementations can treat this as a separate PathType
   396  //   or treat it identically to Prefix or Exact path types.
   397  // Implementations are required to support all path types.
   398  // Defaults to ImplementationSpecific.
   399  optional string pathType = 3;
   400
   401  // Backend defines the referenced service endpoint to which the traffic
   402  // will be forwarded to.
   403  optional IngressBackend backend = 2;
   404}
   405
   406// HTTPIngressRuleValue is a list of http selectors pointing to backends.
   407// In the example: http://<host>/<path>?<searchpart> -> backend where
   408// where parts of the url correspond to RFC 3986, this resource will be used
   409// to match against everything after the last '/' and before the first '?'
   410// or '#'.
   411message HTTPIngressRuleValue {
   412  // A collection of paths that map requests to backends.
   413  // +listType=atomic
   414  repeated HTTPIngressPath paths = 1;
   415}
   416
   417// DEPRECATED 1.9 - This group version of IPBlock is deprecated by networking/v1/IPBlock.
   418// IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") that is allowed
   419// to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs
   420// that should not be included within this rule.
   421message IPBlock {
   422  // CIDR is a string representing the IP Block
   423  // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
   424  optional string cidr = 1;
   425
   426  // Except is a slice of CIDRs that should not be included within an IP Block
   427  // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
   428  // Except values will be rejected if they are outside the CIDR range
   429  // +optional
   430  // +listType=atomic
   431  repeated string except = 2;
   432}
   433
   434// Ingress is a collection of rules that allow inbound connections to reach the
   435// endpoints defined by a backend. An Ingress can be configured to give services
   436// externally-reachable urls, load balance traffic, terminate SSL, offer name
   437// based virtual hosting etc.
   438// DEPRECATED - This group version of Ingress is deprecated by networking.k8s.io/v1beta1 Ingress. See the release notes for more information.
   439message Ingress {
   440  // Standard object's metadata.
   441  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
   442  // +optional
   443  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
   444
   445  // Spec is the desired state of the Ingress.
   446  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
   447  // +optional
   448  optional IngressSpec spec = 2;
   449
   450  // Status is the current state of the Ingress.
   451  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
   452  // +optional
   453  optional IngressStatus status = 3;
   454}
   455
   456// IngressBackend describes all endpoints for a given service and port.
   457message IngressBackend {
   458  // Specifies the name of the referenced service.
   459  // +optional
   460  optional string serviceName = 1;
   461
   462  // Specifies the port of the referenced service.
   463  // +optional
   464  optional k8s.io.apimachinery.pkg.util.intstr.IntOrString servicePort = 2;
   465
   466  // Resource is an ObjectRef to another Kubernetes resource in the namespace
   467  // of the Ingress object. If resource is specified, serviceName and servicePort
   468  // must not be specified.
   469  // +optional
   470  optional k8s.io.api.core.v1.TypedLocalObjectReference resource = 3;
   471}
   472
   473// IngressList is a collection of Ingress.
   474message IngressList {
   475  // Standard object's metadata.
   476  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
   477  // +optional
   478  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
   479
   480  // Items is the list of Ingress.
   481  repeated Ingress items = 2;
   482}
   483
   484// IngressLoadBalancerIngress represents the status of a load-balancer ingress point.
   485message IngressLoadBalancerIngress {
   486  // IP is set for load-balancer ingress points that are IP based.
   487  // +optional
   488  optional string ip = 1;
   489
   490  // Hostname is set for load-balancer ingress points that are DNS based.
   491  // +optional
   492  optional string hostname = 2;
   493
   494  // Ports provides information about the ports exposed by this LoadBalancer.
   495  // +listType=atomic
   496  // +optional
   497  repeated IngressPortStatus ports = 4;
   498}
   499
   500// LoadBalancerStatus represents the status of a load-balancer.
   501message IngressLoadBalancerStatus {
   502  // Ingress is a list containing ingress points for the load-balancer.
   503  // +optional
   504  // +listType=atomic
   505  repeated IngressLoadBalancerIngress ingress = 1;
   506}
   507
   508// IngressPortStatus represents the error condition of a service port
   509message IngressPortStatus {
   510  // Port is the port number of the ingress port.
   511  optional int32 port = 1;
   512
   513  // Protocol is the protocol of the ingress port.
   514  // The supported values are: "TCP", "UDP", "SCTP"
   515  optional string protocol = 2;
   516
   517  // Error is to record the problem with the service port
   518  // The format of the error shall comply with the following rules:
   519  // - built-in error values shall be specified in this file and those shall use
   520  //   CamelCase names
   521  // - cloud provider specific error values must have names that comply with the
   522  //   format foo.example.com/CamelCase.
   523  // ---
   524  // The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
   525  // +optional
   526  // +kubebuilder:validation:Required
   527  // +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
   528  // +kubebuilder:validation:MaxLength=316
   529  optional string error = 3;
   530}
   531
   532// IngressRule represents the rules mapping the paths under a specified host to
   533// the related backend services. Incoming requests are first evaluated for a host
   534// match, then routed to the backend associated with the matching IngressRuleValue.
   535message IngressRule {
   536  // Host is the fully qualified domain name of a network host, as defined by RFC 3986.
   537  // Note the following deviations from the "host" part of the
   538  // URI as defined in RFC 3986:
   539  // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
   540  //    the IP in the Spec of the parent Ingress.
   541  // 2. The `:` delimiter is not respected because ports are not allowed.
   542  // 	  Currently the port of an Ingress is implicitly :80 for http and
   543  // 	  :443 for https.
   544  // Both these may change in the future.
   545  // Incoming requests are matched against the host before the
   546  // IngressRuleValue. If the host is unspecified, the Ingress routes all
   547  // traffic based on the specified IngressRuleValue.
   548  //
   549  // Host can be "precise" which is a domain name without the terminating dot of
   550  // a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name
   551  // prefixed with a single wildcard label (e.g. "*.foo.com").
   552  // The wildcard character '*' must appear by itself as the first DNS label and
   553  // matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*").
   554  // Requests will be matched against the Host field in the following way:
   555  // 1. If Host is precise, the request matches this rule if the http host header is equal to Host.
   556  // 2. If Host is a wildcard, then the request matches this rule if the http host header
   557  // is to equal to the suffix (removing the first label) of the wildcard rule.
   558  // +optional
   559  optional string host = 1;
   560
   561  // IngressRuleValue represents a rule to route requests for this IngressRule.
   562  // If unspecified, the rule defaults to a http catch-all. Whether that sends
   563  // just traffic matching the host to the default backend or all traffic to the
   564  // default backend, is left to the controller fulfilling the Ingress. Http is
   565  // currently the only supported IngressRuleValue.
   566  // +optional
   567  optional IngressRuleValue ingressRuleValue = 2;
   568}
   569
   570// IngressRuleValue represents a rule to apply against incoming requests. If the
   571// rule is satisfied, the request is routed to the specified backend. Currently
   572// mixing different types of rules in a single Ingress is disallowed, so exactly
   573// one of the following must be set.
   574message IngressRuleValue {
   575  // http is a list of http selectors pointing to backends.
   576  // A path is matched against the path of an incoming request. Currently it can
   577  // contain characters disallowed from the conventional "path" part of a URL
   578  // as defined by RFC 3986. Paths must begin with a '/'.
   579  // A backend defines the referenced service endpoint to which the traffic
   580  // will be forwarded to.
   581  optional HTTPIngressRuleValue http = 1;
   582}
   583
   584// IngressSpec describes the Ingress the user wishes to exist.
   585message IngressSpec {
   586  // IngressClassName is the name of the IngressClass cluster resource. The
   587  // associated IngressClass defines which controller will implement the
   588  // resource. This replaces the deprecated `kubernetes.io/ingress.class`
   589  // annotation. For backwards compatibility, when that annotation is set, it
   590  // must be given precedence over this field. The controller may emit a
   591  // warning if the field and annotation have different values.
   592  // Implementations of this API should ignore Ingresses without a class
   593  // specified. An IngressClass resource may be marked as default, which can
   594  // be used to set a default value for this field. For more information,
   595  // refer to the IngressClass documentation.
   596  // +optional
   597  optional string ingressClassName = 4;
   598
   599  // A default backend capable of servicing requests that don't match any
   600  // rule. At least one of 'backend' or 'rules' must be specified. This field
   601  // is optional to allow the loadbalancer controller or defaulting logic to
   602  // specify a global default.
   603  // +optional
   604  optional IngressBackend backend = 1;
   605
   606  // TLS configuration. Currently the Ingress only supports a single TLS
   607  // port, 443. If multiple members of this list specify different hosts, they
   608  // will be multiplexed on the same port according to the hostname specified
   609  // through the SNI TLS extension, if the ingress controller fulfilling the
   610  // ingress supports SNI.
   611  // +optional
   612  // +listType=atomic
   613  repeated IngressTLS tls = 2;
   614
   615  // A list of host rules used to configure the Ingress. If unspecified, or
   616  // no rule matches, all traffic is sent to the default backend.
   617  // +optional
   618  // +listType=atomic
   619  repeated IngressRule rules = 3;
   620}
   621
   622// IngressStatus describe the current state of the Ingress.
   623message IngressStatus {
   624  // LoadBalancer contains the current status of the load-balancer.
   625  // +optional
   626  optional IngressLoadBalancerStatus loadBalancer = 1;
   627}
   628
   629// IngressTLS describes the transport layer security associated with an Ingress.
   630message IngressTLS {
   631  // Hosts are a list of hosts included in the TLS certificate. The values in
   632  // this list must match the name/s used in the tlsSecret. Defaults to the
   633  // wildcard host setting for the loadbalancer controller fulfilling this
   634  // Ingress, if left unspecified.
   635  // +optional
   636  // +listType=atomic
   637  repeated string hosts = 1;
   638
   639  // SecretName is the name of the secret used to terminate SSL traffic on 443.
   640  // Field is left optional to allow SSL routing based on SNI hostname alone.
   641  // If the SNI host in a listener conflicts with the "Host" header field used
   642  // by an IngressRule, the SNI host is used for termination and value of the
   643  // Host header is used for routing.
   644  // +optional
   645  optional string secretName = 2;
   646}
   647
   648// DEPRECATED 1.9 - This group version of NetworkPolicy is deprecated by networking/v1/NetworkPolicy.
   649// NetworkPolicy describes what network traffic is allowed for a set of Pods
   650message NetworkPolicy {
   651  // Standard object's metadata.
   652  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
   653  // +optional
   654  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
   655
   656  // Specification of the desired behavior for this NetworkPolicy.
   657  // +optional
   658  optional NetworkPolicySpec spec = 2;
   659}
   660
   661// DEPRECATED 1.9 - This group version of NetworkPolicyEgressRule is deprecated by networking/v1/NetworkPolicyEgressRule.
   662// NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods
   663// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to.
   664// This type is beta-level in 1.8
   665message NetworkPolicyEgressRule {
   666  // List of destination ports for outgoing traffic.
   667  // Each item in this list is combined using a logical OR. If this field is
   668  // empty or missing, this rule matches all ports (traffic not restricted by port).
   669  // If this field is present and contains at least one item, then this rule allows
   670  // traffic only if the traffic matches at least one port in the list.
   671  // +optional
   672  // +listType=atomic
   673  repeated NetworkPolicyPort ports = 1;
   674
   675  // List of destinations for outgoing traffic of pods selected for this rule.
   676  // Items in this list are combined using a logical OR operation. If this field is
   677  // empty or missing, this rule matches all destinations (traffic not restricted by
   678  // destination). If this field is present and contains at least one item, this rule
   679  // allows traffic only if the traffic matches at least one item in the to list.
   680  // +optional
   681  // +listType=atomic
   682  repeated NetworkPolicyPeer to = 2;
   683}
   684
   685// DEPRECATED 1.9 - This group version of NetworkPolicyIngressRule is deprecated by networking/v1/NetworkPolicyIngressRule.
   686// This NetworkPolicyIngressRule matches traffic if and only if the traffic matches both ports AND from.
   687message NetworkPolicyIngressRule {
   688  // List of ports which should be made accessible on the pods selected for this rule.
   689  // Each item in this list is combined using a logical OR.
   690  // If this field is empty or missing, this rule matches all ports (traffic not restricted by port).
   691  // If this field is present and contains at least one item, then this rule allows traffic
   692  // only if the traffic matches at least one port in the list.
   693  // +optional
   694  // +listType=atomic
   695  repeated NetworkPolicyPort ports = 1;
   696
   697  // List of sources which should be able to access the pods selected for this rule.
   698  // Items in this list are combined using a logical OR operation.
   699  // If this field is empty or missing, this rule matches all sources (traffic not restricted by source).
   700  // If this field is present and contains at least one item, this rule allows traffic only if the
   701  // traffic matches at least one item in the from list.
   702  // +optional
   703  // +listType=atomic
   704  repeated NetworkPolicyPeer from = 2;
   705}
   706
   707// DEPRECATED 1.9 - This group version of NetworkPolicyList is deprecated by networking/v1/NetworkPolicyList.
   708// Network Policy List is a list of NetworkPolicy objects.
   709message NetworkPolicyList {
   710  // Standard list metadata.
   711  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
   712  // +optional
   713  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
   714
   715  // Items is a list of schema objects.
   716  repeated NetworkPolicy items = 2;
   717}
   718
   719// DEPRECATED 1.9 - This group version of NetworkPolicyPeer is deprecated by networking/v1/NetworkPolicyPeer.
   720message NetworkPolicyPeer {
   721  // This is a label selector which selects Pods. This field follows standard label
   722  // selector semantics; if present but empty, it selects all pods.
   723  //
   724  // If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
   725  // the Pods matching PodSelector in the Namespaces selected by NamespaceSelector.
   726  // Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
   727  // +optional
   728  optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1;
   729
   730  // Selects Namespaces using cluster-scoped labels. This field follows standard label
   731  // selector semantics; if present but empty, it selects all namespaces.
   732  //
   733  // If PodSelector is also set, then the NetworkPolicyPeer as a whole selects
   734  // the Pods matching PodSelector in the Namespaces selected by NamespaceSelector.
   735  // Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
   736  // +optional
   737  optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 2;
   738
   739  // IPBlock defines policy on a particular IPBlock. If this field is set then
   740  // neither of the other fields can be.
   741  // +optional
   742  optional IPBlock ipBlock = 3;
   743}
   744
   745// DEPRECATED 1.9 - This group version of NetworkPolicyPort is deprecated by networking/v1/NetworkPolicyPort.
   746message NetworkPolicyPort {
   747  // Optional.  The protocol (TCP, UDP, or SCTP) which traffic must match.
   748  // If not specified, this field defaults to TCP.
   749  // +optional
   750  optional string protocol = 1;
   751
   752  // The port on the given protocol. This can either be a numerical or named
   753  // port on a pod. If this field is not provided, this matches all port names and
   754  // numbers.
   755  // If present, only traffic on the specified protocol AND port will be matched.
   756  // +optional
   757  optional k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 2;
   758
   759  // If set, indicates that the range of ports from port to endPort, inclusive,
   760  // should be allowed by the policy. This field cannot be defined if the port field
   761  // is not defined or if the port field is defined as a named (string) port.
   762  // The endPort must be equal or greater than port.
   763  // +optional
   764  optional int32 endPort = 3;
   765}
   766
   767// DEPRECATED 1.9 - This group version of NetworkPolicySpec is deprecated by networking/v1/NetworkPolicySpec.
   768message NetworkPolicySpec {
   769  // Selects the pods to which this NetworkPolicy object applies.  The array of ingress rules
   770  // is applied to any pods selected by this field. Multiple network policies can select the
   771  // same set of pods.  In this case, the ingress rules for each are combined additively.
   772  // This field is NOT optional and follows standard label selector semantics.
   773  // An empty podSelector matches all pods in this namespace.
   774  optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1;
   775
   776  // List of ingress rules to be applied to the selected pods.
   777  // Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod
   778  // OR if the traffic source is the pod's local node,
   779  // OR if the traffic matches at least one ingress rule across all of the NetworkPolicy
   780  // objects whose podSelector matches the pod.
   781  // If this field is empty then this NetworkPolicy does not allow any traffic
   782  // (and serves solely to ensure that the pods it selects are isolated by default).
   783  // +optional
   784  // +listType=atomic
   785  repeated NetworkPolicyIngressRule ingress = 2;
   786
   787  // List of egress rules to be applied to the selected pods. Outgoing traffic is
   788  // allowed if there are no NetworkPolicies selecting the pod (and cluster policy
   789  // otherwise allows the traffic), OR if the traffic matches at least one egress rule
   790  // across all of the NetworkPolicy objects whose podSelector matches the pod. If
   791  // this field is empty then this NetworkPolicy limits all outgoing traffic (and serves
   792  // solely to ensure that the pods it selects are isolated by default).
   793  // This field is beta-level in 1.8
   794  // +optional
   795  // +listType=atomic
   796  repeated NetworkPolicyEgressRule egress = 3;
   797
   798  // List of rule types that the NetworkPolicy relates to.
   799  // Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"].
   800  // If this field is not specified, it will default based on the existence of Ingress or Egress rules;
   801  // policies that contain an Egress section are assumed to affect Egress, and all policies
   802  // (whether or not they contain an Ingress section) are assumed to affect Ingress.
   803  // If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
   804  // Likewise, if you want to write a policy that specifies that no egress is allowed,
   805  // you must specify a policyTypes value that include "Egress" (since such a policy would not include
   806  // an Egress section and would otherwise default to just [ "Ingress" ]).
   807  // This field is beta-level in 1.8
   808  // +optional
   809  // +listType=atomic
   810  repeated string policyTypes = 4;
   811}
   812
   813// DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for
   814// more information.
   815// ReplicaSet ensures that a specified number of pod replicas are running at any given time.
   816message ReplicaSet {
   817  // If the Labels of a ReplicaSet are empty, they are defaulted to
   818  // be the same as the Pod(s) that the ReplicaSet manages.
   819  // Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
   820  // +optional
   821  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
   822
   823  // Spec defines the specification of the desired behavior of the ReplicaSet.
   824  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
   825  // +optional
   826  optional ReplicaSetSpec spec = 2;
   827
   828  // Status is the most recently observed status of the ReplicaSet.
   829  // This data may be out of date by some window of time.
   830  // Populated by the system.
   831  // Read-only.
   832  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
   833  // +optional
   834  optional ReplicaSetStatus status = 3;
   835}
   836
   837// ReplicaSetCondition describes the state of a replica set at a certain point.
   838message ReplicaSetCondition {
   839  // Type of replica set condition.
   840  optional string type = 1;
   841
   842  // Status of the condition, one of True, False, Unknown.
   843  optional string status = 2;
   844
   845  // The last time the condition transitioned from one status to another.
   846  // +optional
   847  optional k8s.io.apimachinery.pkg.apis.meta.v1.Time lastTransitionTime = 3;
   848
   849  // The reason for the condition's last transition.
   850  // +optional
   851  optional string reason = 4;
   852
   853  // A human readable message indicating details about the transition.
   854  // +optional
   855  optional string message = 5;
   856}
   857
   858// ReplicaSetList is a collection of ReplicaSets.
   859message ReplicaSetList {
   860  // Standard list metadata.
   861  // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
   862  // +optional
   863  optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
   864
   865  // List of ReplicaSets.
   866  // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
   867  repeated ReplicaSet items = 2;
   868}
   869
   870// ReplicaSetSpec is the specification of a ReplicaSet.
   871message ReplicaSetSpec {
   872  // Replicas is the number of desired replicas.
   873  // This is a pointer to distinguish between explicit zero and unspecified.
   874  // Defaults to 1.
   875  // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
   876  // +optional
   877  optional int32 replicas = 1;
   878
   879  // Minimum number of seconds for which a newly created pod should be ready
   880  // without any of its container crashing, for it to be considered available.
   881  // Defaults to 0 (pod will be considered available as soon as it is ready)
   882  // +optional
   883  optional int32 minReadySeconds = 4;
   884
   885  // Selector is a label query over pods that should match the replica count.
   886  // If the selector is empty, it is defaulted to the labels present on the pod template.
   887  // Label keys and values that must match in order to be controlled by this replica set.
   888  // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
   889  // +optional
   890  optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector selector = 2;
   891
   892  // Template is the object that describes the pod that will be created if
   893  // insufficient replicas are detected.
   894  // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template
   895  // +optional
   896  optional k8s.io.api.core.v1.PodTemplateSpec template = 3;
   897}
   898
   899// ReplicaSetStatus represents the current status of a ReplicaSet.
   900message ReplicaSetStatus {
   901  // Replicas is the most recently observed number of replicas.
   902  // More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
   903  optional int32 replicas = 1;
   904
   905  // The number of pods that have labels matching the labels of the pod template of the replicaset.
   906  // +optional
   907  optional int32 fullyLabeledReplicas = 2;
   908
   909  // The number of ready replicas for this replica set.
   910  // +optional
   911  optional int32 readyReplicas = 4;
   912
   913  // The number of available replicas (ready for at least minReadySeconds) for this replica set.
   914  // +optional
   915  optional int32 availableReplicas = 5;
   916
   917  // ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
   918  // +optional
   919  optional int64 observedGeneration = 3;
   920
   921  // Represents the latest available observations of a replica set's current state.
   922  // +optional
   923  // +patchMergeKey=type
   924  // +patchStrategy=merge
   925  // +listType=map
   926  // +listMapKey=type
   927  repeated ReplicaSetCondition conditions = 6;
   928}
   929
   930// DEPRECATED.
   931message RollbackConfig {
   932  // The revision to rollback to. If set to 0, rollback to the last revision.
   933  // +optional
   934  optional int64 revision = 1;
   935}
   936
   937// Spec to control the desired behavior of daemon set rolling update.
   938message RollingUpdateDaemonSet {
   939  // The maximum number of DaemonSet pods that can be unavailable during the
   940  // update. Value can be an absolute number (ex: 5) or a percentage of total
   941  // number of DaemonSet pods at the start of the update (ex: 10%). Absolute
   942  // number is calculated from percentage by rounding up.
   943  // This cannot be 0 if MaxSurge is 0
   944  // Default value is 1.
   945  // Example: when this is set to 30%, at most 30% of the total number of nodes
   946  // that should be running the daemon pod (i.e. status.desiredNumberScheduled)
   947  // can have their pods stopped for an update at any given time. The update
   948  // starts by stopping at most 30% of those DaemonSet pods and then brings
   949  // up new DaemonSet pods in their place. Once the new pods are available,
   950  // it then proceeds onto other DaemonSet pods, thus ensuring that at least
   951  // 70% of original number of DaemonSet pods are available at all times during
   952  // the update.
   953  // +optional
   954  optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1;
   955
   956  // The maximum number of nodes with an existing available DaemonSet pod that
   957  // can have an updated DaemonSet pod during during an update.
   958  // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
   959  // This can not be 0 if MaxUnavailable is 0.
   960  // Absolute number is calculated from percentage by rounding up to a minimum of 1.
   961  // Default value is 0.
   962  // Example: when this is set to 30%, at most 30% of the total number of nodes
   963  // that should be running the daemon pod (i.e. status.desiredNumberScheduled)
   964  // can have their a new pod created before the old pod is marked as deleted.
   965  // The update starts by launching new pods on 30% of nodes. Once an updated
   966  // pod is available (Ready for at least minReadySeconds) the old DaemonSet pod
   967  // on that node is marked deleted. If the old pod becomes unavailable for any
   968  // reason (Ready transitions to false, is evicted, or is drained) an updated
   969  // pod is immediatedly created on that node without considering surge limits.
   970  // Allowing surge implies the possibility that the resources consumed by the
   971  // daemonset on any given node can double if the readiness check fails, and
   972  // so resource intensive daemonsets should take into account that they may
   973  // cause evictions during disruption.
   974  // This is an alpha field and requires enabling DaemonSetUpdateSurge feature gate.
   975  // +optional
   976  optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
   977}
   978
   979// Spec to control the desired behavior of rolling update.
   980message RollingUpdateDeployment {
   981  // The maximum number of pods that can be unavailable during the update.
   982  // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
   983  // Absolute number is calculated from percentage by rounding down.
   984  // This can not be 0 if MaxSurge is 0.
   985  // By default, a fixed value of 1 is used.
   986  // Example: when this is set to 30%, the old RC can be scaled down to 70% of desired pods
   987  // immediately when the rolling update starts. Once new pods are ready, old RC
   988  // can be scaled down further, followed by scaling up the new RC, ensuring
   989  // that the total number of pods available at all times during the update is at
   990  // least 70% of desired pods.
   991  // +optional
   992  optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxUnavailable = 1;
   993
   994  // The maximum number of pods that can be scheduled above the desired number of
   995  // pods.
   996  // Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
   997  // This can not be 0 if MaxUnavailable is 0.
   998  // Absolute number is calculated from percentage by rounding up.
   999  // By default, a value of 1 is used.
  1000  // Example: when this is set to 30%, the new RC can be scaled up immediately when
  1001  // the rolling update starts, such that the total number of old and new pods do not exceed
  1002  // 130% of desired pods. Once old pods have been killed,
  1003  // new RC can be scaled up further, ensuring that total number of pods running
  1004  // at any time during the update is at most 130% of desired pods.
  1005  // +optional
  1006  optional k8s.io.apimachinery.pkg.util.intstr.IntOrString maxSurge = 2;
  1007}
  1008
  1009// represents a scaling request for a resource.
  1010message Scale {
  1011  // Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata.
  1012  // +optional
  1013  optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
  1014
  1015  // defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status.
  1016  // +optional
  1017  optional ScaleSpec spec = 2;
  1018
  1019  // current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only.
  1020  // +optional
  1021  optional ScaleStatus status = 3;
  1022}
  1023
  1024// describes the attributes of a scale subresource
  1025message ScaleSpec {
  1026  // desired number of instances for the scaled object.
  1027  // +optional
  1028  optional int32 replicas = 1;
  1029}
  1030
  1031// represents the current status of a scale subresource.
  1032message ScaleStatus {
  1033  // actual number of observed instances of the scaled object.
  1034  optional int32 replicas = 1;
  1035
  1036  // selector is a label query over pods that should match the replicas count. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
  1037  // +optional
  1038  // +mapType=atomic
  1039  map<string, string> selector = 2;
  1040
  1041  // label selector for pods that should match the replicas count. This is a serializated
  1042  // version of both map-based and more expressive set-based selectors. This is done to
  1043  // avoid introspection in the clients. The string will be in the same format as the
  1044  // query-param syntax. If the target type only supports map-based selectors, both this
  1045  // field and map-based selector field are populated.
  1046  // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
  1047  // +optional
  1048  optional string targetSelector = 3;
  1049}
  1050

View as plain text