networking.k8s.io/Ingress@v1

Properties

Property	Type	Attributes	Description
metadata	IoK8SApimachineryPkgApisMetaV1ObjectMeta	Required, Identifier	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
apiVersion	'networking.k8s.io/v1'	Read-only, Deploy-time constant	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
kind	'Ingress'	Read-only, Deploy-time constant	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
spec	IoK8SApiNetworkingV1IngressSpec		IngressSpec describes the Ingress the user wishes to exist.
status	IoK8SApiNetworkingV1IngressStatus		IngressStatus describe the current state of the Ingress.

IoK8SApimachineryPkgApisMetaV1ObjectMeta

Property	Type	Attributes	Description
name	string	Required, Deploy-time constant, Identifier	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
annotations	IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations		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
creationTimestamp	string	Read-only	Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
deletionGracePeriodSeconds	int	Read-only	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.
deletionTimestamp	string	Read-only	Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.
finalizers	string[]		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.
generation	int	Read-only	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
labels	IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels		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
managedFields	IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry[]	Read-only	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.
namespace	string	Deploy-time constant, Identifier	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
ownerReferences	IoK8SApimachineryPkgApisMetaV1OwnerReference[]		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.
resourceVersion	string	Read-only	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
selfLink	string	Read-only	Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
uid	string	Read-only	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

IoK8SApiNetworkingV1IngressSpec

Property	Type	Attributes	Description
defaultBackend	IoK8SApiNetworkingV1IngressBackend		IngressBackend describes all endpoints for a given service and port.
ingressClassName	string		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.
rules	IoK8SApiNetworkingV1IngressRule[]		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.
tls	IoK8SApiNetworkingV1IngressTLS[]		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.

IoK8SApiNetworkingV1IngressStatus

Property	Type	Attributes	Description
loadBalancer	IoK8SApiNetworkingV1IngressLoadBalancerStatus		IngressLoadBalancerStatus represents the status of a load-balancer.

IoK8SApimachineryPkgApisMetaV1ObjectMetaAnnotations

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ObjectMetaLabels

Additional properties of type string are allowed.

IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry

Property	Type	Attributes	Description
apiVersion	string		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.
fieldsType	string		FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
fieldsV1	any		Any object
manager	string		Manager is an identifier of the workflow managing these fields.
operation	string		Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
subresource	string		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.
time	string		Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

IoK8SApimachineryPkgApisMetaV1OwnerReference

Property	Type	Attributes	Description
apiVersion	string	Required	API version of the referent.
kind	string	Required	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name	string	Required	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid	string	Required	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
blockOwnerDeletion	bool		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.
controller	bool		If true, this reference points to the managing controller.

IoK8SApiNetworkingV1IngressBackend

Property	Type	Attributes	Description
resource	IoK8SApiCoreV1TypedLocalObjectReference		TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
service	IoK8SApiNetworkingV1IngressServiceBackend		IngressServiceBackend references a Kubernetes Service as a Backend.

IoK8SApiNetworkingV1IngressRule

Property	Type	Attributes	Description
host	string		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.
http	IoK8SApiNetworkingV1HttpIngressRuleValue		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 '#'.

IoK8SApiNetworkingV1IngressTLS

Property	Type	Attributes	Description
hosts	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.
secretName	string		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.

IoK8SApiNetworkingV1IngressLoadBalancerStatus

Property	Type	Attributes	Description
ingress	IoK8SApiNetworkingV1IngressLoadBalancerIngress[]		ingress is a list containing ingress points for the load-balancer.

IoK8SApiCoreV1TypedLocalObjectReference

Property	Type	Attributes	Description
kind	string	Required	Kind is the type of resource being referenced
name	string	Required	Name is the name of resource being referenced
apiGroup	string		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.

IoK8SApiNetworkingV1IngressServiceBackend

Property	Type	Attributes	Description
name	string	Required	name is the referenced service. The service must exist in the same namespace as the Ingress object.
port	IoK8SApiNetworkingV1ServiceBackendPort		ServiceBackendPort is the service port being referenced.

IoK8SApiNetworkingV1HttpIngressRuleValue

Property	Type	Attributes	Description
paths	IoK8SApiNetworkingV1HttpIngressPath[]	Required	paths is a collection of paths that map requests to backends.

IoK8SApiNetworkingV1IngressLoadBalancerIngress

Property	Type	Attributes	Description
hostname	string		hostname is set for load-balancer ingress points that are DNS based.
ip	string		ip is set for load-balancer ingress points that are IP based.
ports	IoK8SApiNetworkingV1IngressPortStatus[]		ports provides information about the ports exposed by this LoadBalancer.

IoK8SApiNetworkingV1ServiceBackendPort

Property	Type	Attributes	Description
name	string		name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
number	int		number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".

IoK8SApiNetworkingV1HttpIngressPath

Property	Type	Attributes	Description
backend	IoK8SApiNetworkingV1IngressBackend	Required	IngressBackend describes all endpoints for a given service and port.
pathType	string	Required	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.
path	string		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".

IoK8SApiNetworkingV1IngressPortStatus

Property	Type	Attributes	Description
port	int	Required	port is the port number of the ingress port.
protocol	string	Required	protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"
error	string		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.