resources.ingresses

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: attribute set of (submodule)

Default: { }

Declared by:

resources.ingresses.<name>.apiVersion

APIVersion 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

Type: null or (string)

Declared by:

resources.ingresses.<name>.kind

Kind 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

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata

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

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.metadata.annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Type: null or (attribute set of (string))

Declared by:

resources.ingresses.<name>.metadata.creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

Type: null or signed integer

Declared by:

resources.ingresses.<name>.metadata.deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

Type: null or (list of (string))

Declared by:

resources.ingresses.<name>.metadata.generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: null or signed integer

Declared by:

resources.ingresses.<name>.metadata.labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Type: null or (attribute set of (string))

Declared by:

resources.ingresses.<name>.metadata.managedFields

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn’t need to set or understand this field. A workflow can be the user’s name, a controller’s name, or the name of a specific apply path like “ci-cd”. The set of fields is always in the version that the workflow used when modifying the object.

Type: null or (list of (submodule))

Declared by:

resources.ingresses.<name>.metadata.managedFields.*.apiVersion

APIVersion defines the version of this resource that this field set applies to. The format is “group/version” just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.managedFields.*.fieldsType

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: “FieldsV1”

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.managedFields.*.fieldsV1

FieldsV1 holds the first JSON version format as described in the “FieldsV1” type.

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.metadata.managedFields.*.manager

Manager is an identifier of the workflow managing these fields.

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.managedFields.*.operation

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.managedFields.*.subresource

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.managedFields.*.time

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.namespace

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the “default” namespace, but “default” is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

Type: null or (attribute set of (submodule) or list of (submodule))

Declared by:

resources.ingresses.<name>.metadata.ownerReferences.<name>._priority

This option has no description.

Type: null or signed integer

Default: null

Declared by:

resources.ingresses.<name>.metadata.ownerReferences.<name>.apiVersion

API version of the referent.

Type: string

Declared by:

resources.ingresses.<name>.metadata.ownerReferences.<name>.blockOwnerDeletion

If true, AND if the owner has the “foregroundDeletion” finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: null or boolean

Declared by:

resources.ingresses.<name>.metadata.ownerReferences.<name>.controller

If true, this reference points to the managing controller.

Type: null or boolean

Declared by:

resources.ingresses.<name>.metadata.ownerReferences.<name>.kind

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Declared by:

resources.ingresses.<name>.metadata.ownerReferences.<name>.name

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Declared by:

resources.ingresses.<name>.metadata.ownerReferences.<name>.uid

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

Declared by:

resources.ingresses.<name>.metadata.resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: null or (string)

Declared by:

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

Type: null or (string)

Declared by:

resources.ingresses.<name>.metadata.uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: null or (string)

Declared by:

resources.ingresses.<name>.spec

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

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.defaultBackend

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.

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.defaultBackend.resource

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

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.defaultBackend.resource.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.

Type: null or (string)

Declared by:

resources.ingresses.<name>.spec.defaultBackend.resource.kind

Kind is the type of resource being referenced

Type: string

Declared by:

resources.ingresses.<name>.spec.defaultBackend.resource.name

Name is the name of resource being referenced

Type: string

Declared by:

resources.ingresses.<name>.spec.defaultBackend.service

service references a service as a backend. This is a mutually exclusive setting with “Resource”.

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.defaultBackend.service.name

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

Type: string

Declared by:

resources.ingresses.<name>.spec.defaultBackend.service.port

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

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.defaultBackend.service.port.name

name is the name of the port on the Service. This is a mutually exclusive setting with “Number”.

Type: null or (string)

Declared by:

resources.ingresses.<name>.spec.defaultBackend.service.port.number

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

Type: null or signed integer

Declared by:

resources.ingresses.<name>.spec.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.

Type: null or (string)

Declared by:

resources.ingresses.<name>.spec.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.

Type: null or (list of (submodule))

Declared by:

resources.ingresses.<name>.spec.rules.*.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.

Type: null or (string)

Declared by:

resources.ingresses.<name>.spec.rules.*.http

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths

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

Type: list of (submodule)

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend

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

Type: submodule

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.resource

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

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.resource.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.

Type: null or (string)

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.resource.kind

Kind is the type of resource being referenced

Type: string

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.resource.name

Name is the name of resource being referenced

Type: string

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.service

service references a service as a backend. This is a mutually exclusive setting with “Resource”.

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.service.name

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

Type: string

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.service.port

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

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.service.port.name

name is the name of the port on the Service. This is a mutually exclusive setting with “Number”.

Type: null or (string)

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.backend.service.port.number

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

Type: null or signed integer

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.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”.

Type: null or (string)

Declared by:

resources.ingresses.<name>.spec.rules.*.http.paths.*.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.

Type: string

Declared by:

resources.ingresses.<name>.spec.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.

Type: null or (list of (submodule))

Declared by:

resources.ingresses.<name>.spec.tls.*.hosts

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.

Type: null or (list of (string))

Declared by:

resources.ingresses.<name>.spec.tls.*.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.

Type: null or (string)

Declared by:

resources.ingresses.<name>.status

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

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.status.loadBalancer

loadBalancer contains the current status of the load-balancer.

Type: null or (submodule)

Declared by:

resources.ingresses.<name>.status.loadBalancer.ingress

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

Type: null or (list of (submodule))

Declared by:

resources.ingresses.<name>.status.loadBalancer.ingress.*.hostname

hostname is set for load-balancer ingress points that are DNS based.

Type: null or (string)

Declared by:

resources.ingresses.<name>.status.loadBalancer.ingress.*.ip

ip is set for load-balancer ingress points that are IP based.

Type: null or (string)

Declared by:

resources.ingresses.<name>.status.loadBalancer.ingress.*.ports

ports provides information about the ports exposed by this LoadBalancer.

Type: null or (list of (submodule))

Declared by:

resources.ingresses.<name>.status.loadBalancer.ingress.*.ports.*.error

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

Type: null or (string)

Declared by:

resources.ingresses.<name>.status.loadBalancer.ingress.*.ports.*.port

port is the port number of the ingress port.

Type: signed integer

Declared by:

resources.ingresses.<name>.status.loadBalancer.ingress.*.ports.*.protocol

protocol is the protocol of the ingress port. The supported values are: “TCP”, “UDP”, “SCTP”

Type: string

Declared by: