Skip to content

networking.v1beta1.ingressSpec

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

Index

Fields

fn withIngressClassName

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

fn withRules

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

fn withRulesMixin

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

Note: This function appends passed data to existing values

fn withTls

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

fn withTlsMixin

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

Note: This function appends passed data to existing values

obj backend

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

fn backend.withServiceName

withServiceName(serviceName)

"Specifies the name of the referenced service."

fn backend.withServicePort

withServicePort(servicePort)

"IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number."

obj backend.resource

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

fn backend.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 backend.resource.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn backend.resource.withName

withName(name)

"Name is the name of resource being referenced"