Ingress [networking.k8s.io/v1]
Esc
Start typing to search...
On this page

Ingress [networking.k8s.io/v1]

Description

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.

Type
`object`

Specification

PropertyTypeDescription
apiVersionstringAPIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kindstringKind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadataObjectMetaStandard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specobjectIngressSpec describes the Ingress the user wishes to exist.
statusobjectIngressStatus describe the current state of the Ingress.

.spec

Description

IngressSpec describes the Ingress the user wishes to exist.

Type
`object`
PropertyTypeDescription
defaultBackendobjectIngressBackend describes all endpoints for a given service and port.
ingressClassNamestringingressClassName 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.
rulesarrayrules 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.
rules[]objectIngressRule 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.
tlsarraytls 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.
tls[]objectIngressTLS describes the transport layer security associated with an ingress.

.spec.defaultBackend

Description

IngressBackend describes all endpoints for a given service and port.

Type
`object`
PropertyTypeDescription
resourceTypedLocalObjectReferenceresource 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".
serviceobjectIngressServiceBackend references a Kubernetes Service as a Backend.

.spec.defaultBackend.service

Description

IngressServiceBackend references a Kubernetes Service as a Backend.

Type
`object`
Required
  • name
PropertyTypeDescription
namestringname is the referenced service. The service must exist in the same namespace as the Ingress object.
portobjectServiceBackendPort is the service port being referenced.

.spec.defaultBackend.service.port

Description

ServiceBackendPort is the service port being referenced.

Type
`object`
PropertyTypeDescription
namestringname is the name of the port on the Service. This is a mutually exclusive setting with "Number".
numberintegernumber is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".

.spec.rules

Description

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.

Type
`array`

.spec.rules[]

Description

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.

Type
`object`
PropertyTypeDescription
hoststringhost 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.
httpobjectHTTPIngressRuleValue 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 '#'.

.spec.rules[].http

Description

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 '#'.

Type
`object`
Required
  • paths
PropertyTypeDescription
pathsarraypaths is a collection of paths that map requests to backends.
paths[]objectHTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.

.spec.rules[].http.paths

Description

paths is a collection of paths that map requests to backends.

Type
`array`

.spec.rules[].http.paths[]

Description

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

Type
`object`
Required
  • pathType
  • backend
PropertyTypeDescription
backendobjectIngressBackend describes all endpoints for a given service and port.
pathstringpath 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".
pathTypestringpathType 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.
Possible enum values: - "Exact" matches the URL path exactly and with case sensitivity. - "ImplementationSpecific" matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. - "Prefix" matches based on a URL path prefix split by '/'. Matching is case sensitive and done on a path element by element basis. A path element refers to 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). If multiple matching paths exist in an Ingress spec, the longest matching path is given priority. Examples: - /foo/bar does not match requests to /foo/barbaz - /foo/bar matches request to /foo/bar and /foo/bar/baz - /foo and /foo/ both match requests to /foo and /foo/. If both paths are present in an Ingress spec, the longest matching path (/foo/) is given priority.

.spec.rules[].http.paths[].backend

Description

IngressBackend describes all endpoints for a given service and port.

Type
`object`
PropertyTypeDescription
resourceTypedLocalObjectReferenceresource 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".
serviceobjectIngressServiceBackend references a Kubernetes Service as a Backend.

.spec.rules[].http.paths[].backend.service

Description

IngressServiceBackend references a Kubernetes Service as a Backend.

Type
`object`
Required
  • name
PropertyTypeDescription
namestringname is the referenced service. The service must exist in the same namespace as the Ingress object.
portobjectServiceBackendPort is the service port being referenced.

.spec.rules[].http.paths[].backend.service.port

Description

ServiceBackendPort is the service port being referenced.

Type
`object`
PropertyTypeDescription
namestringname is the name of the port on the Service. This is a mutually exclusive setting with "Number".
numberintegernumber is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".

.spec.tls

Description

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.

Type
`array`

.spec.tls[]

Description

IngressTLS describes the transport layer security associated with an ingress.

Type
`object`
PropertyTypeDescription
hostsarray (string)hosts is 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.
secretNamestringsecretName 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.

.status

Description

IngressStatus describe the current state of the Ingress.

Type
`object`
PropertyTypeDescription
loadBalancerobjectIngressLoadBalancerStatus represents the status of a load-balancer.

.status.loadBalancer

Description

IngressLoadBalancerStatus represents the status of a load-balancer.

Type
`object`
PropertyTypeDescription
ingressarrayingress is a list containing ingress points for the load-balancer.
ingress[]objectIngressLoadBalancerIngress represents the status of a load-balancer ingress point.

.status.loadBalancer.ingress

Description

ingress is a list containing ingress points for the load-balancer.

Type
`array`

.status.loadBalancer.ingress[]

Description

IngressLoadBalancerIngress represents the status of a load-balancer ingress point.

Type
`object`
PropertyTypeDescription
hostnamestringhostname is set for load-balancer ingress points that are DNS based.
ipstringip is set for load-balancer ingress points that are IP based.
portsarrayports provides information about the ports exposed by this LoadBalancer.
ports[]objectIngressPortStatus represents the error condition of a service port

.status.loadBalancer.ingress[].ports

Description

ports provides information about the ports exposed by this LoadBalancer.

Type
`array`

.status.loadBalancer.ingress[].ports[]

Description

IngressPortStatus represents the error condition of a service port

Type
`object`
Required
  • port
  • protocol
PropertyTypeDescription
errorstringerror is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names - cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.
portintegerport is the port number of the ingress port.
protocolstringprotocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"
Possible enum values: - "SCTP" is the SCTP protocol. - "TCP" is the TCP protocol. - "UDP" is the UDP protocol.

API endpoints

The following API endpoints are available:

  • /apis/networking.k8s.io/v1/ingresses
    • GET: list or watch objects of kind Ingress
  • /apis/networking.k8s.io/v1/watch/ingresses
    • GET: watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
    • DELETE: delete collection of Ingress
    • GET: list or watch objects of kind Ingress
    • POST: create an Ingress
  • /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses
    • GET: watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
    • DELETE: delete an Ingress
    • GET: read the specified Ingress
    • PATCH: partially update the specified Ingress
    • PUT: replace the specified Ingress
  • /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses/{name}
    • GET: watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
  • /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
    • GET: read status of the specified Ingress
    • PATCH: partially update status of the specified Ingress
    • PUT: replace status of the specified Ingress

/apis/networking.k8s.io/v1/ingresses

HTTP method
`GET`
Description
list or watch objects of kind Ingress

HTTP responses

HTTP codeReponse body
200 - OKIngressList schema
401 - UnauthorizedEmpty

/apis/networking.k8s.io/v1/watch/ingresses

HTTP method
`GET`
Description
watch individual changes to a list of Ingress. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.

HTTP responses

HTTP codeReponse body
200 - OKWatchEvent schema
401 - UnauthorizedEmpty

/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses

HTTP method
`DELETE`
Description
delete collection of Ingress

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
list or watch objects of kind Ingress

HTTP responses

HTTP codeReponse body
200 - OKIngressList schema
401 - UnauthorizedEmpty
HTTP method
`POST`
Description
create an Ingress

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyIngress schema

HTTP responses

HTTP codeReponse body
200 - OKIngress schema
201 - CreatedIngress schema
202 - AcceptedIngress schema
401 - UnauthorizedEmpty

/apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses

HTTP method
`GET`
Description
watch individual changes to a list of Ingress. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.

HTTP responses

HTTP codeReponse body
200 - OKWatchEvent schema
401 - UnauthorizedEmpty

/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}

Global path parameters

ParameterTypeDescription
namestringname of the Ingress
HTTP method
`DELETE`
Description
delete an Ingress

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
read the specified Ingress

HTTP responses

HTTP codeReponse body
200 - OKIngress schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update the specified Ingress

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP codeReponse body
200 - OKIngress schema
201 - CreatedIngress schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace the specified Ingress

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyIngress schema

HTTP responses

HTTP codeReponse body
200 - OKIngress schema
201 - CreatedIngress schema
401 - UnauthorizedEmpty

/apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses/{name}

Global path parameters

ParameterTypeDescription
namestringname of the Ingress
HTTP method
`GET`
Description
watch changes to an object of kind Ingress. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead, filtered to a single item with the &#x27;fieldSelector&#x27; parameter.

HTTP responses

HTTP codeReponse body
200 - OKWatchEvent schema
401 - UnauthorizedEmpty

/apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status

Global path parameters

ParameterTypeDescription
namestringname of the Ingress
HTTP method
`GET`
Description
read status of the specified Ingress

HTTP responses

HTTP codeReponse body
200 - OKIngress schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update status of the specified Ingress

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP codeReponse body
200 - OKIngress schema
201 - CreatedIngress schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace status of the specified Ingress

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyIngress schema

HTTP responses

HTTP codeReponse body
200 - OKIngress schema
201 - CreatedIngress schema
401 - UnauthorizedEmpty