zio-k8s-client
API
Generated with
zio-k8s-client/com.coralogix.zio.k8s/com.coralogix.zio.k8s.model/com.coralogix.zio.k8s.model.networking.v1

com.coralogix.zio.k8s.model.networking.v1

package com.coralogix.zio.k8s.model.networking.v1

Members list

Type members

Classlikes

case class HTTPIngressPath(backend: IngressBackend, path: Optional[String], pathType: String)

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

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

Value parameters

path

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".

pathType

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HTTPIngressPath extends HTTPIngressPathFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class HTTPIngressPathFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object HTTPIngressPath.type
case class HTTPIngressRuleValue(paths: Vector[HTTPIngressPath])

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:// / ? -> 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 '#'.

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:// / ? -> 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 '#'.

Value parameters

paths

A collection of paths that map requests to backends.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HTTPIngressRuleValue extends HTTPIngressRuleValueFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class HTTPIngressRuleValueFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object HTTPIngressRuleValue.type
case class IPBlock(cidr: String, except: Optional[Vector[String]])

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.

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.

Value parameters

cidr

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

except

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IPBlock extends IPBlockFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
IPBlock.type
class IPBlockFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IPBlock.type
case class Ingress(metadata: Optional[ObjectMeta], spec: Optional[IngressSpec], status: Optional[IngressStatus])

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.

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Ingress extends IngressFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
Ingress.type
case class IngressBackend(resource: Optional[TypedLocalObjectReference], service: Optional[IngressServiceBackend])

IngressBackend describes all endpoints for a given service and port.

IngressBackend describes all endpoints for a given service and port.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressBackend extends IngressBackendFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class IngressBackendFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IngressBackend.type
case class IngressClass(metadata: Optional[ObjectMeta], spec: Optional[IngressClassSpec])

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.

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressClass extends IngressClassFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class IngressClassFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IngressClass.type
case class IngressClassParametersReference(apiGroup: Optional[String], kind: String, name: String, namespace: Optional[String], scope: Optional[String])

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

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

Value parameters

apiGroup

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.

kind

Kind is the type of resource being referenced.

name

Name is the name of resource being referenced.

namespace

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".

scope

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressClassParametersReference extends IngressClassParametersReferenceFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class IngressClassParametersReferenceFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class IngressClassSpec(controller: Optional[String], parameters: Optional[IngressClassParametersReference])

IngressClassSpec provides information about the class of an Ingress.

IngressClassSpec provides information about the class of an Ingress.

Value parameters

controller

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressClassSpec extends IngressClassSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class IngressClassSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IngressClassSpec.type
class IngressFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Ingress.type
case class IngressRule(host: Optional[String], http: Optional[HTTPIngressRuleValue])

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.

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.

Value parameters

host

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressRule extends IngressRuleFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class IngressRuleFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IngressRule.type
case class IngressServiceBackend(name: String, port: Optional[ServiceBackendPort])

IngressServiceBackend references a Kubernetes Service as a Backend.

IngressServiceBackend references a Kubernetes Service as a Backend.

Value parameters

name

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressServiceBackend extends IngressServiceBackendFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class IngressServiceBackendFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IngressServiceBackend.type
case class IngressSpec(defaultBackend: Optional[IngressBackend], ingressClassName: Optional[String], rules: Optional[Vector[IngressRule]], tls: Optional[Vector[IngressTLS]])

IngressSpec describes the Ingress the user wishes to exist.

IngressSpec describes the Ingress the user wishes to exist.

Value parameters

ingressClassName

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.

rules

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

tls

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressSpec extends IngressSpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class IngressSpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IngressSpec.type
case class IngressStatus(loadBalancer: Optional[LoadBalancerStatus])

IngressStatus describe the current state of the Ingress.

IngressStatus describe the current state of the Ingress.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressStatus extends IngressStatusFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class IngressStatusFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IngressStatus.type
case class IngressTLS(hosts: Optional[Vector[String]], secretName: Optional[String])

IngressTLS describes the transport layer security associated with an Ingress.

IngressTLS describes the transport layer security associated with an Ingress.

Value parameters

hosts

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.

secretName

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IngressTLS extends IngressTLSFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
IngressTLS.type
class IngressTLSFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object IngressTLS.type
case class NetworkPolicy(metadata: Optional[ObjectMeta], spec: Optional[NetworkPolicySpec])

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

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NetworkPolicy extends NetworkPolicyFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
case class NetworkPolicyEgressRule(ports: Optional[Vector[NetworkPolicyPort]], to: Optional[Vector[NetworkPolicyPeer]])

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

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

Value parameters

ports

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.

to

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NetworkPolicyEgressRule extends NetworkPolicyEgressRuleFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class NetworkPolicyEgressRuleFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class NetworkPolicyFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NetworkPolicy.type
case class NetworkPolicyIngressRule(from: Optional[Vector[NetworkPolicyPeer]], ports: Optional[Vector[NetworkPolicyPort]])

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.

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.

Value parameters

from

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.

ports

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NetworkPolicyIngressRule extends NetworkPolicyIngressRuleFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class NetworkPolicyIngressRuleFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class NetworkPolicyPeer(ipBlock: Optional[IPBlock], namespaceSelector: Optional[LabelSelector], podSelector: Optional[LabelSelector])

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

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NetworkPolicyPeer extends NetworkPolicyPeerFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class NetworkPolicyPeerFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NetworkPolicyPeer.type
case class NetworkPolicyPort(endPort: Optional[Int], port: Optional[IntOrString], protocol: Optional[String])

NetworkPolicyPort describes a port to allow traffic on

NetworkPolicyPort describes a port to allow traffic on

Value parameters

endPort

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".

protocol

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NetworkPolicyPort extends NetworkPolicyPortFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class NetworkPolicyPortFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NetworkPolicyPort.type
case class NetworkPolicySpec(egress: Optional[Vector[NetworkPolicyEgressRule]], ingress: Optional[Vector[NetworkPolicyIngressRule]], podSelector: LabelSelector, policyTypes: Optional[Vector[String]])

NetworkPolicySpec provides the specification of a NetworkPolicy

NetworkPolicySpec provides the specification of a NetworkPolicy

Value parameters

egress

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

ingress

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)

policyTypes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NetworkPolicySpec extends NetworkPolicySpecFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class NetworkPolicySpecFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NetworkPolicySpec.type
case class ServiceBackendPort(name: Optional[String], number: Optional[Int])

ServiceBackendPort is the service port being referenced.

ServiceBackendPort is the service port being referenced.

Value parameters

name

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

number

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ServiceBackendPort extends ServiceBackendPortFields

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
class ServiceBackendPortFields(_prefix: Chunk[String])

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ServiceBackendPort.type
Generated with