package k8s.io.api.networking.v1

Get desktop application:
View/edit binary Protocol Buffers messages

HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.

Used in: HTTPIngressRuleValue

• optional string path = 1

  Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value "Exact" or "Prefix". +optional

• optional string pathType = 3

  PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types.

• optional IngressBackend backend = 2

  Backend defines the referenced service endpoint to which the traffic will be forwarded to.

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.

Used in: IngressRuleValue

• repeated HTTPIngressPath paths = 1

  A collection of paths that map requests to backends. +listType=atomic

IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.

Used in: NetworkPolicyPeer

• optional string cidr = 1

  CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64"

• repeated string except = 2

  Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" or "2001:db9::/64" Except values will be rejected if they are outside the CIDR range +optional

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

Used in: IngressList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional IngressSpec spec = 2

  Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

• optional IngressStatus status = 3

  Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

IngressBackend describes all endpoints for a given service and port.

Used in: HTTPIngressPath, IngressSpec

• optional IngressServiceBackend service = 4

  Service references a Service as a Backend. This is a mutually exclusive setting with "Resource". +optional

• optional core.v1.TypedLocalObjectReference resource = 3

  Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service". +optional

IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.

Used in: IngressClassList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional IngressClassSpec spec = 2

  Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status +optional

IngressClassList is a collection of IngressClasses.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. +optional

• repeated IngressClass items = 2

  Items is the list of IngressClasses.

IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.

Used in: IngressClassSpec

• optional string aPIGroup = 1

  APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. +optional

• optional string kind = 2

  Kind is the type of resource being referenced.

• optional string name = 3

  Name is the name of resource being referenced.

• optional string scope = 4

  Scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". +optional

• optional string namespace = 5

  Namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster". +optional

IngressClassSpec provides information about the class of an Ingress.

Used in: IngressClass

• optional string controller = 1

  Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable.

• optional IngressClassParametersReference parameters = 2

  Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. +optional

IngressList is a collection of Ingress.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated Ingress items = 2

  Items is the list of Ingress.

IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue.

Used in: IngressSpec

• optional string host = 1

  Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The `:` delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. +optional

• optional IngressRuleValue ingressRuleValue = 2

  IngressRuleValue represents a rule to route requests for this IngressRule. If unspecified, the rule defaults to a http catch-all. Whether that sends just traffic matching the host to the default backend or all traffic to the default backend, is left to the controller fulfilling the Ingress. Http is currently the only supported IngressRuleValue. +optional

IngressRuleValue represents a rule to apply against incoming requests. If the rule is satisfied, the request is routed to the specified backend. Currently mixing different types of rules in a single Ingress is disallowed, so exactly one of the following must be set.

Used in: IngressRule

• optional HTTPIngressRuleValue http = 1

  +optional

IngressServiceBackend references a Kubernetes Service as a Backend.

Used in: IngressBackend

• optional string name = 1

  Name is the referenced service. The service must exist in the same namespace as the Ingress object.

• optional ServiceBackendPort port = 2

  Port of the referenced service. A port name or port number is required for a IngressServiceBackend.

IngressSpec describes the Ingress the user wishes to exist.

Used in: Ingress

• optional string ingressClassName = 4

  IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. +optional

• optional IngressBackend defaultBackend = 1

  DefaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller. +optional

• repeated IngressTLS tls = 2

  TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. +listType=atomic +optional

• repeated IngressRule rules = 3

  A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. +listType=atomic +optional

IngressStatus describe the current state of the Ingress.

Used in: Ingress

• optional core.v1.LoadBalancerStatus loadBalancer = 1

  LoadBalancer contains the current status of the load-balancer. +optional

IngressTLS describes the transport layer security associated with an Ingress.

Used in: IngressSpec

• repeated string hosts = 1

  Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. +listType=atomic +optional

• optional string secretName = 2

  SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. +optional

NetworkPolicy describes what network traffic is allowed for a set of Pods

Used in: NetworkPolicyList

• optional apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• optional NetworkPolicySpec spec = 2

  Specification of the desired behavior for this NetworkPolicy. +optional

NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8

Used in: NetworkPolicySpec

• repeated NetworkPolicyPort ports = 1

  List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. +optional

• repeated NetworkPolicyPeer to = 2

  List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. +optional

NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.

Used in: NetworkPolicySpec

• repeated NetworkPolicyPort ports = 1

  List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. +optional

• repeated NetworkPolicyPeer from = 2

  List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list. +optional

NetworkPolicyList is a list of NetworkPolicy objects.

• optional apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional

• repeated NetworkPolicy items = 2

  Items is a list of schema objects.

NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed

Used in: NetworkPolicyEgressRule, NetworkPolicyIngressRule

• optional apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1

  This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods. If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. +optional

• optional apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 2

  Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. +optional

• optional IPBlock ipBlock = 3

  IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. +optional

NetworkPolicyPort describes a port to allow traffic on

Used in: NetworkPolicyEgressRule, NetworkPolicyIngressRule

• optional string protocol = 1

  The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. +optional

• optional apimachinery.pkg.util.intstr.IntOrString port = 2

  The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. +optional

• optional int32 endPort = 3

  If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. This feature is in Beta state and is enabled by default. It can be disabled using the Feature Gate "NetworkPolicyEndPort". +optional

NetworkPolicySpec provides the specification of a NetworkPolicy

Used in: NetworkPolicy

• optional apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1

  Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.

• repeated NetworkPolicyIngressRule ingress = 2

  List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) +optional

• repeated NetworkPolicyEgressRule egress = 3

  List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 +optional

• repeated string policyTypes = 4

  List of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 +optional

ServiceBackendPort is the service port being referenced.

Used in: IngressServiceBackend

• optional string name = 1

  Name is the name of the port on the Service. This is a mutually exclusive setting with "Number". +optional

• optional int32 number = 2

  Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". +optional