Skip to content

networking.v1.ingressSpec

"IngressSpec describes the Ingress the user wishes to exist."

Index

Fields

fn withIngressClassName

withIngressClassName(ingressClassName)

"ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the kubernetes.io/ingress.class annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present."

fn withRules

withRules(rules)

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

fn withRulesMixin

withRulesMixin(rules)

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

Note: This function appends passed data to existing values

fn withTls

withTls(tls)

"tls represents the 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."

fn withTlsMixin

withTlsMixin(tls)

"tls represents the 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."

Note: This function appends passed data to existing values

obj defaultBackend

"IngressBackend describes all endpoints for a given service and port."

obj defaultBackend.resource

"TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace."

fn defaultBackend.resource.withApiGroup

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

fn defaultBackend.resource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn defaultBackend.resource.withName

withName(name)

"Name is the name of resource being referenced"

obj defaultBackend.service

"IngressServiceBackend references a Kubernetes Service as a Backend."

fn defaultBackend.service.withName

withName(name)

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

obj defaultBackend.service.port

"ServiceBackendPort is the service port being referenced."

fn defaultBackend.service.port.withName

withName(name)

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

fn defaultBackend.service.port.withNumber

withNumber(number)

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