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.networking.v1;
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/networking/v1";
32
33// HTTPIngressPath associates a path with a backend. Incoming urls matching the
34// path are forwarded to the backend.
35message HTTPIngressPath {
36 // path is matched against the path of an incoming request. Currently it can
37 // contain characters disallowed from the conventional "path" part of a URL
38 // as defined by RFC 3986. Paths must begin with a '/' and must be present
39 // when using PathType with value "Exact" or "Prefix".
40 // +optional
41 optional string path = 1;
42
43 // pathType determines the interpretation of the path matching. PathType can
44 // be one of the following values:
45 // * Exact: Matches the URL path exactly.
46 // * Prefix: Matches based on a URL path prefix split by '/'. Matching is
47 // done on a path element by element basis. A path element refers is the
48 // list of labels in the path split by the '/' separator. A request is a
49 // match for path p if every p is an element-wise prefix of p of the
50 // request path. Note that if the last element of the path is a substring
51 // of the last element in request path, it is not a match (e.g. /foo/bar
52 // matches /foo/bar/baz, but does not match /foo/barbaz).
53 // * ImplementationSpecific: Interpretation of the Path matching is up to
54 // the IngressClass. Implementations can treat this as a separate PathType
55 // or treat it identically to Prefix or Exact path types.
56 // Implementations are required to support all path types.
57 optional string pathType = 3;
58
59 // backend defines the referenced service endpoint to which the traffic
60 // will be forwarded to.
61 optional IngressBackend backend = 2;
62}
63
64// HTTPIngressRuleValue is a list of http selectors pointing to backends.
65// In the example: http://<host>/<path>?<searchpart> -> backend where
66// where parts of the url correspond to RFC 3986, this resource will be used
67// to match against everything after the last '/' and before the first '?'
68// or '#'.
69message HTTPIngressRuleValue {
70 // paths is a collection of paths that map requests to backends.
71 // +listType=atomic
72 repeated HTTPIngressPath paths = 1;
73}
74
75// IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") that is allowed
76// to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs
77// that should not be included within this rule.
78message IPBlock {
79 // cidr is a string representing the IPBlock
80 // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
81 optional string cidr = 1;
82
83 // except is a slice of CIDRs that should not be included within an IPBlock
84 // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
85 // Except values will be rejected if they are outside the cidr range
86 // +optional
87 // +listType=atomic
88 repeated string except = 2;
89}
90
91// Ingress is a collection of rules that allow inbound connections to reach the
92// endpoints defined by a backend. An Ingress can be configured to give services
93// externally-reachable urls, load balance traffic, terminate SSL, offer name
94// based virtual hosting etc.
95message Ingress {
96 // Standard object's metadata.
97 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
98 // +optional
99 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
100
101 // spec is the desired state of the Ingress.
102 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
103 // +optional
104 optional IngressSpec spec = 2;
105
106 // status is the current state of the Ingress.
107 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
108 // +optional
109 optional IngressStatus status = 3;
110}
111
112// IngressBackend describes all endpoints for a given service and port.
113message IngressBackend {
114 // service references a service as a backend.
115 // This is a mutually exclusive setting with "Resource".
116 // +optional
117 optional IngressServiceBackend service = 4;
118
119 // resource is an ObjectRef to another Kubernetes resource in the namespace
120 // of the Ingress object. If resource is specified, a service.Name and
121 // service.Port must not be specified.
122 // This is a mutually exclusive setting with "Service".
123 // +optional
124 optional k8s.io.api.core.v1.TypedLocalObjectReference resource = 3;
125}
126
127// IngressClass represents the class of the Ingress, referenced by the Ingress
128// Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be
129// used to indicate that an IngressClass should be considered default. When a
130// single IngressClass resource has this annotation set to true, new Ingress
131// resources without a class specified will be assigned this default class.
132message IngressClass {
133 // Standard object's metadata.
134 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
135 // +optional
136 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
137
138 // spec is the desired state of the IngressClass.
139 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
140 // +optional
141 optional IngressClassSpec spec = 2;
142}
143
144// IngressClassList is a collection of IngressClasses.
145message IngressClassList {
146 // Standard list metadata.
147 // +optional
148 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
149
150 // items is the list of IngressClasses.
151 repeated IngressClass items = 2;
152}
153
154// IngressClassParametersReference identifies an API object. This can be used
155// to specify a cluster or namespace-scoped resource.
156message IngressClassParametersReference {
157 // apiGroup is the group for the resource being referenced. If APIGroup is
158 // not specified, the specified Kind must be in the core API group. For any
159 // other third-party types, APIGroup is required.
160 // +optional
161 optional string aPIGroup = 1;
162
163 // kind is the type of resource being referenced.
164 optional string kind = 2;
165
166 // name is the name of resource being referenced.
167 optional string name = 3;
168
169 // scope represents if this refers to a cluster or namespace scoped resource.
170 // This may be set to "Cluster" (default) or "Namespace".
171 // +optional
172 optional string scope = 4;
173
174 // namespace is the namespace of the resource being referenced. This field is
175 // required when scope is set to "Namespace" and must be unset when scope is set to
176 // "Cluster".
177 // +optional
178 optional string namespace = 5;
179}
180
181// IngressClassSpec provides information about the class of an Ingress.
182message IngressClassSpec {
183 // controller refers to the name of the controller that should handle this
184 // class. This allows for different "flavors" that are controlled by the
185 // same controller. For example, you may have different parameters for the
186 // same implementing controller. This should be specified as a
187 // domain-prefixed path no more than 250 characters in length, e.g.
188 // "acme.io/ingress-controller". This field is immutable.
189 optional string controller = 1;
190
191 // parameters is a link to a custom resource containing additional
192 // configuration for the controller. This is optional if the controller does
193 // not require extra parameters.
194 // +optional
195 optional IngressClassParametersReference parameters = 2;
196}
197
198// IngressList is a collection of Ingress.
199message IngressList {
200 // Standard object's metadata.
201 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
202 // +optional
203 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
204
205 // items is the list of Ingress.
206 repeated Ingress items = 2;
207}
208
209// IngressLoadBalancerIngress represents the status of a load-balancer ingress point.
210message IngressLoadBalancerIngress {
211 // ip is set for load-balancer ingress points that are IP based.
212 // +optional
213 optional string ip = 1;
214
215 // hostname is set for load-balancer ingress points that are DNS based.
216 // +optional
217 optional string hostname = 2;
218
219 // ports provides information about the ports exposed by this LoadBalancer.
220 // +listType=atomic
221 // +optional
222 repeated IngressPortStatus ports = 4;
223}
224
225// IngressLoadBalancerStatus represents the status of a load-balancer.
226message IngressLoadBalancerStatus {
227 // ingress is a list containing ingress points for the load-balancer.
228 // +optional
229 // +listType=atomic
230 repeated IngressLoadBalancerIngress ingress = 1;
231}
232
233// IngressPortStatus represents the error condition of a service port
234message IngressPortStatus {
235 // port is the port number of the ingress port.
236 optional int32 port = 1;
237
238 // protocol is the protocol of the ingress port.
239 // The supported values are: "TCP", "UDP", "SCTP"
240 optional string protocol = 2;
241
242 // error is to record the problem with the service port
243 // The format of the error shall comply with the following rules:
244 // - built-in error values shall be specified in this file and those shall use
245 // CamelCase names
246 // - cloud provider specific error values must have names that comply with the
247 // format foo.example.com/CamelCase.
248 // ---
249 // The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
250 // +optional
251 // +kubebuilder:validation:Required
252 // +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])$`
253 // +kubebuilder:validation:MaxLength=316
254 optional string error = 3;
255}
256
257// IngressRule represents the rules mapping the paths under a specified host to
258// the related backend services. Incoming requests are first evaluated for a host
259// match, then routed to the backend associated with the matching IngressRuleValue.
260message IngressRule {
261 // host is the fully qualified domain name of a network host, as defined by RFC 3986.
262 // Note the following deviations from the "host" part of the
263 // URI as defined in RFC 3986:
264 // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
265 // the IP in the Spec of the parent Ingress.
266 // 2. The `:` delimiter is not respected because ports are not allowed.
267 // Currently the port of an Ingress is implicitly :80 for http and
268 // :443 for https.
269 // Both these may change in the future.
270 // Incoming requests are matched against the host before the
271 // IngressRuleValue. If the host is unspecified, the Ingress routes all
272 // traffic based on the specified IngressRuleValue.
273 //
274 // host can be "precise" which is a domain name without the terminating dot of
275 // a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name
276 // prefixed with a single wildcard label (e.g. "*.foo.com").
277 // The wildcard character '*' must appear by itself as the first DNS label and
278 // matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*").
279 // Requests will be matched against the Host field in the following way:
280 // 1. If host is precise, the request matches this rule if the http host header is equal to Host.
281 // 2. If host is a wildcard, then the request matches this rule if the http host header
282 // is to equal to the suffix (removing the first label) of the wildcard rule.
283 // +optional
284 optional string host = 1;
285
286 // IngressRuleValue represents a rule to route requests for this IngressRule.
287 // If unspecified, the rule defaults to a http catch-all. Whether that sends
288 // just traffic matching the host to the default backend or all traffic to the
289 // default backend, is left to the controller fulfilling the Ingress. Http is
290 // currently the only supported IngressRuleValue.
291 // +optional
292 optional IngressRuleValue ingressRuleValue = 2;
293}
294
295// IngressRuleValue represents a rule to apply against incoming requests. If the
296// rule is satisfied, the request is routed to the specified backend. Currently
297// mixing different types of rules in a single Ingress is disallowed, so exactly
298// one of the following must be set.
299message IngressRuleValue {
300 // +optional
301 optional HTTPIngressRuleValue http = 1;
302}
303
304// IngressServiceBackend references a Kubernetes Service as a Backend.
305message IngressServiceBackend {
306 // name is the referenced service. The service must exist in
307 // the same namespace as the Ingress object.
308 optional string name = 1;
309
310 // port of the referenced service. A port name or port number
311 // is required for a IngressServiceBackend.
312 optional ServiceBackendPort port = 2;
313}
314
315// IngressSpec describes the Ingress the user wishes to exist.
316message IngressSpec {
317 // ingressClassName is the name of an IngressClass cluster resource. Ingress
318 // controller implementations use this field to know whether they should be
319 // serving this Ingress resource, by a transitive connection
320 // (controller -> IngressClass -> Ingress resource). Although the
321 // `kubernetes.io/ingress.class` annotation (simple constant name) was never
322 // formally defined, it was widely supported by Ingress controllers to create
323 // a direct binding between Ingress controller and Ingress resources. Newly
324 // created Ingress resources should prefer using the field. However, even
325 // though the annotation is officially deprecated, for backwards compatibility
326 // reasons, ingress controllers should still honor that annotation if present.
327 // +optional
328 optional string ingressClassName = 4;
329
330 // defaultBackend is the backend that should handle requests that don't
331 // match any rule. If Rules are not specified, DefaultBackend must be specified.
332 // If DefaultBackend is not set, the handling of requests that do not match any
333 // of the rules will be up to the Ingress controller.
334 // +optional
335 optional IngressBackend defaultBackend = 1;
336
337 // tls represents the TLS configuration. Currently the Ingress only supports a
338 // single TLS port, 443. If multiple members of this list specify different hosts,
339 // they will be multiplexed on the same port according to the hostname specified
340 // through the SNI TLS extension, if the ingress controller fulfilling the
341 // ingress supports SNI.
342 // +listType=atomic
343 // +optional
344 repeated IngressTLS tls = 2;
345
346 // rules is a list of host rules used to configure the Ingress. If unspecified,
347 // or no rule matches, all traffic is sent to the default backend.
348 // +listType=atomic
349 // +optional
350 repeated IngressRule rules = 3;
351}
352
353// IngressStatus describe the current state of the Ingress.
354message IngressStatus {
355 // loadBalancer contains the current status of the load-balancer.
356 // +optional
357 optional IngressLoadBalancerStatus loadBalancer = 1;
358}
359
360// IngressTLS describes the transport layer security associated with an ingress.
361message IngressTLS {
362 // hosts is a list of hosts included in the TLS certificate. The values in
363 // this list must match the name/s used in the tlsSecret. Defaults to the
364 // wildcard host setting for the loadbalancer controller fulfilling this
365 // Ingress, if left unspecified.
366 // +listType=atomic
367 // +optional
368 repeated string hosts = 1;
369
370 // secretName is the name of the secret used to terminate TLS traffic on
371 // port 443. Field is left optional to allow TLS routing based on SNI
372 // hostname alone. If the SNI host in a listener conflicts with the "Host"
373 // header field used by an IngressRule, the SNI host is used for termination
374 // and value of the "Host" header is used for routing.
375 // +optional
376 optional string secretName = 2;
377}
378
379// NetworkPolicy describes what network traffic is allowed for a set of Pods
380message NetworkPolicy {
381 // Standard object's metadata.
382 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
383 // +optional
384 optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
385
386 // spec represents the specification of the desired behavior for this NetworkPolicy.
387 // +optional
388 optional NetworkPolicySpec spec = 2;
389}
390
391// NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods
392// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to.
393// This type is beta-level in 1.8
394message NetworkPolicyEgressRule {
395 // ports is a list of destination ports for outgoing traffic.
396 // Each item in this list is combined using a logical OR. If this field is
397 // empty or missing, this rule matches all ports (traffic not restricted by port).
398 // If this field is present and contains at least one item, then this rule allows
399 // traffic only if the traffic matches at least one port in the list.
400 // +optional
401 // +listType=atomic
402 repeated NetworkPolicyPort ports = 1;
403
404 // to is a list of destinations for outgoing traffic of pods selected for this rule.
405 // Items in this list are combined using a logical OR operation. If this field is
406 // empty or missing, this rule matches all destinations (traffic not restricted by
407 // destination). If this field is present and contains at least one item, this rule
408 // allows traffic only if the traffic matches at least one item in the to list.
409 // +optional
410 // +listType=atomic
411 repeated NetworkPolicyPeer to = 2;
412}
413
414// NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods
415// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.
416message NetworkPolicyIngressRule {
417 // ports is a list of ports which should be made accessible on the pods selected for
418 // this rule. Each item in this list is combined using a logical OR. If this field is
419 // empty or missing, this rule matches all ports (traffic not restricted by port).
420 // If this field is present and contains at least one item, then this rule allows
421 // traffic only if the traffic matches at least one port in the list.
422 // +optional
423 // +listType=atomic
424 repeated NetworkPolicyPort ports = 1;
425
426 // from is a list of sources which should be able to access the pods selected for this rule.
427 // Items in this list are combined using a logical OR operation. If this field is
428 // empty or missing, this rule matches all sources (traffic not restricted by
429 // source). If this field is present and contains at least one item, this rule
430 // allows traffic only if the traffic matches at least one item in the from list.
431 // +optional
432 // +listType=atomic
433 repeated NetworkPolicyPeer from = 2;
434}
435
436// NetworkPolicyList is a list of NetworkPolicy objects.
437message NetworkPolicyList {
438 // Standard list metadata.
439 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
440 // +optional
441 optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
442
443 // items is a list of schema objects.
444 repeated NetworkPolicy items = 2;
445}
446
447// NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of
448// fields are allowed
449message NetworkPolicyPeer {
450 // podSelector is a label selector which selects pods. This field follows standard label
451 // selector semantics; if present but empty, it selects all pods.
452 //
453 // If namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
454 // the pods matching podSelector in the Namespaces selected by NamespaceSelector.
455 // Otherwise it selects the pods matching podSelector in the policy's own namespace.
456 // +optional
457 optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1;
458
459 // namespaceSelector selects namespaces using cluster-scoped labels. This field follows
460 // standard label selector semantics; if present but empty, it selects all namespaces.
461 //
462 // If podSelector is also set, then the NetworkPolicyPeer as a whole selects
463 // the pods matching podSelector in the namespaces selected by namespaceSelector.
464 // Otherwise it selects all pods in the namespaces selected by namespaceSelector.
465 // +optional
466 optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 2;
467
468 // ipBlock defines policy on a particular IPBlock. If this field is set then
469 // neither of the other fields can be.
470 // +optional
471 optional IPBlock ipBlock = 3;
472}
473
474// NetworkPolicyPort describes a port to allow traffic on
475message NetworkPolicyPort {
476 // protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match.
477 // If not specified, this field defaults to TCP.
478 // +optional
479 optional string protocol = 1;
480
481 // port represents the port on the given protocol. This can either be a numerical or named
482 // port on a pod. If this field is not provided, this matches all port names and
483 // numbers.
484 // If present, only traffic on the specified protocol AND port will be matched.
485 // +optional
486 optional k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 2;
487
488 // endPort indicates that the range of ports from port to endPort if set, inclusive,
489 // should be allowed by the policy. This field cannot be defined if the port field
490 // is not defined or if the port field is defined as a named (string) port.
491 // The endPort must be equal or greater than port.
492 // +optional
493 optional int32 endPort = 3;
494}
495
496// NetworkPolicySpec provides the specification of a NetworkPolicy
497message NetworkPolicySpec {
498 // podSelector selects the pods to which this NetworkPolicy object applies.
499 // The array of ingress rules is applied to any pods selected by this field.
500 // Multiple network policies can select the same set of pods. In this case,
501 // the ingress rules for each are combined additively.
502 // This field is NOT optional and follows standard label selector semantics.
503 // An empty podSelector matches all pods in this namespace.
504 optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1;
505
506 // ingress is a list of ingress rules to be applied to the selected pods.
507 // Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod
508 // (and cluster policy otherwise allows the traffic), OR if the traffic source is
509 // the pod's local node, OR if the traffic matches at least one ingress rule
510 // across all of the NetworkPolicy objects whose podSelector matches the pod. If
511 // this field is empty then this NetworkPolicy does not allow any traffic (and serves
512 // solely to ensure that the pods it selects are isolated by default)
513 // +optional
514 // +listType=atomic
515 repeated NetworkPolicyIngressRule ingress = 2;
516
517 // egress is a list of egress rules to be applied to the selected pods. Outgoing traffic
518 // is allowed if there are no NetworkPolicies selecting the pod (and cluster policy
519 // otherwise allows the traffic), OR if the traffic matches at least one egress rule
520 // across all of the NetworkPolicy objects whose podSelector matches the pod. If
521 // this field is empty then this NetworkPolicy limits all outgoing traffic (and serves
522 // solely to ensure that the pods it selects are isolated by default).
523 // This field is beta-level in 1.8
524 // +optional
525 // +listType=atomic
526 repeated NetworkPolicyEgressRule egress = 3;
527
528 // policyTypes is a list of rule types that the NetworkPolicy relates to.
529 // Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"].
530 // If this field is not specified, it will default based on the existence of ingress or egress rules;
531 // policies that contain an egress section are assumed to affect egress, and all policies
532 // (whether or not they contain an ingress section) are assumed to affect ingress.
533 // If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
534 // Likewise, if you want to write a policy that specifies that no egress is allowed,
535 // you must specify a policyTypes value that include "Egress" (since such a policy would not include
536 // an egress section and would otherwise default to just [ "Ingress" ]).
537 // This field is beta-level in 1.8
538 // +optional
539 // +listType=atomic
540 repeated string policyTypes = 4;
541}
542
543// ServiceBackendPort is the service port being referenced.
544message ServiceBackendPort {
545 // name is the name of the port on the Service.
546 // This is a mutually exclusive setting with "Number".
547 // +optional
548 optional string name = 1;
549
550 // number is the numerical port number (e.g. 80) on the Service.
551 // This is a mutually exclusive setting with "Name".
552 // +optional
553 optional int32 number = 2;
554}
555
View as plain text