github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-22 11:21:47 +00:00
Code Issues Projects Releases Wiki Activity

fix doc of types.go of network v1, v1alpha1, v1beta1

Browse Source 
Signed-off-by: Ruquan Zhao <ruquan.zhao@arm.com>
This commit is contained in:
RuquanZhao 2022-11-22 10:09:53 +08:00
parent 3742d14998
commit d5b4644d23
14 changed files with 738 additions and 701 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
api/openapi-spec/swagger.json generated
View File

@ -11458,14 +11458,14 @@
"properties": { "properties": {
"backend": { "backend": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressBackend", "$ref": "#/definitions/io.k8s.api.networking.v1.IngressBackend",
"description": "Backend defines the referenced service endpoint to which the traffic will be forwarded to." "description": "backend defines the referenced service endpoint to which the traffic will be forwarded to."
}, },
"path": { "path": {
"description": "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\".", "description": "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": "string" "type": "string"
}, },
"pathType": { "pathType": {
"description": "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.", "description": "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.",
"type": "string" "type": "string"
} }
}, },
@ -11479,7 +11479,7 @@
"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 '#'.", "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 '#'.",
"properties": { "properties": {
"paths": { "paths": {
"description": "A collection of paths that map requests to backends.", "description": "paths is a collection of paths that map requests to backends.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.HTTPIngressPath" "$ref": "#/definitions/io.k8s.api.networking.v1.HTTPIngressPath"
}, },
@ -11496,11 +11496,11 @@
"description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.", "description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"properties": { "properties": {
"cidr": { "cidr": {
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"", "description": "cidr is a string representing the IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string" "type": "string"
}, },
"except": { "except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the CIDR range", "description": "except is a slice of CIDRs that should not be included within an IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the cidr range",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -11529,11 +11529,11 @@
}, },
"spec": { "spec": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressSpec", "$ref": "#/definitions/io.k8s.api.networking.v1.IngressSpec",
"description": "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" "description": "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"
}, },
"status": { "status": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressStatus", "$ref": "#/definitions/io.k8s.api.networking.v1.IngressStatus",
"description": "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" "description": "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": "object", "type": "object",
@ -11550,11 +11550,11 @@
"properties": { "properties": {
"resource": { "resource": {
"$ref": "#/definitions/io.k8s.api.core.v1.TypedLocalObjectReference", "$ref": "#/definitions/io.k8s.api.core.v1.TypedLocalObjectReference",
"description": "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\"." "description": "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\"."
}, },
"service": { "service": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressServiceBackend", "$ref": "#/definitions/io.k8s.api.networking.v1.IngressServiceBackend",
"description": "Service references a Service as a Backend. This is a mutually exclusive setting with \"Resource\"." "description": "service references a service as a backend. This is a mutually exclusive setting with \"Resource\"."
} }
}, },
"type": "object" "type": "object"
@ -11576,7 +11576,7 @@
}, },
"spec": { "spec": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressClassSpec", "$ref": "#/definitions/io.k8s.api.networking.v1.IngressClassSpec",
"description": "Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" "description": "spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
} }
}, },
"type": "object", "type": "object",
@ -11596,7 +11596,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is the list of IngressClasses.", "description": "items is the list of IngressClasses.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressClass" "$ref": "#/definitions/io.k8s.api.networking.v1.IngressClass"
}, },
@ -11627,23 +11627,23 @@
"description": "IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.", "description": "IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.",
"properties": { "properties": {
"apiGroup": { "apiGroup": {
"description": "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.", "description": "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": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind is the type of resource being referenced.", "description": "kind is the type of resource being referenced.",
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name is the name of resource being referenced.", "description": "name is the name of resource being referenced.",
"type": "string" "type": "string"
}, },
"namespace": { "namespace": {
"description": "Namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".", "description": "namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".",
"type": "string" "type": "string"
}, },
"scope": { "scope": {
"description": "Scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".", "description": "scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".",
"type": "string" "type": "string"
} }
}, },
@ -11657,12 +11657,12 @@
"description": "IngressClassSpec provides information about the class of an Ingress.", "description": "IngressClassSpec provides information about the class of an Ingress.",
"properties": { "properties": {
"controller": { "controller": {
"description": "Controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.", "description": "controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.",
"type": "string" "type": "string"
}, },
"parameters": { "parameters": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressClassParametersReference", "$ref": "#/definitions/io.k8s.api.networking.v1.IngressClassParametersReference",
"description": "Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters." "description": "parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters."
} }
}, },
"type": "object" "type": "object"
@ -11675,7 +11675,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is the list of Ingress.", "description": "items is the list of Ingress.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.Ingress" "$ref": "#/definitions/io.k8s.api.networking.v1.Ingress"
}, },
@ -11706,15 +11706,15 @@
"description": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.", "description": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.",
"properties": { "properties": {
"hostname": { "hostname": {
"description": "Hostname is set for load-balancer ingress points that are DNS based.", "description": "hostname is set for load-balancer ingress points that are DNS based.",
"type": "string" "type": "string"
}, },
"ip": { "ip": {
"description": "IP is set for load-balancer ingress points that are IP based.", "description": "ip is set for load-balancer ingress points that are IP based.",
"type": "string" "type": "string"
}, },
"ports": { "ports": {
"description": "Ports provides information about the ports exposed by this LoadBalancer.", "description": "ports provides information about the ports exposed by this LoadBalancer.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressPortStatus" "$ref": "#/definitions/io.k8s.api.networking.v1.IngressPortStatus"
}, },
@ -11728,7 +11728,7 @@
"description": "IngressLoadBalancerStatus represents the status of a load-balancer.", "description": "IngressLoadBalancerStatus represents the status of a load-balancer.",
"properties": { "properties": {
"ingress": { "ingress": {
"description": "Ingress is a list containing ingress points for the load-balancer.", "description": "ingress is a list containing ingress points for the load-balancer.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressLoadBalancerIngress" "$ref": "#/definitions/io.k8s.api.networking.v1.IngressLoadBalancerIngress"
}, },
@ -11741,16 +11741,16 @@
"description": "IngressPortStatus represents the error condition of a service port", "description": "IngressPortStatus represents the error condition of a service port",
"properties": { "properties": {
"error": { "error": {
"description": "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.", "description": "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.",
"type": "string" "type": "string"
}, },
"port": { "port": {
"description": "Port is the port number of the ingress port.", "description": "port is the port number of the ingress port.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
}, },
"protocol": { "protocol": {
"description": "Protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"", "description": "protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"",
"type": "string" "type": "string"
} }
}, },
@ -11764,7 +11764,7 @@
"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.", "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.",
"properties": { "properties": {
"host": { "host": {
"description": "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nHost 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.", "description": "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nhost 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": "string" "type": "string"
}, },
"http": { "http": {
@ -11777,12 +11777,12 @@
"description": "IngressServiceBackend references a Kubernetes Service as a Backend.", "description": "IngressServiceBackend references a Kubernetes Service as a Backend.",
"properties": { "properties": {
"name": { "name": {
"description": "Name is the referenced service. The service must exist in the same namespace as the Ingress object.", "description": "name is the referenced service. The service must exist in the same namespace as the Ingress object.",
"type": "string" "type": "string"
}, },
"port": { "port": {
"$ref": "#/definitions/io.k8s.api.networking.v1.ServiceBackendPort", "$ref": "#/definitions/io.k8s.api.networking.v1.ServiceBackendPort",
"description": "Port of the referenced service. A port name or port number is required for a IngressServiceBackend." "description": "port of the referenced service. A port name or port number is required for a IngressServiceBackend."
} }
}, },
"required": [ "required": [
@ -11795,14 +11795,14 @@
"properties": { "properties": {
"defaultBackend": { "defaultBackend": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressBackend", "$ref": "#/definitions/io.k8s.api.networking.v1.IngressBackend",
"description": "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." "description": "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."
}, },
"ingressClassName": { "ingressClassName": {
"description": "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.", "description": "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": "string" "type": "string"
}, },
"rules": { "rules": {
"description": "A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.", "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.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressRule" "$ref": "#/definitions/io.k8s.api.networking.v1.IngressRule"
}, },
@ -11810,7 +11810,7 @@
"x-kubernetes-list-type": "atomic" "x-kubernetes-list-type": "atomic"
}, },
"tls": { "tls": {
"description": "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.", "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.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressTLS" "$ref": "#/definitions/io.k8s.api.networking.v1.IngressTLS"
}, },
@ -11825,16 +11825,16 @@
"properties": { "properties": {
"loadBalancer": { "loadBalancer": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IngressLoadBalancerStatus", "$ref": "#/definitions/io.k8s.api.networking.v1.IngressLoadBalancerStatus",
"description": "LoadBalancer contains the current status of the load-balancer." "description": "loadBalancer contains the current status of the load-balancer."
} }
}, },
"type": "object" "type": "object"
}, },
"io.k8s.api.networking.v1.IngressTLS": { "io.k8s.api.networking.v1.IngressTLS": {
"description": "IngressTLS describes the transport layer security associated with an Ingress.", "description": "IngressTLS describes the transport layer security associated with an ingress.",
"properties": { "properties": {
"hosts": { "hosts": {
"description": "Hosts are 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.", "description": "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.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -11842,7 +11842,7 @@
"x-kubernetes-list-type": "atomic" "x-kubernetes-list-type": "atomic"
}, },
"secretName": { "secretName": {
"description": "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.", "description": "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": "string" "type": "string"
} }
}, },
@ -11865,11 +11865,11 @@
}, },
"spec": { "spec": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicySpec", "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicySpec",
"description": "Specification of the desired behavior for this NetworkPolicy." "description": "spec represents the specification of the desired behavior for this NetworkPolicy."
}, },
"status": { "status": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyStatus", "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyStatus",
"description": "Status is the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" "description": "status represents the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
} }
}, },
"type": "object", "type": "object",
@ -11885,14 +11885,14 @@
"description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8", "description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8",
"properties": { "properties": {
"ports": { "ports": {
"description": "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", "description": "ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPort" "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPort"
}, },
"type": "array" "type": "array"
}, },
"to": { "to": {
"description": "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.", "description": "to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPeer" "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPeer"
}, },
@ -11905,14 +11905,14 @@
"description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.", "description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.",
"properties": { "properties": {
"from": { "from": {
"description": "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.", "description": "from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPeer" "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPeer"
}, },
"type": "array" "type": "array"
}, },
"ports": { "ports": {
"description": "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", "description": "ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPort" "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyPort"
}, },
@ -11929,7 +11929,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is a list of schema objects.", "description": "items is a list of schema objects.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicy" "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicy"
}, },
@ -11961,15 +11961,15 @@
"properties": { "properties": {
"ipBlock": { "ipBlock": {
"$ref": "#/definitions/io.k8s.api.networking.v1.IPBlock", "$ref": "#/definitions/io.k8s.api.networking.v1.IPBlock",
"description": "IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be." "description": "ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be."
}, },
"namespaceSelector": { "namespaceSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector." "description": "namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector."
}, },
"podSelector": { "podSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace." "description": "podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace."
} }
}, },
"type": "object" "type": "object"
@ -11978,16 +11978,16 @@
"description": "NetworkPolicyPort describes a port to allow traffic on", "description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": { "properties": {
"endPort": { "endPort": {
"description": "If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.", "description": "endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
}, },
"port": { "port": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString", "$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString",
"description": "The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched." "description": "port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched."
}, },
"protocol": { "protocol": {
"description": "The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.", "description": "protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string" "type": "string"
} }
}, },
@ -11997,14 +11997,14 @@
"description": "NetworkPolicySpec provides the specification of a NetworkPolicy", "description": "NetworkPolicySpec provides the specification of a NetworkPolicy",
"properties": { "properties": {
"egress": { "egress": {
"description": "List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8", "description": "egress is a list of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule" "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule"
}, },
"type": "array" "type": "array"
}, },
"ingress": { "ingress": {
"description": "List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)", "description": "ingress is a list of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyIngressRule" "$ref": "#/definitions/io.k8s.api.networking.v1.NetworkPolicyIngressRule"
}, },
@ -12012,10 +12012,10 @@
}, },
"podSelector": { "podSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector", "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace." "description": "podSelector selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace."
}, },
"policyTypes": { "policyTypes": {
"description": "List of rule types that the NetworkPolicy relates to. Valid options are [\"Ingress\"], [\"Egress\"], or [\"Ingress\", \"Egress\"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an Egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8", "description": "policyTypes is a list of rule types that the NetworkPolicy relates to. Valid options are [\"Ingress\"], [\"Egress\"], or [\"Ingress\", \"Egress\"]. If this field is not specified, it will default based on the existence of ingress or egress rules; policies that contain an egress section are assumed to affect egress, and all policies (whether or not they contain an ingress section) are assumed to affect ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -12028,10 +12028,10 @@
"type": "object" "type": "object"
}, },
"io.k8s.api.networking.v1.NetworkPolicyStatus": { "io.k8s.api.networking.v1.NetworkPolicyStatus": {
"description": "NetworkPolicyStatus describe the current state of the NetworkPolicy.", "description": "NetworkPolicyStatus describes the current state of the NetworkPolicy.",
"properties": { "properties": {
"conditions": { "conditions": {
"description": "Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state", "description": "conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state",
"items": { "items": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition" "$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Condition"
}, },
@ -12050,11 +12050,11 @@
"description": "ServiceBackendPort is the service port being referenced.", "description": "ServiceBackendPort is the service port being referenced.",
"properties": { "properties": {
"name": { "name": {
"description": "Name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".", "description": "name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".",
"type": "string" "type": "string"
}, },
"number": { "number": {
"description": "Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".", "description": "number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
} }
@ -12078,7 +12078,7 @@
}, },
"spec": { "spec": {
"$ref": "#/definitions/io.k8s.api.networking.v1alpha1.ClusterCIDRSpec", "$ref": "#/definitions/io.k8s.api.networking.v1alpha1.ClusterCIDRSpec",
"description": "Spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" "description": "spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
} }
}, },
"type": "object", "type": "object",
@ -12098,7 +12098,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is the list of ClusterCIDRs.", "description": "items is the list of ClusterCIDRs.",
"items": { "items": {
"$ref": "#/definitions/io.k8s.api.networking.v1alpha1.ClusterCIDR" "$ref": "#/definitions/io.k8s.api.networking.v1alpha1.ClusterCIDR"
}, },
@ -12129,19 +12129,19 @@
"description": "ClusterCIDRSpec defines the desired state of ClusterCIDR.", "description": "ClusterCIDRSpec defines the desired state of ClusterCIDR.",
"properties": { "properties": {
"ipv4": { "ipv4": {
"description": "IPv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.", "description": "ipv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
"type": "string" "type": "string"
}, },
"ipv6": { "ipv6": {
"description": "IPv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.", "description": "ipv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
"type": "string" "type": "string"
}, },
"nodeSelector": { "nodeSelector": {
"$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector", "$ref": "#/definitions/io.k8s.api.core.v1.NodeSelector",
"description": "NodeSelector defines which nodes the config is applicable to. An empty or nil NodeSelector selects all nodes. This field is immutable." "description": "nodeSelector defines which nodes the config is applicable to. An empty or nil nodeSelector selects all nodes. This field is immutable."
}, },
"perNodeHostBits": { "perNodeHostBits": {
"description": "PerNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.", "description": "perNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
} }

118
api/openapi-spec/v3/apis__networking.k8s.io__v1_openapi.json
View File

@ -36,14 +36,14 @@
} }
], ],
"default": {}, "default": {},
"description": "Backend defines the referenced service endpoint to which the traffic will be forwarded to." "description": "backend defines the referenced service endpoint to which the traffic will be forwarded to."
}, },
"path": { "path": {
"description": "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\".", "description": "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": "string" "type": "string"
}, },
"pathType": { "pathType": {
"description": "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.", "description": "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.",
"type": "string" "type": "string"
} }
}, },
@ -57,7 +57,7 @@
"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 '#'.", "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 '#'.",
"properties": { "properties": {
"paths": { "paths": {
"description": "A collection of paths that map requests to backends.", "description": "paths is a collection of paths that map requests to backends.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -80,11 +80,11 @@
"properties": { "properties": {
"cidr": { "cidr": {
"default": "", "default": "",
"description": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"", "description": "cidr is a string representing the IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"type": "string" "type": "string"
}, },
"except": { "except": {
"description": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the CIDR range", "description": "except is a slice of CIDRs that should not be included within an IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the cidr range",
"items": { "items": {
"default": "", "default": "",
"type": "string" "type": "string"
@ -124,7 +124,7 @@
} }
], ],
"default": {}, "default": {},
"description": "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" "description": "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"
}, },
"status": { "status": {
"allOf": [ "allOf": [
@ -133,7 +133,7 @@
} }
], ],
"default": {}, "default": {},
"description": "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" "description": "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": "object", "type": "object",
@ -154,7 +154,7 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.TypedLocalObjectReference" "$ref": "#/components/schemas/io.k8s.api.core.v1.TypedLocalObjectReference"
} }
], ],
"description": "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\"." "description": "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\"."
}, },
"service": { "service": {
"allOf": [ "allOf": [
@ -162,7 +162,7 @@
"$ref": "#/components/schemas/io.k8s.api.networking.v1.IngressServiceBackend" "$ref": "#/components/schemas/io.k8s.api.networking.v1.IngressServiceBackend"
} }
], ],
"description": "Service references a Service as a Backend. This is a mutually exclusive setting with \"Resource\"." "description": "service references a service as a backend. This is a mutually exclusive setting with \"Resource\"."
} }
}, },
"type": "object" "type": "object"
@ -194,7 +194,7 @@
} }
], ],
"default": {}, "default": {},
"description": "Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" "description": "spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
} }
}, },
"type": "object", "type": "object",
@ -214,7 +214,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is the list of IngressClasses.", "description": "items is the list of IngressClasses.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -255,25 +255,25 @@
"description": "IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.", "description": "IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.",
"properties": { "properties": {
"apiGroup": { "apiGroup": {
"description": "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.", "description": "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": "string" "type": "string"
}, },
"kind": { "kind": {
"default": "", "default": "",
"description": "Kind is the type of resource being referenced.", "description": "kind is the type of resource being referenced.",
"type": "string" "type": "string"
}, },
"name": { "name": {
"default": "", "default": "",
"description": "Name is the name of resource being referenced.", "description": "name is the name of resource being referenced.",
"type": "string" "type": "string"
}, },
"namespace": { "namespace": {
"description": "Namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".", "description": "namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".",
"type": "string" "type": "string"
}, },
"scope": { "scope": {
"description": "Scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".", "description": "scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".",
"type": "string" "type": "string"
} }
}, },
@ -287,7 +287,7 @@
"description": "IngressClassSpec provides information about the class of an Ingress.", "description": "IngressClassSpec provides information about the class of an Ingress.",
"properties": { "properties": {
"controller": { "controller": {
"description": "Controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.", "description": "controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.",
"type": "string" "type": "string"
}, },
"parameters": { "parameters": {
@ -296,7 +296,7 @@
"$ref": "#/components/schemas/io.k8s.api.networking.v1.IngressClassParametersReference" "$ref": "#/components/schemas/io.k8s.api.networking.v1.IngressClassParametersReference"
} }
], ],
"description": "Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters." "description": "parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters."
} }
}, },
"type": "object" "type": "object"
@ -309,7 +309,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is the list of Ingress.", "description": "items is the list of Ingress.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -350,15 +350,15 @@
"description": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.", "description": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.",
"properties": { "properties": {
"hostname": { "hostname": {
"description": "Hostname is set for load-balancer ingress points that are DNS based.", "description": "hostname is set for load-balancer ingress points that are DNS based.",
"type": "string" "type": "string"
}, },
"ip": { "ip": {
"description": "IP is set for load-balancer ingress points that are IP based.", "description": "ip is set for load-balancer ingress points that are IP based.",
"type": "string" "type": "string"
}, },
"ports": { "ports": {
"description": "Ports provides information about the ports exposed by this LoadBalancer.", "description": "ports provides information about the ports exposed by this LoadBalancer.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -377,7 +377,7 @@
"description": "IngressLoadBalancerStatus represents the status of a load-balancer.", "description": "IngressLoadBalancerStatus represents the status of a load-balancer.",
"properties": { "properties": {
"ingress": { "ingress": {
"description": "Ingress is a list containing ingress points for the load-balancer.", "description": "ingress is a list containing ingress points for the load-balancer.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -395,18 +395,18 @@
"description": "IngressPortStatus represents the error condition of a service port", "description": "IngressPortStatus represents the error condition of a service port",
"properties": { "properties": {
"error": { "error": {
"description": "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.", "description": "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.",
"type": "string" "type": "string"
}, },
"port": { "port": {
"default": 0, "default": 0,
"description": "Port is the port number of the ingress port.", "description": "port is the port number of the ingress port.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
}, },
"protocol": { "protocol": {
"default": "", "default": "",
"description": "Protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"", "description": "protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"",
"type": "string" "type": "string"
} }
}, },
@ -420,7 +420,7 @@
"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.", "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.",
"properties": { "properties": {
"host": { "host": {
"description": "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nHost 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.", "description": "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nhost 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": "string" "type": "string"
}, },
"http": { "http": {
@ -434,7 +434,7 @@
"properties": { "properties": {
"name": { "name": {
"default": "", "default": "",
"description": "Name is the referenced service. The service must exist in the same namespace as the Ingress object.", "description": "name is the referenced service. The service must exist in the same namespace as the Ingress object.",
"type": "string" "type": "string"
}, },
"port": { "port": {
@ -444,7 +444,7 @@
} }
], ],
"default": {}, "default": {},
"description": "Port of the referenced service. A port name or port number is required for a IngressServiceBackend." "description": "port of the referenced service. A port name or port number is required for a IngressServiceBackend."
} }
}, },
"required": [ "required": [
@ -461,14 +461,14 @@
"$ref": "#/components/schemas/io.k8s.api.networking.v1.IngressBackend" "$ref": "#/components/schemas/io.k8s.api.networking.v1.IngressBackend"
} }
], ],
"description": "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." "description": "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."
}, },
"ingressClassName": { "ingressClassName": {
"description": "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.", "description": "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": "string" "type": "string"
}, },
"rules": { "rules": {
"description": "A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.", "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.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -481,7 +481,7 @@
"x-kubernetes-list-type": "atomic" "x-kubernetes-list-type": "atomic"
}, },
"tls": { "tls": {
"description": "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.", "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.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -506,16 +506,16 @@
} }
], ],
"default": {}, "default": {},
"description": "LoadBalancer contains the current status of the load-balancer." "description": "loadBalancer contains the current status of the load-balancer."
} }
}, },
"type": "object" "type": "object"
}, },
"io.k8s.api.networking.v1.IngressTLS": { "io.k8s.api.networking.v1.IngressTLS": {
"description": "IngressTLS describes the transport layer security associated with an Ingress.", "description": "IngressTLS describes the transport layer security associated with an ingress.",
"properties": { "properties": {
"hosts": { "hosts": {
"description": "Hosts are 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.", "description": "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.",
"items": { "items": {
"default": "", "default": "",
"type": "string" "type": "string"
@ -524,7 +524,7 @@
"x-kubernetes-list-type": "atomic" "x-kubernetes-list-type": "atomic"
}, },
"secretName": { "secretName": {
"description": "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.", "description": "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": "string" "type": "string"
} }
}, },
@ -557,7 +557,7 @@
} }
], ],
"default": {}, "default": {},
"description": "Specification of the desired behavior for this NetworkPolicy." "description": "spec represents the specification of the desired behavior for this NetworkPolicy."
}, },
"status": { "status": {
"allOf": [ "allOf": [
@ -566,7 +566,7 @@
} }
], ],
"default": {}, "default": {},
"description": "Status is the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" "description": "status represents the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
} }
}, },
"type": "object", "type": "object",
@ -582,7 +582,7 @@
"description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8", "description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8",
"properties": { "properties": {
"ports": { "ports": {
"description": "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", "description": "ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -594,7 +594,7 @@
"type": "array" "type": "array"
}, },
"to": { "to": {
"description": "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.", "description": "to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -612,7 +612,7 @@
"description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.", "description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.",
"properties": { "properties": {
"from": { "from": {
"description": "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.", "description": "from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -624,7 +624,7 @@
"type": "array" "type": "array"
}, },
"ports": { "ports": {
"description": "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", "description": "ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -646,7 +646,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is a list of schema objects.", "description": "items is a list of schema objects.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -692,7 +692,7 @@
"$ref": "#/components/schemas/io.k8s.api.networking.v1.IPBlock" "$ref": "#/components/schemas/io.k8s.api.networking.v1.IPBlock"
} }
], ],
"description": "IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be." "description": "ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be."
}, },
"namespaceSelector": { "namespaceSelector": {
"allOf": [ "allOf": [
@ -700,7 +700,7 @@
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector" "$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
} }
], ],
"description": "Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector." "description": "namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector."
}, },
"podSelector": { "podSelector": {
"allOf": [ "allOf": [
@ -708,7 +708,7 @@
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector" "$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
} }
], ],
"description": "This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace." "description": "podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace."
} }
}, },
"type": "object" "type": "object"
@ -717,7 +717,7 @@
"description": "NetworkPolicyPort describes a port to allow traffic on", "description": "NetworkPolicyPort describes a port to allow traffic on",
"properties": { "properties": {
"endPort": { "endPort": {
"description": "If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.", "description": "endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
}, },
@ -727,10 +727,10 @@
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.util.intstr.IntOrString" "$ref": "#/components/schemas/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
} }
], ],
"description": "The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched." "description": "port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched."
}, },
"protocol": { "protocol": {
"description": "The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.", "description": "protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.",
"type": "string" "type": "string"
} }
}, },
@ -740,7 +740,7 @@
"description": "NetworkPolicySpec provides the specification of a NetworkPolicy", "description": "NetworkPolicySpec provides the specification of a NetworkPolicy",
"properties": { "properties": {
"egress": { "egress": {
"description": "List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8", "description": "egress is a list of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -752,7 +752,7 @@
"type": "array" "type": "array"
}, },
"ingress": { "ingress": {
"description": "List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)", "description": "ingress is a list of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -770,10 +770,10 @@
} }
], ],
"default": {}, "default": {},
"description": "Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace." "description": "podSelector selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace."
}, },
"policyTypes": { "policyTypes": {
"description": "List of rule types that the NetworkPolicy relates to. Valid options are [\"Ingress\"], [\"Egress\"], or [\"Ingress\", \"Egress\"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an Egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8", "description": "policyTypes is a list of rule types that the NetworkPolicy relates to. Valid options are [\"Ingress\"], [\"Egress\"], or [\"Ingress\", \"Egress\"]. If this field is not specified, it will default based on the existence of ingress or egress rules; policies that contain an egress section are assumed to affect egress, and all policies (whether or not they contain an ingress section) are assumed to affect ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8",
"items": { "items": {
"default": "", "default": "",
"type": "string" "type": "string"
@ -787,10 +787,10 @@
"type": "object" "type": "object"
}, },
"io.k8s.api.networking.v1.NetworkPolicyStatus": { "io.k8s.api.networking.v1.NetworkPolicyStatus": {
"description": "NetworkPolicyStatus describe the current state of the NetworkPolicy.", "description": "NetworkPolicyStatus describes the current state of the NetworkPolicy.",
"properties": { "properties": {
"conditions": { "conditions": {
"description": "Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state", "description": "conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -814,11 +814,11 @@
"description": "ServiceBackendPort is the service port being referenced.", "description": "ServiceBackendPort is the service port being referenced.",
"properties": { "properties": {
"name": { "name": {
"description": "Name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".", "description": "name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".",
"type": "string" "type": "string"
}, },
"number": { "number": {
"description": "Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".", "description": "number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
} }

12
api/openapi-spec/v3/apis__networking.k8s.io__v1alpha1_openapi.json
View File

@ -109,7 +109,7 @@
} }
], ],
"default": {}, "default": {},
"description": "Spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" "description": "spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
} }
}, },
"type": "object", "type": "object",
@ -129,7 +129,7 @@
"type": "string" "type": "string"
}, },
"items": { "items": {
"description": "Items is the list of ClusterCIDRs.", "description": "items is the list of ClusterCIDRs.",
"items": { "items": {
"allOf": [ "allOf": [
{ {
@ -171,12 +171,12 @@
"properties": { "properties": {
"ipv4": { "ipv4": {
"default": "", "default": "",
"description": "IPv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.", "description": "ipv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
"type": "string" "type": "string"
}, },
"ipv6": { "ipv6": {
"default": "", "default": "",
"description": "IPv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.", "description": "ipv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
"type": "string" "type": "string"
}, },
"nodeSelector": { "nodeSelector": {
@ -185,11 +185,11 @@
"$ref": "#/components/schemas/io.k8s.api.core.v1.NodeSelector" "$ref": "#/components/schemas/io.k8s.api.core.v1.NodeSelector"
} }
], ],
"description": "NodeSelector defines which nodes the config is applicable to. An empty or nil NodeSelector selects all nodes. This field is immutable." "description": "nodeSelector defines which nodes the config is applicable to. An empty or nil nodeSelector selects all nodes. This field is immutable."
}, },
"perNodeHostBits": { "perNodeHostBits": {
"default": 0, "default": 0,
"description": "PerNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.", "description": "perNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
} }

212
pkg/apis/networking/types.go
View File

@ -24,17 +24,18 @@ import (
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// NetworkPolicy describes what network traffic is allowed for a set of Pods // NetworkPolicy describes what network traffic is allowed for a set of pods
type NetworkPolicy struct { type NetworkPolicy struct {
metav1.TypeMeta metav1.TypeMeta
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Specification of the desired behavior for this NetworkPolicy. // spec represents the specification of the desired behavior for this NetworkPolicy.
// +optional // +optional
Spec NetworkPolicySpec Spec NetworkPolicySpec
// Status is the current state of the NetworkPolicy. // status represents the current state of the NetworkPolicy.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Status NetworkPolicyStatus Status NetworkPolicyStatus
@ -53,16 +54,16 @@ const (
// NetworkPolicySpec provides the specification of a NetworkPolicy // NetworkPolicySpec provides the specification of a NetworkPolicy
type NetworkPolicySpec struct { type NetworkPolicySpec struct {
// Selects the pods to which this NetworkPolicy object applies. The array of // podSelector selects the pods to which this NetworkPolicy object applies.
// ingress rules is applied to any pods selected by this field. Multiple network // The array of ingress rules is applied to any pods selected by this field.
// policies can select the same set of pods. In this case, the ingress rules for // Multiple network policies can select the same set of pods. In this case,
// each are combined additively. This field is NOT optional and follows standard // the ingress rules for each are combined additively.
// label selector semantics. An empty podSelector matches all pods in this // This field is NOT optional and follows standard label selector semantics.
// namespace. // An empty podSelector matches all pods in this namespace.
PodSelector metav1.LabelSelector PodSelector metav1.LabelSelector
// List of ingress rules to be applied to the selected pods. Traffic is allowed to // ingress is a list of ingress rules to be applied to the selected pods.
// a pod if there are no NetworkPolicies selecting the pod // Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod
// (and cluster policy otherwise allows the traffic), OR if the traffic source is // (and cluster policy otherwise allows the traffic), OR if the traffic source is
// the pod's local node, OR if the traffic matches at least one ingress rule // the pod's local node, OR if the traffic matches at least one ingress rule
// across all of the NetworkPolicy objects whose podSelector matches the pod. If // across all of the NetworkPolicy objects whose podSelector matches the pod. If
@ -71,8 +72,8 @@ type NetworkPolicySpec struct {
// +optional // +optional
Ingress []NetworkPolicyIngressRule Ingress []NetworkPolicyIngressRule
// List of egress rules to be applied to the selected pods. Outgoing traffic is // egress is a list of egress rules to be applied to the selected pods. Outgoing traffic
// allowed if there are no NetworkPolicies selecting the pod (and cluster policy // is allowed if there are no NetworkPolicies selecting the pod (and cluster policy
// otherwise allows the traffic), OR if the traffic matches at least one egress rule // otherwise allows the traffic), OR if the traffic matches at least one egress rule
// across all of the NetworkPolicy objects whose podSelector matches the pod. If // across all of the NetworkPolicy objects whose podSelector matches the pod. If
// this field is empty then this NetworkPolicy limits all outgoing traffic (and serves // this field is empty then this NetworkPolicy limits all outgoing traffic (and serves
@ -81,15 +82,15 @@ type NetworkPolicySpec struct {
// +optional // +optional
Egress []NetworkPolicyEgressRule Egress []NetworkPolicyEgressRule
// List of rule types that the NetworkPolicy relates to. // policyTypes is a list of rule types that the NetworkPolicy relates to.
// Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. // Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"].
// If this field is not specified, it will default based on the existence of Ingress or Egress rules; // If this field is not specified, it will default based on the existence of ingress or egress rules;
// policies that contain an Egress section are assumed to affect Egress, and all policies // policies that contain an egress section are assumed to affect egress, and all policies
// (whether or not they contain an Ingress section) are assumed to affect Ingress. // (whether or not they contain an ingress section) are assumed to affect ingress.
// If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. // If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
// Likewise, if you want to write a policy that specifies that no egress is allowed, // Likewise, if you want to write a policy that specifies that no egress is allowed,
// you must specify a policyTypes value that include "Egress" (since such a policy would not include // you must specify a policyTypes value that include "Egress" (since such a policy would not include
// an Egress section and would otherwise default to just [ "Ingress" ]). // an egress section and would otherwise default to just [ "Ingress" ]).
// This field is beta-level in 1.8 // This field is beta-level in 1.8
// +optional // +optional
PolicyTypes []PolicyType PolicyTypes []PolicyType
@ -98,15 +99,15 @@ type NetworkPolicySpec struct {
// NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods // NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods
// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. // matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.
type NetworkPolicyIngressRule struct { type NetworkPolicyIngressRule struct {
// List of ports which should be made accessible on the pods selected for this // ports is a list of ports which should be made accessible on the pods selected for
// rule. Each item in this list is combined using a logical OR. If this field is // this rule. Each item in this list is combined using a logical OR. If this field is
// empty or missing, this rule matches all ports (traffic not restricted by port). // empty or missing, this rule matches all ports (traffic not restricted by port).
// If this field is present and contains at least one item, then this rule allows // If this field is present and contains at least one item, then this rule allows
// traffic only if the traffic matches at least one port in the list. // traffic only if the traffic matches at least one port in the list.
// +optional // +optional
Ports []NetworkPolicyPort Ports []NetworkPolicyPort
// List of sources which should be able to access the pods selected for this rule. // from is a list of sources which should be able to access the pods selected for this rule.
// Items in this list are combined using a logical OR operation. If this field is // Items in this list are combined using a logical OR operation. If this field is
// empty or missing, this rule matches all sources (traffic not restricted by // empty or missing, this rule matches all sources (traffic not restricted by
// source). If this field is present and contains at least one item, this rule // source). If this field is present and contains at least one item, this rule
@ -119,7 +120,7 @@ type NetworkPolicyIngressRule struct {
// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. // matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to.
// This type is beta-level in 1.8 // This type is beta-level in 1.8
type NetworkPolicyEgressRule struct { type NetworkPolicyEgressRule struct {
// List of destination ports for outgoing traffic. // ports is a list of destination ports for outgoing traffic.
// Each item in this list is combined using a logical OR. If this field is // Each item in this list is combined using a logical OR. If this field is
// empty or missing, this rule matches all ports (traffic not restricted by port). // empty or missing, this rule matches all ports (traffic not restricted by port).
// If this field is present and contains at least one item, then this rule allows // If this field is present and contains at least one item, then this rule allows
@ -127,7 +128,7 @@ type NetworkPolicyEgressRule struct {
// +optional // +optional
Ports []NetworkPolicyPort Ports []NetworkPolicyPort
// List of destinations for outgoing traffic of pods selected for this rule. // to is a list of destinations for outgoing traffic of pods selected for this rule.
// Items in this list are combined using a logical OR operation. If this field is // Items in this list are combined using a logical OR operation. If this field is
// empty or missing, this rule matches all destinations (traffic not restricted by // empty or missing, this rule matches all destinations (traffic not restricted by
// destination). If this field is present and contains at least one item, this rule // destination). If this field is present and contains at least one item, this rule
@ -138,19 +139,19 @@ type NetworkPolicyEgressRule struct {
// NetworkPolicyPort describes a port to allow traffic on // NetworkPolicyPort describes a port to allow traffic on
type NetworkPolicyPort struct { type NetworkPolicyPort struct {
// The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this // protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match.
// field defaults to TCP. // If not specified, this field defaults to TCP.
// +optional // +optional
Protocol *api.Protocol Protocol *api.Protocol
// The port on the given protocol. This can either be a numerical or named // port represents the port on the given protocol. This can either be a numerical or named
// port on a pod. If this field is not provided, this matches all port names and // port on a pod. If this field is not provided, this matches all port names and
// numbers. // numbers.
// If present, only traffic on the specified protocol AND port will be matched. // If present, only traffic on the specified protocol AND port will be matched.
// +optional // +optional
Port *intstr.IntOrString Port *intstr.IntOrString
// If set, indicates that the range of ports from port to endPort, inclusive, // endPort indicates that the range of ports from port to endPort if set, inclusive,
// should be allowed by the policy. This field cannot be defined if the port field // should be allowed by the policy. This field cannot be defined if the port field
// is not defined or if the port field is defined as a named (string) port. // is not defined or if the port field is defined as a named (string) port.
// The endPort must be equal or greater than port. // The endPort must be equal or greater than port.
@ -162,37 +163,38 @@ type NetworkPolicyPort struct {
// to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs // to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs
// that should not be included within this rule. // that should not be included within this rule.
type IPBlock struct { type IPBlock struct {
// CIDR is a string representing the IP Block // cidr is a string representing the IPBlock
// Valid examples are "192.168.1.0/24" or "2001:db8::/64" // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
CIDR string CIDR string
// Except is a slice of CIDRs that should not be included within an IP Block
// except is a list of CIDRs that should not be included within the IPBlock
// Valid examples are "192.168.1.0/24" or "2001:db8::/64" // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
// Except values will be rejected if they are outside the CIDR range // Except values will be rejected if they are outside the cidr range
// +optional // +optional
Except []string Except []string
} }
// NetworkPolicyPeer describes a peer to allow traffic to/from. // NetworkPolicyPeer describes a peer to allow traffic to/from.
type NetworkPolicyPeer struct { type NetworkPolicyPeer struct {
// This is a label selector which selects Pods. This field follows standard label // podSelector is a label selector which selects pods. This field follows standard label
// selector semantics; if present but empty, it selects all pods. // selector semantics; if present but empty, it selects all pods.
// //
// If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects // If namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
// the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. // the pods matching podSelector in the Namespaces selected by namespaceSelector.
// Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. // Otherwise it selects the pods matching podSelector in the policy's own namespace.
// +optional // +optional
PodSelector *metav1.LabelSelector PodSelector *metav1.LabelSelector
// Selects Namespaces using cluster-scoped labels. This field follows standard label // namespaceSelector selects namespaces using cluster-scoped labels. This field follows
// selector semantics; if present but empty, it selects all namespaces. // standard label selector semantics; if present but empty, it selects all namespaces.
// //
// If PodSelector is also set, then the NetworkPolicyPeer as a whole selects // If podSelector is also set, then the NetworkPolicyPeer as a whole selects
// the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. // the pods matching podSelector in the namespaces selected by namespaceSelector.
// Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. // Otherwise it selects all pods in the namespaces selected by namespaceSelector.
// +optional // +optional
NamespaceSelector *metav1.LabelSelector NamespaceSelector *metav1.LabelSelector
// IPBlock defines policy on a particular IPBlock. If this field is set then // ipBlock defines policy on a particular IPBlock. If this field is set then
// neither of the other fields can be. // neither of the other fields can be.
// +optional // +optional
IPBlock *IPBlock IPBlock *IPBlock
@ -228,9 +230,9 @@ const (
NetworkPolicyConditionReasonFeatureNotSupported NetworkPolicyConditionReason = "FeatureNotSupported" NetworkPolicyConditionReasonFeatureNotSupported NetworkPolicyConditionReason = "FeatureNotSupported"
) )
// NetworkPolicyStatus describe the current state of the NetworkPolicy. // NetworkPolicyStatus describes the current state of the NetworkPolicy.
type NetworkPolicyStatus struct { type NetworkPolicyStatus struct {
// Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. // conditions holds an array of metav1.Condition that describes the state of the NetworkPolicy.
Conditions []metav1.Condition Conditions []metav1.Condition
} }
@ -239,6 +241,7 @@ type NetworkPolicyStatus struct {
// NetworkPolicyList is a list of NetworkPolicy objects. // NetworkPolicyList is a list of NetworkPolicy objects.
type NetworkPolicyList struct { type NetworkPolicyList struct {
metav1.TypeMeta metav1.TypeMeta
// +optional // +optional
metav1.ListMeta metav1.ListMeta
@ -253,17 +256,18 @@ type NetworkPolicyList struct {
// based virtual hosting etc. // based virtual hosting etc.
type Ingress struct { type Ingress struct {
metav1.TypeMeta metav1.TypeMeta
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ObjectMeta metav1.ObjectMeta
// Spec is the desired state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec IngressSpec Spec IngressSpec
// Status is the current state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Status IngressStatus Status IngressStatus
@ -274,18 +278,19 @@ type Ingress struct {
// IngressList is a collection of Ingress. // IngressList is a collection of Ingress.
type IngressList struct { type IngressList struct {
metav1.TypeMeta metav1.TypeMeta
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta metav1.ListMeta
// Items is the list of Ingress. // items is the list of Ingress.
Items []Ingress Items []Ingress
} }
// IngressSpec describes the Ingress the user wishes to exist. // IngressSpec describes the Ingress the user wishes to exist.
type IngressSpec struct { type IngressSpec struct {
// IngressClassName is the name of the IngressClass cluster resource. The // ingressClassName is the name of the IngressClass cluster resource. The
// associated IngressClass defines which controller will implement the // associated IngressClass defines which controller will implement the
// resource. This replaces the deprecated `kubernetes.io/ingress.class` // resource. This replaces the deprecated `kubernetes.io/ingress.class`
// annotation. For backwards compatibility, when that annotation is set, it // annotation. For backwards compatibility, when that annotation is set, it
@ -298,23 +303,23 @@ type IngressSpec struct {
// +optional // +optional
IngressClassName *string IngressClassName *string
// DefaultBackend is the backend that should handle requests that don't // defaultBackend is the backend that should handle requests that don't
// match any rule. If Rules are not specified, DefaultBackend must be specified. // 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 // If DefaultBackend is not set, the handling of requests that do not match any
// of the rules will be up to the Ingress controller. // of the rules will be up to the Ingress controller.
// +optional // +optional
DefaultBackend *IngressBackend DefaultBackend *IngressBackend
// TLS configuration. Currently the Ingress only supports a single TLS // tls represents the TLS configuration. Currently the ingress only supports a
// port, 443. If multiple members of this list specify different hosts, they // single TLS port, 443. If multiple members of this list specify different hosts,
// will be multiplexed on the same port according to the hostname specified // they will be multiplexed on the same port according to the hostname specified
// through the SNI TLS extension, if the ingress controller fulfilling the // through the SNI TLS extension, if the ingress controller fulfilling the
// ingress supports SNI. // ingress supports SNI.
// +listType=atomic // +listType=atomic
// +optional // +optional
TLS []IngressTLS TLS []IngressTLS
// A list of host rules used to configure the Ingress. If unspecified, or // 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. // no rule matches, all traffic is sent to the default backend.
// +listType=atomic // +listType=atomic
// +optional // +optional
@ -330,9 +335,10 @@ type IngressSpec struct {
// resources without a class specified will be assigned this default class. // resources without a class specified will be assigned this default class.
type IngressClass struct { type IngressClass struct {
metav1.TypeMeta metav1.TypeMeta
metav1.ObjectMeta metav1.ObjectMeta
// Spec is the desired state of the IngressClass. // spec is the desired state of the IngressClass.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec IngressClassSpec Spec IngressClassSpec
@ -340,15 +346,15 @@ type IngressClass struct {
// IngressClassSpec provides information about the class of an Ingress. // IngressClassSpec provides information about the class of an Ingress.
type IngressClassSpec struct { type IngressClassSpec struct {
// Controller refers to the name of the controller that should handle this // controller refers to the name of the controller that should handle this
// class. This allows for different "flavors" that are controlled by the // class. This allows for different "flavors" that are controlled by the
// same controller. For example, you may have different Parameters for the // same controller. For example, you may have different parameters for the
// same implementing controller. This should be specified as a // same implementing controller. This should be specified as a
// domain-prefixed path no more than 250 characters in length, e.g. // domain-prefixed path no more than 250 characters in length, e.g.
// "acme.io/ingress-controller". This field is immutable. // "acme.io/ingress-controller". This field is immutable.
Controller string Controller string
// Parameters is a link to a custom resource containing additional // parameters is a link to a custom resource containing additional
// configuration for the controller. This is optional if the controller does // configuration for the controller. This is optional if the controller does
// not require extra parameters. // not require extra parameters.
// +optional // +optional
@ -367,20 +373,24 @@ const (
// IngressClassParametersReference identifies an API object. This can be used // IngressClassParametersReference identifies an API object. This can be used
// to specify a cluster or namespace-scoped resource. // to specify a cluster or namespace-scoped resource.
type IngressClassParametersReference struct { type IngressClassParametersReference struct {
// APIGroup is the group for the resource being referenced. If APIGroup is // 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 // not specified, the specified kind must be in the core API group. For any
// other third-party types, APIGroup is required. // other third-party types, apiGroup is required.
// +optional // +optional
APIGroup *string APIGroup *string
// Kind is the type of resource being referenced.
// kind is the type of resource being referenced.
Kind string Kind string
// Name is the name of resource being referenced.
// name is the name of resource being referenced.
Name string Name string
// Scope represents if this refers to a cluster or namespace scoped resource.
// scope represents if this refers to a cluster or namespace scoped resource.
// This may be set to "Cluster" (default) or "Namespace". // This may be set to "Cluster" (default) or "Namespace".
// +optional // +optional
Scope *string Scope *string
// Namespace is the namespace of the resource being referenced. This field is
// namespace is the namespace of the resource being referenced. This field is
// required when scope is set to "Namespace" and must be unset when scope is set to // required when scope is set to "Namespace" and must be unset when scope is set to
// "Cluster". // "Cluster".
// +optional // +optional
@ -392,71 +402,73 @@ type IngressClassParametersReference struct {
// IngressClassList is a collection of IngressClasses. // IngressClassList is a collection of IngressClasses.
type IngressClassList struct { type IngressClassList struct {
metav1.TypeMeta metav1.TypeMeta
// Standard object's metadata. // Standard object's metadata.
// +optional // +optional
metav1.ListMeta metav1.ListMeta
// Items is the list of IngressClasses. // items is the list of IngressClasses.
Items []IngressClass Items []IngressClass
} }
// IngressTLS describes the transport layer security associated with an Ingress. // IngressTLS describes the transport layer security associated with an ingress.
type IngressTLS struct { type IngressTLS struct {
// Hosts are a list of hosts included in the TLS certificate. The values in // 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 // this list must match the name/s used in the tlsSecret. Defaults to the
// wildcard host setting for the loadbalancer controller fulfilling this // wildcard host setting for the loadbalancer controller fulfilling this
// Ingress, if left unspecified. // Ingress, if left unspecified.
// +listType=atomic // +listType=atomic
// +optional // +optional
Hosts []string Hosts []string
// SecretName is the name of the secret used to terminate TLS traffic on
// 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 // 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" // 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 // header field used by an IngressRule, the SNI host is used for termination
// and value of the Host header is used for routing. // and value of the "Host" header is used for routing.
// +optional // +optional
SecretName string SecretName string
// TODO: Consider specifying different modes of termination, protocols etc. // TODO: Consider specifying different modes of termination, protocols etc.
} }
// IngressStatus describe the current state of the Ingress. // IngressStatus describes the current state of the Ingress.
type IngressStatus struct { type IngressStatus struct {
// LoadBalancer contains the current status of the load-balancer. // loadBalancer contains the current status of the load-balancer.
// +optional // +optional
LoadBalancer IngressLoadBalancerStatus LoadBalancer IngressLoadBalancerStatus
} }
// IngressLoadBalancerStatus represents the status of a load-balancer // IngressLoadBalancerStatus represents the status of a load-balancer
type IngressLoadBalancerStatus struct { type IngressLoadBalancerStatus struct {
// Ingress is a list containing ingress points for the load-balancer. // ingress is a list containing ingress points for the load-balancer.
// +optional // +optional
Ingress []IngressLoadBalancerIngress Ingress []IngressLoadBalancerIngress
} }
// IngressLoadBalancerIngress represents the status of a load-balancer ingress point. // IngressLoadBalancerIngress represents the status of a load-balancer ingress point.
type IngressLoadBalancerIngress struct { type IngressLoadBalancerIngress struct {
// IP is set for load-balancer ingress points that are IP based. // ip is set for load-balancer ingress points that are IP based.
// +optional // +optional
IP string IP string
// Hostname is set for load-balancer ingress points that are DNS based. // hostname is set for load-balancer ingress points that are DNS based.
// +optional // +optional
Hostname string Hostname string
// Ports provides information about the ports exposed by this LoadBalancer. // ports provides information about the ports exposed by this LoadBalancer.
// +optional // +optional
Ports []IngressPortStatus Ports []IngressPortStatus
} }
// IngressPortStatus represents the error condition of an ingress port // IngressPortStatus represents the error condition of an ingress port
type IngressPortStatus struct { type IngressPortStatus struct {
// Port is the port number of the ingress port. // port is the port number of the ingress port.
Port int32 Port int32
// Protocol is the protocol of the ingress port. // protocol is the protocol of the ingress port.
Protocol api.Protocol Protocol api.Protocol
// Error indicates a problem on this port. // error indicates a problem on this port.
// The format of the error must comply with the following rules: // The format of the error must comply with the following rules:
// - Kubernetes-defined error values use CamelCase names // - Kubernetes-defined error values use CamelCase names
// - Provider-specific error values must follow label-name style (e.g. // - Provider-specific error values must follow label-name style (e.g.
@ -469,7 +481,7 @@ type IngressPortStatus struct {
// host match, then routed to the backend associated with the matching // host match, then routed to the backend associated with the matching
// IngressRuleValue. // IngressRuleValue.
type IngressRule struct { type IngressRule struct {
// Host is the fully qualified domain name of a network host, as defined by RFC 3986. // 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 // Note the following deviations from the "host" part of the
// URI as defined in RFC 3986: // URI as defined in RFC 3986:
// 1. IPs are not allowed. Currently an IngressRuleValue can only apply to // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
@ -482,17 +494,18 @@ type IngressRule struct {
// IngressRuleValue. If the host is unspecified, the Ingress routes all // IngressRuleValue. If the host is unspecified, the Ingress routes all
// traffic based on the specified IngressRuleValue. // traffic based on the specified IngressRuleValue.
// //
// Host can be "precise" which is a domain name without the terminating dot of // 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 // 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"). // prefixed with a single wildcard label (e.g. "*.foo.com").
// The wildcard character '*' must appear by itself as the first DNS label and // 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 == "*"). // 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: // 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. // 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 // 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. // is to equal to the suffix (removing the first label) of the wildcard rule.
// +optional // +optional
Host string Host string
// IngressRuleValue represents a rule to route requests for this // IngressRuleValue represents a rule to route requests for this
// IngressRule. If unspecified, the rule defaults to a http catch-all. // IngressRule. If unspecified, the rule defaults to a http catch-all.
// Whether that sends just traffic matching the host to the default backend // Whether that sends just traffic matching the host to the default backend
@ -524,7 +537,7 @@ type IngressRuleValue struct {
// to match against everything after the last '/' and before the first '?' // to match against everything after the last '/' and before the first '?'
// or '#'. // or '#'.
type HTTPIngressRuleValue struct { type HTTPIngressRuleValue struct {
// A collection of paths that map requests to backends. // paths is a collection of paths that map requests to backends.
// +listType=atomic // +listType=atomic
Paths []HTTPIngressPath Paths []HTTPIngressPath
// TODO: Consider adding fields for ingress-type specific global // TODO: Consider adding fields for ingress-type specific global
@ -564,32 +577,32 @@ const (
// HTTPIngressPath associates a path with a backend. Incoming urls matching the // HTTPIngressPath associates a path with a backend. Incoming urls matching the
// path are forwarded to the backend. // path are forwarded to the backend.
type HTTPIngressPath struct { type HTTPIngressPath struct {
// Path is matched against the path of an incoming request. Currently it can // path is matched against the path of an incoming request. Currently it can
// contain characters disallowed from the conventional "path" part of a URL // 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 // as defined by RFC 3986. Paths must begin with a '/' and must be present
// when using PathType with value "Exact" or "Prefix". // when using PathType with value "Exact" or "Prefix".
// +optional // +optional
Path string Path string
// PathType determines the interpretation of the Path matching. PathType can // pathType determines the interpretation of the path matching. PathType can
// be one of Exact, Prefix, or ImplementationSpecific. Implementations are // be one of Exact, Prefix, or ImplementationSpecific. Implementations are
// required to support all path types. // required to support all path types.
// +optional // +optional
PathType *PathType PathType *PathType
// Backend defines the referenced service endpoint to which the traffic // backend defines the referenced service endpoint to which the traffic
// will be forwarded to. // will be forwarded to.
Backend IngressBackend Backend IngressBackend
} }
// IngressBackend describes all endpoints for a given service and port. // IngressBackend describes all endpoints for a given service and port.
type IngressBackend struct { type IngressBackend struct {
// Service references a Service as a Backend. // service references a service as a backend.
// This is a mutually exclusive setting with "Resource". // This is a mutually exclusive setting with "Resource".
// +optional // +optional
Service *IngressServiceBackend Service *IngressServiceBackend
// Resource is an ObjectRef to another Kubernetes resource in the namespace // resource is an ObjectRef to another Kubernetes resource in the namespace
// of the Ingress object. If resource is specified, a service.Name and // of the Ingress object. If resource is specified, a service.Name and
// service.Port must not be specified. // service.Port must not be specified.
// This is a mutually exclusive setting with "Service". // This is a mutually exclusive setting with "Service".
@ -599,24 +612,24 @@ type IngressBackend struct {
// IngressServiceBackend references a Kubernetes Service as a Backend. // IngressServiceBackend references a Kubernetes Service as a Backend.
type IngressServiceBackend struct { type IngressServiceBackend struct {
// Name is the referenced service. The service must exist in // name is the referenced service. The service must exist in
// the same namespace as the Ingress object. // the same namespace as the Ingress object.
Name string Name string
// Port of the referenced service. A port name or port number // port of the referenced service. A port name or port number
// is required for a IngressServiceBackend. // is required for a IngressServiceBackend.
Port ServiceBackendPort Port ServiceBackendPort
} }
// ServiceBackendPort is the service port being referenced. // ServiceBackendPort is the service port being referenced.
type ServiceBackendPort struct { type ServiceBackendPort struct {
// Name is the name of the port on the Service. // name is the name of the port on the Service.
// This must be an IANA_SVC_NAME (following RFC6335). // This must be an IANA_SVC_NAME (following RFC6335).
// This is a mutually exclusive setting with "Number". // This is a mutually exclusive setting with "Number".
// +optional // +optional
Name string Name string
// Number is the numerical port number (e.g. 80) on the Service. // number is the numerical port number (e.g. 80) on the Service.
// This is a mutually exclusive setting with "Name". // This is a mutually exclusive setting with "Name".
// +optional // +optional
Number int32 Number int32
@ -637,6 +650,7 @@ type ServiceBackendPort struct {
// selector matches the Node may be used. // selector matches the Node may be used.
type ClusterCIDR struct { type ClusterCIDR struct {
metav1.TypeMeta metav1.TypeMeta
metav1.ObjectMeta metav1.ObjectMeta
Spec ClusterCIDRSpec Spec ClusterCIDRSpec
@ -644,13 +658,13 @@ type ClusterCIDR struct {
// ClusterCIDRSpec defines the desired state of ClusterCIDR. // ClusterCIDRSpec defines the desired state of ClusterCIDR.
type ClusterCIDRSpec struct { type ClusterCIDRSpec struct {
// NodeSelector defines which nodes the config is applicable to. // nodeSelector defines which nodes the config is applicable to.
// An empty or nil NodeSelector selects all nodes. // An empty or nil nodeSelector selects all nodes.
// This field is immutable. // This field is immutable.
// +optional // +optional
NodeSelector *api.NodeSelector NodeSelector *api.NodeSelector
// PerNodeHostBits defines the number of host bits to be configured per node. // perNodeHostBits defines the number of host bits to be configured per node.
// A subnet mask determines how much of the address is used for network bits // A subnet mask determines how much of the address is used for network bits
// and host bits. For example an IPv4 address of 192.168.0.0/24, splits the // and host bits. For example an IPv4 address of 192.168.0.0/24, splits the
// address into 24 bits for the network portion and 8 bits for the host portion. // address into 24 bits for the network portion and 8 bits for the host portion.
@ -660,14 +674,14 @@ type ClusterCIDRSpec struct {
// +required // +required
PerNodeHostBits int32 PerNodeHostBits int32
// IPv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8"). // ipv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8").
// At least one of IPv4 and IPv6 must be specified. // At least one of ipv4 and ipv6 must be specified.
// This field is immutable. // This field is immutable.
// +optional // +optional
IPv4 string IPv4 string
// IPv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64"). // ipv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64").
// At least one of IPv4 and IPv6 must be specified. // At least one of ipv4 and ipv6 must be specified.
// This field is immutable. // This field is immutable.
// +optional // +optional
IPv6 string IPv6 string
@ -682,6 +696,6 @@ type ClusterCIDRList struct {
// +optional // +optional
metav1.ListMeta metav1.ListMeta
// Items is the list of ClusterCIDRs. // items is the list of ClusterCIDRs.
Items []ClusterCIDR Items []ClusterCIDR
} }

200
pkg/generated/openapi/zz_generated.openapi.go generated
View File

@ -35843,14 +35843,14 @@ func schema_k8sio_api_networking_v1_HTTPIngressPath(ref common.ReferenceCallback
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"path": { "path": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\".", Description: "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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"pathType": { "pathType": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.\n\nPossible enum values:\n - `\"Exact\"` matches the URL path exactly and with case sensitivity.\n - `\"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.\n - `\"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.", Description: "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.\n\nPossible enum values:\n - `\"Exact\"` matches the URL path exactly and with case sensitivity.\n - `\"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.\n - `\"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.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
Enum: []interface{}{"Exact", "ImplementationSpecific", "Prefix"}, Enum: []interface{}{"Exact", "ImplementationSpecific", "Prefix"},
@ -35858,7 +35858,7 @@ func schema_k8sio_api_networking_v1_HTTPIngressPath(ref common.ReferenceCallback
}, },
"backend": { "backend": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Backend defines the referenced service endpoint to which the traffic will be forwarded to.", Description: "backend defines the referenced service endpoint to which the traffic will be forwarded to.",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1.IngressBackend"), Ref: ref("k8s.io/api/networking/v1.IngressBackend"),
}, },
@ -35886,7 +35886,7 @@ func schema_k8sio_api_networking_v1_HTTPIngressRuleValue(ref common.ReferenceCal
}, },
}, },
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "A collection of paths that map requests to backends.", Description: "paths is a collection of paths that map requests to backends.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -35916,7 +35916,7 @@ func schema_k8sio_api_networking_v1_IPBlock(ref common.ReferenceCallback) common
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"cidr": { "cidr": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "CIDR is a string representing the IP Block Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"", Description: "cidr is a string representing the IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -35924,7 +35924,7 @@ func schema_k8sio_api_networking_v1_IPBlock(ref common.ReferenceCallback) common
}, },
"except": { "except": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the CIDR range", Description: "except is a slice of CIDRs that should not be included within an IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the cidr range",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -35974,14 +35974,14 @@ func schema_k8sio_api_networking_v1_Ingress(ref common.ReferenceCallback) common
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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", Description: "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",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1.IngressSpec"), Ref: ref("k8s.io/api/networking/v1.IngressSpec"),
}, },
}, },
"status": { "status": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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", Description: "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",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1.IngressStatus"), Ref: ref("k8s.io/api/networking/v1.IngressStatus"),
}, },
@ -36003,13 +36003,13 @@ func schema_k8sio_api_networking_v1_IngressBackend(ref common.ReferenceCallback)
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"service": { "service": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Service references a Service as a Backend. This is a mutually exclusive setting with \"Resource\".", Description: "service references a service as a backend. This is a mutually exclusive setting with \"Resource\".",
Ref: ref("k8s.io/api/networking/v1.IngressServiceBackend"), Ref: ref("k8s.io/api/networking/v1.IngressServiceBackend"),
}, },
}, },
"resource": { "resource": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\".", Description: "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\".",
Ref: ref("k8s.io/api/core/v1.TypedLocalObjectReference"), Ref: ref("k8s.io/api/core/v1.TypedLocalObjectReference"),
}, },
}, },
@ -36051,7 +36051,7 @@ func schema_k8sio_api_networking_v1_IngressClass(ref common.ReferenceCallback) c
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", Description: "spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1.IngressClassSpec"), Ref: ref("k8s.io/api/networking/v1.IngressClassSpec"),
}, },
@ -36094,7 +36094,7 @@ func schema_k8sio_api_networking_v1_IngressClassList(ref common.ReferenceCallbac
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is the list of IngressClasses.", Description: "items is the list of IngressClasses.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36124,14 +36124,14 @@ func schema_k8sio_api_networking_v1_IngressClassParametersReference(ref common.R
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"apiGroup": { "apiGroup": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", Description: "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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"kind": { "kind": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Kind is the type of resource being referenced.", Description: "kind is the type of resource being referenced.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -36139,7 +36139,7 @@ func schema_k8sio_api_networking_v1_IngressClassParametersReference(ref common.R
}, },
"name": { "name": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Name is the name of resource being referenced.", Description: "name is the name of resource being referenced.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -36147,14 +36147,14 @@ func schema_k8sio_api_networking_v1_IngressClassParametersReference(ref common.R
}, },
"scope": { "scope": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".", Description: "scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"namespace": { "namespace": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".", Description: "namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -36175,14 +36175,14 @@ func schema_k8sio_api_networking_v1_IngressClassSpec(ref common.ReferenceCallbac
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"controller": { "controller": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.", Description: "controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"parameters": { "parameters": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.", Description: "parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.",
Ref: ref("k8s.io/api/networking/v1.IngressClassParametersReference"), Ref: ref("k8s.io/api/networking/v1.IngressClassParametersReference"),
}, },
}, },
@ -36224,7 +36224,7 @@ func schema_k8sio_api_networking_v1_IngressList(ref common.ReferenceCallback) co
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is the list of Ingress.", Description: "items is the list of Ingress.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36254,14 +36254,14 @@ func schema_k8sio_api_networking_v1_IngressLoadBalancerIngress(ref common.Refere
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"ip": { "ip": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "IP is set for load-balancer ingress points that are IP based.", Description: "ip is set for load-balancer ingress points that are IP based.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"hostname": { "hostname": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Hostname is set for load-balancer ingress points that are DNS based.", Description: "hostname is set for load-balancer ingress points that are DNS based.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -36273,7 +36273,7 @@ func schema_k8sio_api_networking_v1_IngressLoadBalancerIngress(ref common.Refere
}, },
}, },
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Ports provides information about the ports exposed by this LoadBalancer.", Description: "ports provides information about the ports exposed by this LoadBalancer.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36302,7 +36302,7 @@ func schema_k8sio_api_networking_v1_IngressLoadBalancerStatus(ref common.Referen
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"ingress": { "ingress": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Ingress is a list containing ingress points for the load-balancer.", Description: "ingress is a list containing ingress points for the load-balancer.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36331,7 +36331,7 @@ func schema_k8sio_api_networking_v1_IngressPortStatus(ref common.ReferenceCallba
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"port": { "port": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Port is the port number of the ingress port.", Description: "port is the port number of the ingress port.",
Default: 0, Default: 0,
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
@ -36339,7 +36339,7 @@ func schema_k8sio_api_networking_v1_IngressPortStatus(ref common.ReferenceCallba
}, },
"protocol": { "protocol": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"\n\nPossible enum values:\n - `\"SCTP\"` is the SCTP protocol.\n - `\"TCP\"` is the TCP protocol.\n - `\"UDP\"` is the UDP protocol.", Description: "protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"\n\nPossible enum values:\n - `\"SCTP\"` is the SCTP protocol.\n - `\"TCP\"` is the TCP protocol.\n - `\"UDP\"` is the UDP protocol.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -36348,7 +36348,7 @@ func schema_k8sio_api_networking_v1_IngressPortStatus(ref common.ReferenceCallba
}, },
"error": { "error": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.", Description: "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -36369,7 +36369,7 @@ func schema_k8sio_api_networking_v1_IngressRule(ref common.ReferenceCallback) co
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"host": { "host": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nHost 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.", Description: "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nhost 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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -36416,7 +36416,7 @@ func schema_k8sio_api_networking_v1_IngressServiceBackend(ref common.ReferenceCa
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"name": { "name": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Name is the referenced service. The service must exist in the same namespace as the Ingress object.", Description: "name is the referenced service. The service must exist in the same namespace as the Ingress object.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -36424,7 +36424,7 @@ func schema_k8sio_api_networking_v1_IngressServiceBackend(ref common.ReferenceCa
}, },
"port": { "port": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Port of the referenced service. A port name or port number is required for a IngressServiceBackend.", Description: "port of the referenced service. A port name or port number is required for a IngressServiceBackend.",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1.ServiceBackendPort"), Ref: ref("k8s.io/api/networking/v1.ServiceBackendPort"),
}, },
@ -36447,14 +36447,14 @@ func schema_k8sio_api_networking_v1_IngressSpec(ref common.ReferenceCallback) co
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"ingressClassName": { "ingressClassName": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", Description: "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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"defaultBackend": { "defaultBackend": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", Description: "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.",
Ref: ref("k8s.io/api/networking/v1.IngressBackend"), Ref: ref("k8s.io/api/networking/v1.IngressBackend"),
}, },
}, },
@ -36465,7 +36465,7 @@ func schema_k8sio_api_networking_v1_IngressSpec(ref common.ReferenceCallback) co
}, },
}, },
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", 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: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36484,7 +36484,7 @@ func schema_k8sio_api_networking_v1_IngressSpec(ref common.ReferenceCallback) co
}, },
}, },
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.", 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: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36513,7 +36513,7 @@ func schema_k8sio_api_networking_v1_IngressStatus(ref common.ReferenceCallback)
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"loadBalancer": { "loadBalancer": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "LoadBalancer contains the current status of the load-balancer.", Description: "loadBalancer contains the current status of the load-balancer.",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1.IngressLoadBalancerStatus"), Ref: ref("k8s.io/api/networking/v1.IngressLoadBalancerStatus"),
}, },
@ -36530,7 +36530,7 @@ func schema_k8sio_api_networking_v1_IngressTLS(ref common.ReferenceCallback) com
return common.OpenAPIDefinition{ return common.OpenAPIDefinition{
Schema: spec.Schema{ Schema: spec.Schema{
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "IngressTLS describes the transport layer security associated with an Ingress.", Description: "IngressTLS describes the transport layer security associated with an ingress.",
Type: []string{"object"}, Type: []string{"object"},
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"hosts": { "hosts": {
@ -36540,7 +36540,7 @@ func schema_k8sio_api_networking_v1_IngressTLS(ref common.ReferenceCallback) com
}, },
}, },
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Hosts are 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.", Description: "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: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36555,7 +36555,7 @@ func schema_k8sio_api_networking_v1_IngressTLS(ref common.ReferenceCallback) com
}, },
"secretName": { "secretName": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", Description: "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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -36596,14 +36596,14 @@ func schema_k8sio_api_networking_v1_NetworkPolicy(ref common.ReferenceCallback)
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Specification of the desired behavior for this NetworkPolicy.", Description: "spec represents the specification of the desired behavior for this NetworkPolicy.",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1.NetworkPolicySpec"), Ref: ref("k8s.io/api/networking/v1.NetworkPolicySpec"),
}, },
}, },
"status": { "status": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Status is the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", Description: "status represents the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1.NetworkPolicyStatus"), Ref: ref("k8s.io/api/networking/v1.NetworkPolicyStatus"),
}, },
@ -36625,7 +36625,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicyEgressRule(ref common.Reference
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"ports": { "ports": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", Description: "ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36639,7 +36639,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicyEgressRule(ref common.Reference
}, },
"to": { "to": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.", Description: "to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36668,7 +36668,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicyIngressRule(ref common.Referenc
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"ports": { "ports": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", Description: "ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36682,7 +36682,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicyIngressRule(ref common.Referenc
}, },
"from": { "from": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.", Description: "from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36732,7 +36732,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicyList(ref common.ReferenceCallba
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is a list of schema objects.", Description: "items is a list of schema objects.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36762,19 +36762,19 @@ func schema_k8sio_api_networking_v1_NetworkPolicyPeer(ref common.ReferenceCallba
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"podSelector": { "podSelector": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.", Description: "podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace.",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"),
}, },
}, },
"namespaceSelector": { "namespaceSelector": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.", Description: "namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector.",
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"),
}, },
}, },
"ipBlock": { "ipBlock": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.", Description: "ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.",
Ref: ref("k8s.io/api/networking/v1.IPBlock"), Ref: ref("k8s.io/api/networking/v1.IPBlock"),
}, },
}, },
@ -36795,7 +36795,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicyPort(ref common.ReferenceCallba
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"protocol": { "protocol": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.\n\nPossible enum values:\n - `\"SCTP\"` is the SCTP protocol.\n - `\"TCP\"` is the TCP protocol.\n - `\"UDP\"` is the UDP protocol.", Description: "protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.\n\nPossible enum values:\n - `\"SCTP\"` is the SCTP protocol.\n - `\"TCP\"` is the TCP protocol.\n - `\"UDP\"` is the UDP protocol.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
Enum: []interface{}{"SCTP", "TCP", "UDP"}, Enum: []interface{}{"SCTP", "TCP", "UDP"},
@ -36803,13 +36803,13 @@ func schema_k8sio_api_networking_v1_NetworkPolicyPort(ref common.ReferenceCallba
}, },
"port": { "port": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.", Description: "port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.",
Ref: ref("k8s.io/apimachinery/pkg/util/intstr.IntOrString"), Ref: ref("k8s.io/apimachinery/pkg/util/intstr.IntOrString"),
}, },
}, },
"endPort": { "endPort": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.", Description: "endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },
@ -36831,14 +36831,14 @@ func schema_k8sio_api_networking_v1_NetworkPolicySpec(ref common.ReferenceCallba
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"podSelector": { "podSelector": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.", Description: "podSelector selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"), Ref: ref("k8s.io/apimachinery/pkg/apis/meta/v1.LabelSelector"),
}, },
}, },
"ingress": { "ingress": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)", Description: "ingress is a list of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36852,7 +36852,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicySpec(ref common.ReferenceCallba
}, },
"egress": { "egress": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8", Description: "egress is a list of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36866,7 +36866,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicySpec(ref common.ReferenceCallba
}, },
"policyTypes": { "policyTypes": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "List of rule types that the NetworkPolicy relates to. Valid options are [\"Ingress\"], [\"Egress\"], or [\"Ingress\", \"Egress\"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an Egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8", Description: "policyTypes is a list of rule types that the NetworkPolicy relates to. Valid options are [\"Ingress\"], [\"Egress\"], or [\"Ingress\", \"Egress\"]. If this field is not specified, it will default based on the existence of ingress or egress rules; policies that contain an egress section are assumed to affect egress, and all policies (whether or not they contain an ingress section) are assumed to affect ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36892,7 +36892,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicyStatus(ref common.ReferenceCall
return common.OpenAPIDefinition{ return common.OpenAPIDefinition{
Schema: spec.Schema{ Schema: spec.Schema{
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "NetworkPolicyStatus describe the current state of the NetworkPolicy.", Description: "NetworkPolicyStatus describes the current state of the NetworkPolicy.",
Type: []string{"object"}, Type: []string{"object"},
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"conditions": { "conditions": {
@ -36907,7 +36907,7 @@ func schema_k8sio_api_networking_v1_NetworkPolicyStatus(ref common.ReferenceCall
}, },
}, },
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state", Description: "conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -36936,14 +36936,14 @@ func schema_k8sio_api_networking_v1_ServiceBackendPort(ref common.ReferenceCallb
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"name": { "name": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".", Description: "name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"number": { "number": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".", Description: "number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".",
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
}, },
@ -36984,7 +36984,7 @@ func schema_k8sio_api_networking_v1alpha1_ClusterCIDR(ref common.ReferenceCallba
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", Description: "spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1alpha1.ClusterCIDRSpec"), Ref: ref("k8s.io/api/networking/v1alpha1.ClusterCIDRSpec"),
}, },
@ -37027,7 +37027,7 @@ func schema_k8sio_api_networking_v1alpha1_ClusterCIDRList(ref common.ReferenceCa
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is the list of ClusterCIDRs.", Description: "items is the list of ClusterCIDRs.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37057,13 +37057,13 @@ func schema_k8sio_api_networking_v1alpha1_ClusterCIDRSpec(ref common.ReferenceCa
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"nodeSelector": { "nodeSelector": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "NodeSelector defines which nodes the config is applicable to. An empty or nil NodeSelector selects all nodes. This field is immutable.", Description: "nodeSelector defines which nodes the config is applicable to. An empty or nil nodeSelector selects all nodes. This field is immutable.",
Ref: ref("k8s.io/api/core/v1.NodeSelector"), Ref: ref("k8s.io/api/core/v1.NodeSelector"),
}, },
}, },
"perNodeHostBits": { "perNodeHostBits": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "PerNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.", Description: "perNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.",
Default: 0, Default: 0,
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
@ -37071,7 +37071,7 @@ func schema_k8sio_api_networking_v1alpha1_ClusterCIDRSpec(ref common.ReferenceCa
}, },
"ipv4": { "ipv4": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "IPv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.", Description: "ipv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -37079,7 +37079,7 @@ func schema_k8sio_api_networking_v1alpha1_ClusterCIDRSpec(ref common.ReferenceCa
}, },
"ipv6": { "ipv6": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "IPv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.", Description: "ipv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -37103,21 +37103,21 @@ func schema_k8sio_api_networking_v1beta1_HTTPIngressPath(ref common.ReferenceCal
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"path": { "path": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\".", Description: "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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"pathType": { "pathType": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types. Defaults to ImplementationSpecific.", Description: "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types. Defaults to ImplementationSpecific.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"backend": { "backend": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Backend defines the referenced service endpoint to which the traffic will be forwarded to.", Description: "backend defines the referenced service endpoint to which the traffic will be forwarded to.",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1beta1.IngressBackend"), Ref: ref("k8s.io/api/networking/v1beta1.IngressBackend"),
}, },
@ -37140,7 +37140,7 @@ func schema_k8sio_api_networking_v1beta1_HTTPIngressRuleValue(ref common.Referen
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"paths": { "paths": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "A collection of paths that map requests to backends.", Description: "paths is a collection of paths that map requests to backends.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37191,14 +37191,14 @@ func schema_k8sio_api_networking_v1beta1_Ingress(ref common.ReferenceCallback) c
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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", Description: "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",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1beta1.IngressSpec"), Ref: ref("k8s.io/api/networking/v1beta1.IngressSpec"),
}, },
}, },
"status": { "status": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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", Description: "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",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1beta1.IngressStatus"), Ref: ref("k8s.io/api/networking/v1beta1.IngressStatus"),
}, },
@ -37220,21 +37220,21 @@ func schema_k8sio_api_networking_v1beta1_IngressBackend(ref common.ReferenceCall
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"serviceName": { "serviceName": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Specifies the name of the referenced service.", Description: "serviceName specifies the name of the referenced service.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"servicePort": { "servicePort": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Specifies the port of the referenced service.", Description: "servicePort Specifies the port of the referenced service.",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/apimachinery/pkg/util/intstr.IntOrString"), Ref: ref("k8s.io/apimachinery/pkg/util/intstr.IntOrString"),
}, },
}, },
"resource": { "resource": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.", Description: "resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.",
Ref: ref("k8s.io/api/core/v1.TypedLocalObjectReference"), Ref: ref("k8s.io/api/core/v1.TypedLocalObjectReference"),
}, },
}, },
@ -37276,7 +37276,7 @@ func schema_k8sio_api_networking_v1beta1_IngressClass(ref common.ReferenceCallba
}, },
"spec": { "spec": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", Description: "spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1beta1.IngressClassSpec"), Ref: ref("k8s.io/api/networking/v1beta1.IngressClassSpec"),
}, },
@ -37319,7 +37319,7 @@ func schema_k8sio_api_networking_v1beta1_IngressClassList(ref common.ReferenceCa
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is the list of IngressClasses.", Description: "items is the list of IngressClasses.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37349,14 +37349,14 @@ func schema_k8sio_api_networking_v1beta1_IngressClassParametersReference(ref com
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"apiGroup": { "apiGroup": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", Description: "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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"kind": { "kind": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Kind is the type of resource being referenced.", Description: "kind is the type of resource being referenced.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -37364,7 +37364,7 @@ func schema_k8sio_api_networking_v1beta1_IngressClassParametersReference(ref com
}, },
"name": { "name": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Name is the name of resource being referenced.", Description: "name is the name of resource being referenced.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -37372,14 +37372,14 @@ func schema_k8sio_api_networking_v1beta1_IngressClassParametersReference(ref com
}, },
"scope": { "scope": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".", Description: "scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"namespace": { "namespace": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".", Description: "namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -37400,14 +37400,14 @@ func schema_k8sio_api_networking_v1beta1_IngressClassSpec(ref common.ReferenceCa
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"controller": { "controller": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.", Description: "controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"parameters": { "parameters": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.", Description: "parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.",
Ref: ref("k8s.io/api/networking/v1beta1.IngressClassParametersReference"), Ref: ref("k8s.io/api/networking/v1beta1.IngressClassParametersReference"),
}, },
}, },
@ -37449,7 +37449,7 @@ func schema_k8sio_api_networking_v1beta1_IngressList(ref common.ReferenceCallbac
}, },
"items": { "items": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Items is the list of Ingress.", Description: "items is the list of Ingress.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37479,14 +37479,14 @@ func schema_k8sio_api_networking_v1beta1_IngressLoadBalancerIngress(ref common.R
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"ip": { "ip": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "IP is set for load-balancer ingress points that are IP based.", Description: "ip is set for load-balancer ingress points that are IP based.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"hostname": { "hostname": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Hostname is set for load-balancer ingress points that are DNS based.", Description: "hostname is set for load-balancer ingress points that are DNS based.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -37498,7 +37498,7 @@ func schema_k8sio_api_networking_v1beta1_IngressLoadBalancerIngress(ref common.R
}, },
}, },
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Ports provides information about the ports exposed by this LoadBalancer.", Description: "ports provides information about the ports exposed by this LoadBalancer.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37527,7 +37527,7 @@ func schema_k8sio_api_networking_v1beta1_IngressLoadBalancerStatus(ref common.Re
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"ingress": { "ingress": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Ingress is a list containing ingress points for the load-balancer.", Description: "ingress is a list containing ingress points for the load-balancer.",
Type: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37556,7 +37556,7 @@ func schema_k8sio_api_networking_v1beta1_IngressPortStatus(ref common.ReferenceC
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"port": { "port": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Port is the port number of the ingress port.", Description: "port is the port number of the ingress port.",
Default: 0, Default: 0,
Type: []string{"integer"}, Type: []string{"integer"},
Format: "int32", Format: "int32",
@ -37564,7 +37564,7 @@ func schema_k8sio_api_networking_v1beta1_IngressPortStatus(ref common.ReferenceC
}, },
"protocol": { "protocol": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"\n\nPossible enum values:\n - `\"SCTP\"` is the SCTP protocol.\n - `\"TCP\"` is the TCP protocol.\n - `\"UDP\"` is the UDP protocol.", Description: "protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"\n\nPossible enum values:\n - `\"SCTP\"` is the SCTP protocol.\n - `\"TCP\"` is the TCP protocol.\n - `\"UDP\"` is the UDP protocol.",
Default: "", Default: "",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
@ -37573,7 +37573,7 @@ func schema_k8sio_api_networking_v1beta1_IngressPortStatus(ref common.ReferenceC
}, },
"error": { "error": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.", Description: "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -37594,7 +37594,7 @@ func schema_k8sio_api_networking_v1beta1_IngressRule(ref common.ReferenceCallbac
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"host": { "host": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nHost 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.", Description: "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nhost 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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
@ -37641,20 +37641,20 @@ func schema_k8sio_api_networking_v1beta1_IngressSpec(ref common.ReferenceCallbac
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"ingressClassName": { "ingressClassName": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", Description: "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.",
Type: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },
}, },
"backend": { "backend": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.", Description: "backend is the default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.",
Ref: ref("k8s.io/api/networking/v1beta1.IngressBackend"), Ref: ref("k8s.io/api/networking/v1beta1.IngressBackend"),
}, },
}, },
"tls": { "tls": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", 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: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37668,7 +37668,7 @@ func schema_k8sio_api_networking_v1beta1_IngressSpec(ref common.ReferenceCallbac
}, },
"rules": { "rules": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.", 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: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37692,12 +37692,12 @@ func schema_k8sio_api_networking_v1beta1_IngressStatus(ref common.ReferenceCallb
return common.OpenAPIDefinition{ return common.OpenAPIDefinition{
Schema: spec.Schema{ Schema: spec.Schema{
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "IngressStatus describe the current state of the Ingress.", Description: "IngressStatus describes the current state of the Ingress.",
Type: []string{"object"}, Type: []string{"object"},
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"loadBalancer": { "loadBalancer": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "LoadBalancer contains the current status of the load-balancer.", Description: "loadBalancer contains the current status of the load-balancer.",
Default: map[string]interface{}{}, Default: map[string]interface{}{},
Ref: ref("k8s.io/api/networking/v1beta1.IngressLoadBalancerStatus"), Ref: ref("k8s.io/api/networking/v1beta1.IngressLoadBalancerStatus"),
}, },
@ -37719,7 +37719,7 @@ func schema_k8sio_api_networking_v1beta1_IngressTLS(ref common.ReferenceCallback
Properties: map[string]spec.Schema{ Properties: map[string]spec.Schema{
"hosts": { "hosts": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "Hosts are 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.", Description: "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: []string{"array"}, Type: []string{"array"},
Items: &spec.SchemaOrArray{ Items: &spec.SchemaOrArray{
Schema: &spec.Schema{ Schema: &spec.Schema{
@ -37734,7 +37734,7 @@ func schema_k8sio_api_networking_v1beta1_IngressTLS(ref common.ReferenceCallback
}, },
"secretName": { "secretName": {
SchemaProps: spec.SchemaProps{ SchemaProps: spec.SchemaProps{
Description: "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.", Description: "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: []string{"string"}, Type: []string{"string"},
Format: "", Format: "",
}, },

176
staging/src/k8s.io/api/networking/v1/generated.proto
View File

@ -33,14 +33,14 @@ option go_package = "k8s.io/api/networking/v1";
// HTTPIngressPath associates a path with a backend. Incoming urls matching the // HTTPIngressPath associates a path with a backend. Incoming urls matching the
// path are forwarded to the backend. // path are forwarded to the backend.
message HTTPIngressPath { message HTTPIngressPath {
// Path is matched against the path of an incoming request. Currently it can // path is matched against the path of an incoming request. Currently it can
// contain characters disallowed from the conventional "path" part of a URL // 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 // as defined by RFC 3986. Paths must begin with a '/' and must be present
// when using PathType with value "Exact" or "Prefix". // when using PathType with value "Exact" or "Prefix".
// +optional // +optional
optional string path = 1; optional string path = 1;
// PathType determines the interpretation of the Path matching. PathType can // pathType determines the interpretation of the path matching. PathType can
// be one of the following values: // be one of the following values:
// * Exact: Matches the URL path exactly. // * Exact: Matches the URL path exactly.
// * Prefix: Matches based on a URL path prefix split by '/'. Matching is // * Prefix: Matches based on a URL path prefix split by '/'. Matching is
@ -56,7 +56,7 @@ message HTTPIngressPath {
// Implementations are required to support all path types. // Implementations are required to support all path types.
optional string pathType = 3; optional string pathType = 3;
// Backend defines the referenced service endpoint to which the traffic // backend defines the referenced service endpoint to which the traffic
// will be forwarded to. // will be forwarded to.
optional IngressBackend backend = 2; optional IngressBackend backend = 2;
} }
@ -67,7 +67,7 @@ message HTTPIngressPath {
// to match against everything after the last '/' and before the first '?' // to match against everything after the last '/' and before the first '?'
// or '#'. // or '#'.
message HTTPIngressRuleValue { message HTTPIngressRuleValue {
// A collection of paths that map requests to backends. // paths is a collection of paths that map requests to backends.
// +listType=atomic // +listType=atomic
repeated HTTPIngressPath paths = 1; repeated HTTPIngressPath paths = 1;
} }
@ -76,13 +76,13 @@ message HTTPIngressRuleValue {
// to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs // to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs
// that should not be included within this rule. // that should not be included within this rule.
message IPBlock { message IPBlock {
// CIDR is a string representing the IP Block // cidr is a string representing the IPBlock
// Valid examples are "192.168.1.0/24" or "2001:db8::/64" // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
optional string cidr = 1; optional string cidr = 1;
// Except is a slice of CIDRs that should not be included within an IP Block // except is a slice of CIDRs that should not be included within an IPBlock
// Valid examples are "192.168.1.0/24" or "2001:db8::/64" // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
// Except values will be rejected if they are outside the CIDR range // Except values will be rejected if they are outside the cidr range
// +optional // +optional
repeated string except = 2; repeated string except = 2;
} }
@ -97,12 +97,12 @@ message Ingress {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is the desired state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional IngressSpec spec = 2; optional IngressSpec spec = 2;
// Status is the current state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional IngressStatus status = 3; optional IngressStatus status = 3;
@ -110,12 +110,12 @@ message Ingress {
// IngressBackend describes all endpoints for a given service and port. // IngressBackend describes all endpoints for a given service and port.
message IngressBackend { message IngressBackend {
// Service references a Service as a Backend. // service references a service as a backend.
// This is a mutually exclusive setting with "Resource". // This is a mutually exclusive setting with "Resource".
// +optional // +optional
optional IngressServiceBackend service = 4; optional IngressServiceBackend service = 4;
// Resource is an ObjectRef to another Kubernetes resource in the namespace // resource is an ObjectRef to another Kubernetes resource in the namespace
// of the Ingress object. If resource is specified, a service.Name and // of the Ingress object. If resource is specified, a service.Name and
// service.Port must not be specified. // service.Port must not be specified.
// This is a mutually exclusive setting with "Service". // This is a mutually exclusive setting with "Service".
@ -134,7 +134,7 @@ message IngressClass {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is the desired state of the IngressClass. // spec is the desired state of the IngressClass.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional IngressClassSpec spec = 2; optional IngressClassSpec spec = 2;
@ -146,31 +146,31 @@ message IngressClassList {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of IngressClasses. // items is the list of IngressClasses.
repeated IngressClass items = 2; repeated IngressClass items = 2;
} }
// IngressClassParametersReference identifies an API object. This can be used // IngressClassParametersReference identifies an API object. This can be used
// to specify a cluster or namespace-scoped resource. // to specify a cluster or namespace-scoped resource.
message IngressClassParametersReference { message IngressClassParametersReference {
// APIGroup is the group for the resource being referenced. If APIGroup is // 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 // not specified, the specified Kind must be in the core API group. For any
// other third-party types, APIGroup is required. // other third-party types, APIGroup is required.
// +optional // +optional
optional string aPIGroup = 1; optional string aPIGroup = 1;
// Kind is the type of resource being referenced. // kind is the type of resource being referenced.
optional string kind = 2; optional string kind = 2;
// Name is the name of resource being referenced. // name is the name of resource being referenced.
optional string name = 3; optional string name = 3;
// Scope represents if this refers to a cluster or namespace scoped resource. // scope represents if this refers to a cluster or namespace scoped resource.
// This may be set to "Cluster" (default) or "Namespace". // This may be set to "Cluster" (default) or "Namespace".
// +optional // +optional
optional string scope = 4; optional string scope = 4;
// Namespace is the namespace of the resource being referenced. This field is // namespace is the namespace of the resource being referenced. This field is
// required when scope is set to "Namespace" and must be unset when scope is set to // required when scope is set to "Namespace" and must be unset when scope is set to
// "Cluster". // "Cluster".
// +optional // +optional
@ -179,15 +179,15 @@ message IngressClassParametersReference {
// IngressClassSpec provides information about the class of an Ingress. // IngressClassSpec provides information about the class of an Ingress.
message IngressClassSpec { message IngressClassSpec {
// Controller refers to the name of the controller that should handle this // controller refers to the name of the controller that should handle this
// class. This allows for different "flavors" that are controlled by the // class. This allows for different "flavors" that are controlled by the
// same controller. For example, you may have different Parameters for the // same controller. For example, you may have different parameters for the
// same implementing controller. This should be specified as a // same implementing controller. This should be specified as a
// domain-prefixed path no more than 250 characters in length, e.g. // domain-prefixed path no more than 250 characters in length, e.g.
// "acme.io/ingress-controller". This field is immutable. // "acme.io/ingress-controller". This field is immutable.
optional string controller = 1; optional string controller = 1;
// Parameters is a link to a custom resource containing additional // parameters is a link to a custom resource containing additional
// configuration for the controller. This is optional if the controller does // configuration for the controller. This is optional if the controller does
// not require extra parameters. // not require extra parameters.
// +optional // +optional
@ -201,21 +201,21 @@ message IngressList {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of Ingress. // items is the list of Ingress.
repeated Ingress items = 2; repeated Ingress items = 2;
} }
// IngressLoadBalancerIngress represents the status of a load-balancer ingress point. // IngressLoadBalancerIngress represents the status of a load-balancer ingress point.
message IngressLoadBalancerIngress { message IngressLoadBalancerIngress {
// IP is set for load-balancer ingress points that are IP based. // ip is set for load-balancer ingress points that are IP based.
// +optional // +optional
optional string ip = 1; optional string ip = 1;
// Hostname is set for load-balancer ingress points that are DNS based. // hostname is set for load-balancer ingress points that are DNS based.
// +optional // +optional
optional string hostname = 2; optional string hostname = 2;
// Ports provides information about the ports exposed by this LoadBalancer. // ports provides information about the ports exposed by this LoadBalancer.
// +listType=atomic // +listType=atomic
// +optional // +optional
repeated IngressPortStatus ports = 4; repeated IngressPortStatus ports = 4;
@ -223,21 +223,21 @@ message IngressLoadBalancerIngress {
// IngressLoadBalancerStatus represents the status of a load-balancer. // IngressLoadBalancerStatus represents the status of a load-balancer.
message IngressLoadBalancerStatus { message IngressLoadBalancerStatus {
// Ingress is a list containing ingress points for the load-balancer. // ingress is a list containing ingress points for the load-balancer.
// +optional // +optional
repeated IngressLoadBalancerIngress ingress = 1; repeated IngressLoadBalancerIngress ingress = 1;
} }
// IngressPortStatus represents the error condition of a service port // IngressPortStatus represents the error condition of a service port
message IngressPortStatus { message IngressPortStatus {
// Port is the port number of the ingress port. // port is the port number of the ingress port.
optional int32 port = 1; optional int32 port = 1;
// Protocol is the protocol of the ingress port. // protocol is the protocol of the ingress port.
// The supported values are: "TCP", "UDP", "SCTP" // The supported values are: "TCP", "UDP", "SCTP"
optional string protocol = 2; optional string protocol = 2;
// Error is to record the problem with the service port // error is to record the problem with the service port
// The format of the error shall comply with the following rules: // 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 // - built-in error values shall be specified in this file and those shall use
// CamelCase names // CamelCase names
@ -256,7 +256,7 @@ message IngressPortStatus {
// the related backend services. Incoming requests are first evaluated for a host // the related backend services. Incoming requests are first evaluated for a host
// match, then routed to the backend associated with the matching IngressRuleValue. // match, then routed to the backend associated with the matching IngressRuleValue.
message IngressRule { message IngressRule {
// Host is the fully qualified domain name of a network host, as defined by RFC 3986. // 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 // Note the following deviations from the "host" part of the
// URI as defined in RFC 3986: // URI as defined in RFC 3986:
// 1. IPs are not allowed. Currently an IngressRuleValue can only apply to // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
@ -269,14 +269,14 @@ message IngressRule {
// IngressRuleValue. If the host is unspecified, the Ingress routes all // IngressRuleValue. If the host is unspecified, the Ingress routes all
// traffic based on the specified IngressRuleValue. // traffic based on the specified IngressRuleValue.
// //
// Host can be "precise" which is a domain name without the terminating dot of // 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 // 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"). // prefixed with a single wildcard label (e.g. "*.foo.com").
// The wildcard character '*' must appear by itself as the first DNS label and // 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 == "*"). // 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: // 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. // 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 // 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. // is to equal to the suffix (removing the first label) of the wildcard rule.
// +optional // +optional
optional string host = 1; optional string host = 1;
@ -301,18 +301,18 @@ message IngressRuleValue {
// IngressServiceBackend references a Kubernetes Service as a Backend. // IngressServiceBackend references a Kubernetes Service as a Backend.
message IngressServiceBackend { message IngressServiceBackend {
// Name is the referenced service. The service must exist in // name is the referenced service. The service must exist in
// the same namespace as the Ingress object. // the same namespace as the Ingress object.
optional string name = 1; optional string name = 1;
// Port of the referenced service. A port name or port number // port of the referenced service. A port name or port number
// is required for a IngressServiceBackend. // is required for a IngressServiceBackend.
optional ServiceBackendPort port = 2; optional ServiceBackendPort port = 2;
} }
// IngressSpec describes the Ingress the user wishes to exist. // IngressSpec describes the Ingress the user wishes to exist.
message IngressSpec { message IngressSpec {
// IngressClassName is the name of an IngressClass cluster resource. Ingress // ingressClassName is the name of an IngressClass cluster resource. Ingress
// controller implementations use this field to know whether they should be // controller implementations use this field to know whether they should be
// serving this Ingress resource, by a transitive connection // serving this Ingress resource, by a transitive connection
// (controller -> IngressClass -> Ingress resource). Although the // (controller -> IngressClass -> Ingress resource). Although the
@ -325,24 +325,24 @@ message IngressSpec {
// +optional // +optional
optional string ingressClassName = 4; optional string ingressClassName = 4;
// DefaultBackend is the backend that should handle requests that don't // defaultBackend is the backend that should handle requests that don't
// match any rule. If Rules are not specified, DefaultBackend must be specified. // 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 // If DefaultBackend is not set, the handling of requests that do not match any
// of the rules will be up to the Ingress controller. // of the rules will be up to the Ingress controller.
// +optional // +optional
optional IngressBackend defaultBackend = 1; optional IngressBackend defaultBackend = 1;
// TLS configuration. Currently the Ingress only supports a single TLS // tls represents the TLS configuration. Currently the Ingress only supports a
// port, 443. If multiple members of this list specify different hosts, they // single TLS port, 443. If multiple members of this list specify different hosts,
// will be multiplexed on the same port according to the hostname specified // they will be multiplexed on the same port according to the hostname specified
// through the SNI TLS extension, if the ingress controller fulfilling the // through the SNI TLS extension, if the ingress controller fulfilling the
// ingress supports SNI. // ingress supports SNI.
// +listType=atomic // +listType=atomic
// +optional // +optional
repeated IngressTLS tls = 2; repeated IngressTLS tls = 2;
// A list of host rules used to configure the Ingress. If unspecified, or // rules is a list of host rules used to configure the Ingress. If unspecified,
// no rule matches, all traffic is sent to the default backend. // or no rule matches, all traffic is sent to the default backend.
// +listType=atomic // +listType=atomic
// +optional // +optional
repeated IngressRule rules = 3; repeated IngressRule rules = 3;
@ -350,14 +350,14 @@ message IngressSpec {
// IngressStatus describe the current state of the Ingress. // IngressStatus describe the current state of the Ingress.
message IngressStatus { message IngressStatus {
// LoadBalancer contains the current status of the load-balancer. // loadBalancer contains the current status of the load-balancer.
// +optional // +optional
optional IngressLoadBalancerStatus loadBalancer = 1; optional IngressLoadBalancerStatus loadBalancer = 1;
} }
// IngressTLS describes the transport layer security associated with an Ingress. // IngressTLS describes the transport layer security associated with an ingress.
message IngressTLS { message IngressTLS {
// Hosts are a list of hosts included in the TLS certificate. The values in // 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 // this list must match the name/s used in the tlsSecret. Defaults to the
// wildcard host setting for the loadbalancer controller fulfilling this // wildcard host setting for the loadbalancer controller fulfilling this
// Ingress, if left unspecified. // Ingress, if left unspecified.
@ -365,11 +365,11 @@ message IngressTLS {
// +optional // +optional
repeated string hosts = 1; repeated string hosts = 1;
// SecretName is the name of the secret used to terminate TLS traffic on // 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 // 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" // 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 // header field used by an IngressRule, the SNI host is used for termination
// and value of the Host header is used for routing. // and value of the "Host" header is used for routing.
// +optional // +optional
optional string secretName = 2; optional string secretName = 2;
} }
@ -381,11 +381,11 @@ message NetworkPolicy {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Specification of the desired behavior for this NetworkPolicy. // spec represents the specification of the desired behavior for this NetworkPolicy.
// +optional // +optional
optional NetworkPolicySpec spec = 2; optional NetworkPolicySpec spec = 2;
// Status is the current state of the NetworkPolicy. // status represents the current state of the NetworkPolicy.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional NetworkPolicyStatus status = 3; optional NetworkPolicyStatus status = 3;
@ -395,7 +395,7 @@ message NetworkPolicy {
// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. // matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to.
// This type is beta-level in 1.8 // This type is beta-level in 1.8
message NetworkPolicyEgressRule { message NetworkPolicyEgressRule {
// List of destination ports for outgoing traffic. // ports is a list of destination ports for outgoing traffic.
// Each item in this list is combined using a logical OR. If this field is // Each item in this list is combined using a logical OR. If this field is
// empty or missing, this rule matches all ports (traffic not restricted by port). // empty or missing, this rule matches all ports (traffic not restricted by port).
// If this field is present and contains at least one item, then this rule allows // If this field is present and contains at least one item, then this rule allows
@ -403,7 +403,7 @@ message NetworkPolicyEgressRule {
// +optional // +optional
repeated NetworkPolicyPort ports = 1; repeated NetworkPolicyPort ports = 1;
// List of destinations for outgoing traffic of pods selected for this rule. // to is a list of destinations for outgoing traffic of pods selected for this rule.
// Items in this list are combined using a logical OR operation. If this field is // Items in this list are combined using a logical OR operation. If this field is
// empty or missing, this rule matches all destinations (traffic not restricted by // empty or missing, this rule matches all destinations (traffic not restricted by
// destination). If this field is present and contains at least one item, this rule // destination). If this field is present and contains at least one item, this rule
@ -415,15 +415,15 @@ message NetworkPolicyEgressRule {
// NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods // NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods
// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. // matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.
message NetworkPolicyIngressRule { message NetworkPolicyIngressRule {
// List of ports which should be made accessible on the pods selected for this // ports is a list of ports which should be made accessible on the pods selected for
// rule. Each item in this list is combined using a logical OR. If this field is // this rule. Each item in this list is combined using a logical OR. If this field is
// empty or missing, this rule matches all ports (traffic not restricted by port). // empty or missing, this rule matches all ports (traffic not restricted by port).
// If this field is present and contains at least one item, then this rule allows // If this field is present and contains at least one item, then this rule allows
// traffic only if the traffic matches at least one port in the list. // traffic only if the traffic matches at least one port in the list.
// +optional // +optional
repeated NetworkPolicyPort ports = 1; repeated NetworkPolicyPort ports = 1;
// List of sources which should be able to access the pods selected for this rule. // from is a list of sources which should be able to access the pods selected for this rule.
// Items in this list are combined using a logical OR operation. If this field is // Items in this list are combined using a logical OR operation. If this field is
// empty or missing, this rule matches all sources (traffic not restricted by // empty or missing, this rule matches all sources (traffic not restricted by
// source). If this field is present and contains at least one item, this rule // source). If this field is present and contains at least one item, this rule
@ -439,32 +439,32 @@ message NetworkPolicyList {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is a list of schema objects. // items is a list of schema objects.
repeated NetworkPolicy items = 2; repeated NetworkPolicy items = 2;
} }
// NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of // NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of
// fields are allowed // fields are allowed
message NetworkPolicyPeer { message NetworkPolicyPeer {
// This is a label selector which selects Pods. This field follows standard label // podSelector is a label selector which selects pods. This field follows standard label
// selector semantics; if present but empty, it selects all pods. // selector semantics; if present but empty, it selects all pods.
// //
// If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects // If namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
// the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. // the pods matching podSelector in the Namespaces selected by NamespaceSelector.
// Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. // Otherwise it selects the pods matching podSelector in the policy's own namespace.
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1;
// Selects Namespaces using cluster-scoped labels. This field follows standard label // namespaceSelector selects namespaces using cluster-scoped labels. This field follows
// selector semantics; if present but empty, it selects all namespaces. // standard label selector semantics; if present but empty, it selects all namespaces.
// //
// If PodSelector is also set, then the NetworkPolicyPeer as a whole selects // If podSelector is also set, then the NetworkPolicyPeer as a whole selects
// the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. // the pods matching podSelector in the namespaces selected by namespaceSelector.
// Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. // Otherwise it selects all pods in the namespaces selected by namespaceSelector.
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 2; optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector namespaceSelector = 2;
// IPBlock defines policy on a particular IPBlock. If this field is set then // ipBlock defines policy on a particular IPBlock. If this field is set then
// neither of the other fields can be. // neither of the other fields can be.
// +optional // +optional
optional IPBlock ipBlock = 3; optional IPBlock ipBlock = 3;
@ -472,19 +472,19 @@ message NetworkPolicyPeer {
// NetworkPolicyPort describes a port to allow traffic on // NetworkPolicyPort describes a port to allow traffic on
message NetworkPolicyPort { message NetworkPolicyPort {
// The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this // protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match.
// field defaults to TCP. // If not specified, this field defaults to TCP.
// +optional // +optional
optional string protocol = 1; optional string protocol = 1;
// The port on the given protocol. This can either be a numerical or named // port represents the port on the given protocol. This can either be a numerical or named
// port on a pod. If this field is not provided, this matches all port names and // port on a pod. If this field is not provided, this matches all port names and
// numbers. // numbers.
// If present, only traffic on the specified protocol AND port will be matched. // If present, only traffic on the specified protocol AND port will be matched.
// +optional // +optional
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 2; optional k8s.io.apimachinery.pkg.util.intstr.IntOrString port = 2;
// If set, indicates that the range of ports from port to endPort, inclusive, // endPort indicates that the range of ports from port to endPort if set, inclusive,
// should be allowed by the policy. This field cannot be defined if the port field // should be allowed by the policy. This field cannot be defined if the port field
// is not defined or if the port field is defined as a named (string) port. // is not defined or if the port field is defined as a named (string) port.
// The endPort must be equal or greater than port. // The endPort must be equal or greater than port.
@ -494,16 +494,16 @@ message NetworkPolicyPort {
// NetworkPolicySpec provides the specification of a NetworkPolicy // NetworkPolicySpec provides the specification of a NetworkPolicy
message NetworkPolicySpec { message NetworkPolicySpec {
// Selects the pods to which this NetworkPolicy object applies. The array of // podSelector selects the pods to which this NetworkPolicy object applies.
// ingress rules is applied to any pods selected by this field. Multiple network // The array of ingress rules is applied to any pods selected by this field.
// policies can select the same set of pods. In this case, the ingress rules for // Multiple network policies can select the same set of pods. In this case,
// each are combined additively. This field is NOT optional and follows standard // the ingress rules for each are combined additively.
// label selector semantics. An empty podSelector matches all pods in this // This field is NOT optional and follows standard label selector semantics.
// namespace. // An empty podSelector matches all pods in this namespace.
optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector podSelector = 1;
// List of ingress rules to be applied to the selected pods. Traffic is allowed to // ingress is a list of ingress rules to be applied to the selected pods.
// a pod if there are no NetworkPolicies selecting the pod // Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod
// (and cluster policy otherwise allows the traffic), OR if the traffic source is // (and cluster policy otherwise allows the traffic), OR if the traffic source is
// the pod's local node, OR if the traffic matches at least one ingress rule // the pod's local node, OR if the traffic matches at least one ingress rule
// across all of the NetworkPolicy objects whose podSelector matches the pod. If // across all of the NetworkPolicy objects whose podSelector matches the pod. If
@ -512,8 +512,8 @@ message NetworkPolicySpec {
// +optional // +optional
repeated NetworkPolicyIngressRule ingress = 2; repeated NetworkPolicyIngressRule ingress = 2;
// List of egress rules to be applied to the selected pods. Outgoing traffic is // egress is a list of egress rules to be applied to the selected pods. Outgoing traffic
// allowed if there are no NetworkPolicies selecting the pod (and cluster policy // is allowed if there are no NetworkPolicies selecting the pod (and cluster policy
// otherwise allows the traffic), OR if the traffic matches at least one egress rule // otherwise allows the traffic), OR if the traffic matches at least one egress rule
// across all of the NetworkPolicy objects whose podSelector matches the pod. If // across all of the NetworkPolicy objects whose podSelector matches the pod. If
// this field is empty then this NetworkPolicy limits all outgoing traffic (and serves // this field is empty then this NetworkPolicy limits all outgoing traffic (and serves
@ -522,23 +522,23 @@ message NetworkPolicySpec {
// +optional // +optional
repeated NetworkPolicyEgressRule egress = 3; repeated NetworkPolicyEgressRule egress = 3;
// List of rule types that the NetworkPolicy relates to. // policyTypes is a list of rule types that the NetworkPolicy relates to.
// Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. // Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"].
// If this field is not specified, it will default based on the existence of Ingress or Egress rules; // If this field is not specified, it will default based on the existence of ingress or egress rules;
// policies that contain an Egress section are assumed to affect Egress, and all policies // policies that contain an egress section are assumed to affect egress, and all policies
// (whether or not they contain an Ingress section) are assumed to affect Ingress. // (whether or not they contain an ingress section) are assumed to affect ingress.
// If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. // If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
// Likewise, if you want to write a policy that specifies that no egress is allowed, // Likewise, if you want to write a policy that specifies that no egress is allowed,
// you must specify a policyTypes value that include "Egress" (since such a policy would not include // you must specify a policyTypes value that include "Egress" (since such a policy would not include
// an Egress section and would otherwise default to just [ "Ingress" ]). // an egress section and would otherwise default to just [ "Ingress" ]).
// This field is beta-level in 1.8 // This field is beta-level in 1.8
// +optional // +optional
repeated string policyTypes = 4; repeated string policyTypes = 4;
} }
// NetworkPolicyStatus describe the current state of the NetworkPolicy. // NetworkPolicyStatus describes the current state of the NetworkPolicy.
message NetworkPolicyStatus { message NetworkPolicyStatus {
// Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. // conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy.
// Current service state // Current service state
// +optional // +optional
// +patchMergeKey=type // +patchMergeKey=type
@ -550,12 +550,12 @@ message NetworkPolicyStatus {
// ServiceBackendPort is the service port being referenced. // ServiceBackendPort is the service port being referenced.
message ServiceBackendPort { message ServiceBackendPort {
// Name is the name of the port on the Service. // name is the name of the port on the Service.
// This is a mutually exclusive setting with "Number". // This is a mutually exclusive setting with "Number".
// +optional // +optional
optional string name = 1; optional string name = 1;
// Number is the numerical port number (e.g. 80) on the Service. // number is the numerical port number (e.g. 80) on the Service.
// This is a mutually exclusive setting with "Name". // This is a mutually exclusive setting with "Name".
// +optional // +optional
optional int32 number = 2; optional int32 number = 2;

188
staging/src/k8s.io/api/networking/v1/types.go
View File

@ -28,16 +28,17 @@ import (
// NetworkPolicy describes what network traffic is allowed for a set of Pods // NetworkPolicy describes what network traffic is allowed for a set of Pods
type NetworkPolicy struct { type NetworkPolicy struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Specification of the desired behavior for this NetworkPolicy. // spec represents the specification of the desired behavior for this NetworkPolicy.
// +optional // +optional
Spec NetworkPolicySpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec NetworkPolicySpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// Status is the current state of the NetworkPolicy. // status represents the current state of the NetworkPolicy.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Status NetworkPolicyStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` Status NetworkPolicyStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
@ -57,16 +58,16 @@ const (
// NetworkPolicySpec provides the specification of a NetworkPolicy // NetworkPolicySpec provides the specification of a NetworkPolicy
type NetworkPolicySpec struct { type NetworkPolicySpec struct {
// Selects the pods to which this NetworkPolicy object applies. The array of // podSelector selects the pods to which this NetworkPolicy object applies.
// ingress rules is applied to any pods selected by this field. Multiple network // The array of ingress rules is applied to any pods selected by this field.
// policies can select the same set of pods. In this case, the ingress rules for // Multiple network policies can select the same set of pods. In this case,
// each are combined additively. This field is NOT optional and follows standard // the ingress rules for each are combined additively.
// label selector semantics. An empty podSelector matches all pods in this // This field is NOT optional and follows standard label selector semantics.
// namespace. // An empty podSelector matches all pods in this namespace.
PodSelector metav1.LabelSelector `json:"podSelector" protobuf:"bytes,1,opt,name=podSelector"` PodSelector metav1.LabelSelector `json:"podSelector" protobuf:"bytes,1,opt,name=podSelector"`
// List of ingress rules to be applied to the selected pods. Traffic is allowed to // ingress is a list of ingress rules to be applied to the selected pods.
// a pod if there are no NetworkPolicies selecting the pod // Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod
// (and cluster policy otherwise allows the traffic), OR if the traffic source is // (and cluster policy otherwise allows the traffic), OR if the traffic source is
// the pod's local node, OR if the traffic matches at least one ingress rule // the pod's local node, OR if the traffic matches at least one ingress rule
// across all of the NetworkPolicy objects whose podSelector matches the pod. If // across all of the NetworkPolicy objects whose podSelector matches the pod. If
@ -75,8 +76,8 @@ type NetworkPolicySpec struct {
// +optional // +optional
Ingress []NetworkPolicyIngressRule `json:"ingress,omitempty" protobuf:"bytes,2,rep,name=ingress"` Ingress []NetworkPolicyIngressRule `json:"ingress,omitempty" protobuf:"bytes,2,rep,name=ingress"`
// List of egress rules to be applied to the selected pods. Outgoing traffic is // egress is a list of egress rules to be applied to the selected pods. Outgoing traffic
// allowed if there are no NetworkPolicies selecting the pod (and cluster policy // is allowed if there are no NetworkPolicies selecting the pod (and cluster policy
// otherwise allows the traffic), OR if the traffic matches at least one egress rule // otherwise allows the traffic), OR if the traffic matches at least one egress rule
// across all of the NetworkPolicy objects whose podSelector matches the pod. If // across all of the NetworkPolicy objects whose podSelector matches the pod. If
// this field is empty then this NetworkPolicy limits all outgoing traffic (and serves // this field is empty then this NetworkPolicy limits all outgoing traffic (and serves
@ -85,15 +86,15 @@ type NetworkPolicySpec struct {
// +optional // +optional
Egress []NetworkPolicyEgressRule `json:"egress,omitempty" protobuf:"bytes,3,rep,name=egress"` Egress []NetworkPolicyEgressRule `json:"egress,omitempty" protobuf:"bytes,3,rep,name=egress"`
// List of rule types that the NetworkPolicy relates to. // policyTypes is a list of rule types that the NetworkPolicy relates to.
// Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. // Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"].
// If this field is not specified, it will default based on the existence of Ingress or Egress rules; // If this field is not specified, it will default based on the existence of ingress or egress rules;
// policies that contain an Egress section are assumed to affect Egress, and all policies // policies that contain an egress section are assumed to affect egress, and all policies
// (whether or not they contain an Ingress section) are assumed to affect Ingress. // (whether or not they contain an ingress section) are assumed to affect ingress.
// If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. // If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
// Likewise, if you want to write a policy that specifies that no egress is allowed, // Likewise, if you want to write a policy that specifies that no egress is allowed,
// you must specify a policyTypes value that include "Egress" (since such a policy would not include // you must specify a policyTypes value that include "Egress" (since such a policy would not include
// an Egress section and would otherwise default to just [ "Ingress" ]). // an egress section and would otherwise default to just [ "Ingress" ]).
// This field is beta-level in 1.8 // This field is beta-level in 1.8
// +optional // +optional
PolicyTypes []PolicyType `json:"policyTypes,omitempty" protobuf:"bytes,4,rep,name=policyTypes,casttype=PolicyType"` PolicyTypes []PolicyType `json:"policyTypes,omitempty" protobuf:"bytes,4,rep,name=policyTypes,casttype=PolicyType"`
@ -102,15 +103,15 @@ type NetworkPolicySpec struct {
// NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods // NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods
// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. // matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.
type NetworkPolicyIngressRule struct { type NetworkPolicyIngressRule struct {
// List of ports which should be made accessible on the pods selected for this // ports is a list of ports which should be made accessible on the pods selected for
// rule. Each item in this list is combined using a logical OR. If this field is // this rule. Each item in this list is combined using a logical OR. If this field is
// empty or missing, this rule matches all ports (traffic not restricted by port). // empty or missing, this rule matches all ports (traffic not restricted by port).
// If this field is present and contains at least one item, then this rule allows // If this field is present and contains at least one item, then this rule allows
// traffic only if the traffic matches at least one port in the list. // traffic only if the traffic matches at least one port in the list.
// +optional // +optional
Ports []NetworkPolicyPort `json:"ports,omitempty" protobuf:"bytes,1,rep,name=ports"` Ports []NetworkPolicyPort `json:"ports,omitempty" protobuf:"bytes,1,rep,name=ports"`
// List of sources which should be able to access the pods selected for this rule. // from is a list of sources which should be able to access the pods selected for this rule.
// Items in this list are combined using a logical OR operation. If this field is // Items in this list are combined using a logical OR operation. If this field is
// empty or missing, this rule matches all sources (traffic not restricted by // empty or missing, this rule matches all sources (traffic not restricted by
// source). If this field is present and contains at least one item, this rule // source). If this field is present and contains at least one item, this rule
@ -123,7 +124,7 @@ type NetworkPolicyIngressRule struct {
// matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. // matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to.
// This type is beta-level in 1.8 // This type is beta-level in 1.8
type NetworkPolicyEgressRule struct { type NetworkPolicyEgressRule struct {
// List of destination ports for outgoing traffic. // ports is a list of destination ports for outgoing traffic.
// Each item in this list is combined using a logical OR. If this field is // Each item in this list is combined using a logical OR. If this field is
// empty or missing, this rule matches all ports (traffic not restricted by port). // empty or missing, this rule matches all ports (traffic not restricted by port).
// If this field is present and contains at least one item, then this rule allows // If this field is present and contains at least one item, then this rule allows
@ -131,7 +132,7 @@ type NetworkPolicyEgressRule struct {
// +optional // +optional
Ports []NetworkPolicyPort `json:"ports,omitempty" protobuf:"bytes,1,rep,name=ports"` Ports []NetworkPolicyPort `json:"ports,omitempty" protobuf:"bytes,1,rep,name=ports"`
// List of destinations for outgoing traffic of pods selected for this rule. // to is a list of destinations for outgoing traffic of pods selected for this rule.
// Items in this list are combined using a logical OR operation. If this field is // Items in this list are combined using a logical OR operation. If this field is
// empty or missing, this rule matches all destinations (traffic not restricted by // empty or missing, this rule matches all destinations (traffic not restricted by
// destination). If this field is present and contains at least one item, this rule // destination). If this field is present and contains at least one item, this rule
@ -142,19 +143,19 @@ type NetworkPolicyEgressRule struct {
// NetworkPolicyPort describes a port to allow traffic on // NetworkPolicyPort describes a port to allow traffic on
type NetworkPolicyPort struct { type NetworkPolicyPort struct {
// The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this // protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match.
// field defaults to TCP. // If not specified, this field defaults to TCP.
// +optional // +optional
Protocol *v1.Protocol `json:"protocol,omitempty" protobuf:"bytes,1,opt,name=protocol,casttype=k8s.io/api/core/v1.Protocol"` Protocol *v1.Protocol `json:"protocol,omitempty" protobuf:"bytes,1,opt,name=protocol,casttype=k8s.io/api/core/v1.Protocol"`
// The port on the given protocol. This can either be a numerical or named // port represents the port on the given protocol. This can either be a numerical or named
// port on a pod. If this field is not provided, this matches all port names and // port on a pod. If this field is not provided, this matches all port names and
// numbers. // numbers.
// If present, only traffic on the specified protocol AND port will be matched. // If present, only traffic on the specified protocol AND port will be matched.
// +optional // +optional
Port *intstr.IntOrString `json:"port,omitempty" protobuf:"bytes,2,opt,name=port"` Port *intstr.IntOrString `json:"port,omitempty" protobuf:"bytes,2,opt,name=port"`
// If set, indicates that the range of ports from port to endPort, inclusive, // endPort indicates that the range of ports from port to endPort if set, inclusive,
// should be allowed by the policy. This field cannot be defined if the port field // should be allowed by the policy. This field cannot be defined if the port field
// is not defined or if the port field is defined as a named (string) port. // is not defined or if the port field is defined as a named (string) port.
// The endPort must be equal or greater than port. // The endPort must be equal or greater than port.
@ -166,12 +167,13 @@ type NetworkPolicyPort struct {
// to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs // to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs
// that should not be included within this rule. // that should not be included within this rule.
type IPBlock struct { type IPBlock struct {
// CIDR is a string representing the IP Block // cidr is a string representing the IPBlock
// Valid examples are "192.168.1.0/24" or "2001:db8::/64" // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
CIDR string `json:"cidr" protobuf:"bytes,1,name=cidr"` CIDR string `json:"cidr" protobuf:"bytes,1,name=cidr"`
// Except is a slice of CIDRs that should not be included within an IP Block
// except is a slice of CIDRs that should not be included within an IPBlock
// Valid examples are "192.168.1.0/24" or "2001:db8::/64" // Valid examples are "192.168.1.0/24" or "2001:db8::/64"
// Except values will be rejected if they are outside the CIDR range // Except values will be rejected if they are outside the cidr range
// +optional // +optional
Except []string `json:"except,omitempty" protobuf:"bytes,2,rep,name=except"` Except []string `json:"except,omitempty" protobuf:"bytes,2,rep,name=except"`
} }
@ -179,25 +181,25 @@ type IPBlock struct {
// NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of // NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of
// fields are allowed // fields are allowed
type NetworkPolicyPeer struct { type NetworkPolicyPeer struct {
// This is a label selector which selects Pods. This field follows standard label // podSelector is a label selector which selects pods. This field follows standard label
// selector semantics; if present but empty, it selects all pods. // selector semantics; if present but empty, it selects all pods.
// //
// If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects // If namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
// the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. // the pods matching podSelector in the Namespaces selected by NamespaceSelector.
// Otherwise it selects the Pods matching PodSelector in the policy's own Namespace. // Otherwise it selects the pods matching podSelector in the policy's own namespace.
// +optional // +optional
PodSelector *metav1.LabelSelector `json:"podSelector,omitempty" protobuf:"bytes,1,opt,name=podSelector"` PodSelector *metav1.LabelSelector `json:"podSelector,omitempty" protobuf:"bytes,1,opt,name=podSelector"`
// Selects Namespaces using cluster-scoped labels. This field follows standard label // namespaceSelector selects namespaces using cluster-scoped labels. This field follows
// selector semantics; if present but empty, it selects all namespaces. // standard label selector semantics; if present but empty, it selects all namespaces.
// //
// If PodSelector is also set, then the NetworkPolicyPeer as a whole selects // If podSelector is also set, then the NetworkPolicyPeer as a whole selects
// the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. // the pods matching podSelector in the namespaces selected by namespaceSelector.
// Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector. // Otherwise it selects all pods in the namespaces selected by namespaceSelector.
// +optional // +optional
NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty" protobuf:"bytes,2,opt,name=namespaceSelector"` NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty" protobuf:"bytes,2,opt,name=namespaceSelector"`
// IPBlock defines policy on a particular IPBlock. If this field is set then // ipBlock defines policy on a particular IPBlock. If this field is set then
// neither of the other fields can be. // neither of the other fields can be.
// +optional // +optional
IPBlock *IPBlock `json:"ipBlock,omitempty" protobuf:"bytes,3,rep,name=ipBlock"` IPBlock *IPBlock `json:"ipBlock,omitempty" protobuf:"bytes,3,rep,name=ipBlock"`
@ -233,9 +235,9 @@ const (
NetworkPolicyConditionReasonFeatureNotSupported NetworkPolicyConditionReason = "FeatureNotSupported" NetworkPolicyConditionReasonFeatureNotSupported NetworkPolicyConditionReason = "FeatureNotSupported"
) )
// NetworkPolicyStatus describe the current state of the NetworkPolicy. // NetworkPolicyStatus describes the current state of the NetworkPolicy.
type NetworkPolicyStatus struct { type NetworkPolicyStatus struct {
// Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. // conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy.
// Current service state // Current service state
// +optional // +optional
// +patchMergeKey=type // +patchMergeKey=type
@ -250,12 +252,13 @@ type NetworkPolicyStatus struct {
// NetworkPolicyList is a list of NetworkPolicy objects. // NetworkPolicyList is a list of NetworkPolicy objects.
type NetworkPolicyList struct { type NetworkPolicyList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard list metadata. // Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is a list of schema objects. // items is a list of schema objects.
Items []NetworkPolicy `json:"items" protobuf:"bytes,2,rep,name=items"` Items []NetworkPolicy `json:"items" protobuf:"bytes,2,rep,name=items"`
} }
@ -268,17 +271,18 @@ type NetworkPolicyList struct {
// based virtual hosting etc. // based virtual hosting etc.
type Ingress struct { type Ingress struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is the desired state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec IngressSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec IngressSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// Status is the current state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Status IngressStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` Status IngressStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
@ -289,18 +293,19 @@ type Ingress struct {
// IngressList is a collection of Ingress. // IngressList is a collection of Ingress.
type IngressList struct { type IngressList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of Ingress. // items is the list of Ingress.
Items []Ingress `json:"items" protobuf:"bytes,2,rep,name=items"` Items []Ingress `json:"items" protobuf:"bytes,2,rep,name=items"`
} }
// IngressSpec describes the Ingress the user wishes to exist. // IngressSpec describes the Ingress the user wishes to exist.
type IngressSpec struct { type IngressSpec struct {
// IngressClassName is the name of an IngressClass cluster resource. Ingress // ingressClassName is the name of an IngressClass cluster resource. Ingress
// controller implementations use this field to know whether they should be // controller implementations use this field to know whether they should be
// serving this Ingress resource, by a transitive connection // serving this Ingress resource, by a transitive connection
// (controller -> IngressClass -> Ingress resource). Although the // (controller -> IngressClass -> Ingress resource). Although the
@ -313,72 +318,73 @@ type IngressSpec struct {
// +optional // +optional
IngressClassName *string `json:"ingressClassName,omitempty" protobuf:"bytes,4,opt,name=ingressClassName"` IngressClassName *string `json:"ingressClassName,omitempty" protobuf:"bytes,4,opt,name=ingressClassName"`
// DefaultBackend is the backend that should handle requests that don't // defaultBackend is the backend that should handle requests that don't
// match any rule. If Rules are not specified, DefaultBackend must be specified. // 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 // If DefaultBackend is not set, the handling of requests that do not match any
// of the rules will be up to the Ingress controller. // of the rules will be up to the Ingress controller.
// +optional // +optional
DefaultBackend *IngressBackend `json:"defaultBackend,omitempty" protobuf:"bytes,1,opt,name=defaultBackend"` DefaultBackend *IngressBackend `json:"defaultBackend,omitempty" protobuf:"bytes,1,opt,name=defaultBackend"`
// TLS configuration. Currently the Ingress only supports a single TLS // tls represents the TLS configuration. Currently the Ingress only supports a
// port, 443. If multiple members of this list specify different hosts, they // single TLS port, 443. If multiple members of this list specify different hosts,
// will be multiplexed on the same port according to the hostname specified // they will be multiplexed on the same port according to the hostname specified
// through the SNI TLS extension, if the ingress controller fulfilling the // through the SNI TLS extension, if the ingress controller fulfilling the
// ingress supports SNI. // ingress supports SNI.
// +listType=atomic // +listType=atomic
// +optional // +optional
TLS []IngressTLS `json:"tls,omitempty" protobuf:"bytes,2,rep,name=tls"` TLS []IngressTLS `json:"tls,omitempty" protobuf:"bytes,2,rep,name=tls"`
// A list of host rules used to configure the Ingress. If unspecified, or // rules is a list of host rules used to configure the Ingress. If unspecified,
// no rule matches, all traffic is sent to the default backend. // or no rule matches, all traffic is sent to the default backend.
// +listType=atomic // +listType=atomic
// +optional // +optional
Rules []IngressRule `json:"rules,omitempty" protobuf:"bytes,3,rep,name=rules"` Rules []IngressRule `json:"rules,omitempty" protobuf:"bytes,3,rep,name=rules"`
} }
// IngressTLS describes the transport layer security associated with an Ingress. // IngressTLS describes the transport layer security associated with an ingress.
type IngressTLS struct { type IngressTLS struct {
// Hosts are a list of hosts included in the TLS certificate. The values in // 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 // this list must match the name/s used in the tlsSecret. Defaults to the
// wildcard host setting for the loadbalancer controller fulfilling this // wildcard host setting for the loadbalancer controller fulfilling this
// Ingress, if left unspecified. // Ingress, if left unspecified.
// +listType=atomic // +listType=atomic
// +optional // +optional
Hosts []string `json:"hosts,omitempty" protobuf:"bytes,1,rep,name=hosts"` Hosts []string `json:"hosts,omitempty" protobuf:"bytes,1,rep,name=hosts"`
// SecretName is the name of the secret used to terminate TLS traffic on
// 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 // 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" // 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 // header field used by an IngressRule, the SNI host is used for termination
// and value of the Host header is used for routing. // and value of the "Host" header is used for routing.
// +optional // +optional
SecretName string `json:"secretName,omitempty" protobuf:"bytes,2,opt,name=secretName"` SecretName string `json:"secretName,omitempty" protobuf:"bytes,2,opt,name=secretName"`
} }
// IngressStatus describe the current state of the Ingress. // IngressStatus describe the current state of the Ingress.
type IngressStatus struct { type IngressStatus struct {
// LoadBalancer contains the current status of the load-balancer. // loadBalancer contains the current status of the load-balancer.
// +optional // +optional
LoadBalancer IngressLoadBalancerStatus `json:"loadBalancer,omitempty" protobuf:"bytes,1,opt,name=loadBalancer"` LoadBalancer IngressLoadBalancerStatus `json:"loadBalancer,omitempty" protobuf:"bytes,1,opt,name=loadBalancer"`
} }
// IngressLoadBalancerStatus represents the status of a load-balancer. // IngressLoadBalancerStatus represents the status of a load-balancer.
type IngressLoadBalancerStatus struct { type IngressLoadBalancerStatus struct {
// Ingress is a list containing ingress points for the load-balancer. // ingress is a list containing ingress points for the load-balancer.
// +optional // +optional
Ingress []IngressLoadBalancerIngress `json:"ingress,omitempty" protobuf:"bytes,1,rep,name=ingress"` Ingress []IngressLoadBalancerIngress `json:"ingress,omitempty" protobuf:"bytes,1,rep,name=ingress"`
} }
// IngressLoadBalancerIngress represents the status of a load-balancer ingress point. // IngressLoadBalancerIngress represents the status of a load-balancer ingress point.
type IngressLoadBalancerIngress struct { type IngressLoadBalancerIngress struct {
// IP is set for load-balancer ingress points that are IP based. // ip is set for load-balancer ingress points that are IP based.
// +optional // +optional
IP string `json:"ip,omitempty" protobuf:"bytes,1,opt,name=ip"` IP string `json:"ip,omitempty" protobuf:"bytes,1,opt,name=ip"`
// Hostname is set for load-balancer ingress points that are DNS based. // hostname is set for load-balancer ingress points that are DNS based.
// +optional // +optional
Hostname string `json:"hostname,omitempty" protobuf:"bytes,2,opt,name=hostname"` Hostname string `json:"hostname,omitempty" protobuf:"bytes,2,opt,name=hostname"`
// Ports provides information about the ports exposed by this LoadBalancer. // ports provides information about the ports exposed by this LoadBalancer.
// +listType=atomic // +listType=atomic
// +optional // +optional
Ports []IngressPortStatus `json:"ports,omitempty" protobuf:"bytes,4,rep,name=ports"` Ports []IngressPortStatus `json:"ports,omitempty" protobuf:"bytes,4,rep,name=ports"`
@ -386,14 +392,14 @@ type IngressLoadBalancerIngress struct {
// IngressPortStatus represents the error condition of a service port // IngressPortStatus represents the error condition of a service port
type IngressPortStatus struct { type IngressPortStatus struct {
// Port is the port number of the ingress port. // port is the port number of the ingress port.
Port int32 `json:"port" protobuf:"varint,1,opt,name=port"` Port int32 `json:"port" protobuf:"varint,1,opt,name=port"`
// Protocol is the protocol of the ingress port. // protocol is the protocol of the ingress port.
// The supported values are: "TCP", "UDP", "SCTP" // The supported values are: "TCP", "UDP", "SCTP"
Protocol v1.Protocol `json:"protocol" protobuf:"bytes,2,opt,name=protocol,casttype=Protocol"` Protocol v1.Protocol `json:"protocol" protobuf:"bytes,2,opt,name=protocol,casttype=Protocol"`
// Error is to record the problem with the service port // error is to record the problem with the service port
// The format of the error shall comply with the following rules: // 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 // - built-in error values shall be specified in this file and those shall use
// CamelCase names // CamelCase names
@ -412,7 +418,7 @@ type IngressPortStatus struct {
// the related backend services. Incoming requests are first evaluated for a host // the related backend services. Incoming requests are first evaluated for a host
// match, then routed to the backend associated with the matching IngressRuleValue. // match, then routed to the backend associated with the matching IngressRuleValue.
type IngressRule struct { type IngressRule struct {
// Host is the fully qualified domain name of a network host, as defined by RFC 3986. // 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 // Note the following deviations from the "host" part of the
// URI as defined in RFC 3986: // URI as defined in RFC 3986:
// 1. IPs are not allowed. Currently an IngressRuleValue can only apply to // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
@ -425,14 +431,14 @@ type IngressRule struct {
// IngressRuleValue. If the host is unspecified, the Ingress routes all // IngressRuleValue. If the host is unspecified, the Ingress routes all
// traffic based on the specified IngressRuleValue. // traffic based on the specified IngressRuleValue.
// //
// Host can be "precise" which is a domain name without the terminating dot of // 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 // 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"). // prefixed with a single wildcard label (e.g. "*.foo.com").
// The wildcard character '*' must appear by itself as the first DNS label and // 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 == "*"). // 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: // 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. // 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 // 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. // is to equal to the suffix (removing the first label) of the wildcard rule.
// +optional // +optional
Host string `json:"host,omitempty" protobuf:"bytes,1,opt,name=host"` Host string `json:"host,omitempty" protobuf:"bytes,1,opt,name=host"`
@ -460,7 +466,7 @@ type IngressRuleValue struct {
// to match against everything after the last '/' and before the first '?' // to match against everything after the last '/' and before the first '?'
// or '#'. // or '#'.
type HTTPIngressRuleValue struct { type HTTPIngressRuleValue struct {
// A collection of paths that map requests to backends. // paths is a collection of paths that map requests to backends.
// +listType=atomic // +listType=atomic
Paths []HTTPIngressPath `json:"paths" protobuf:"bytes,1,rep,name=paths"` Paths []HTTPIngressPath `json:"paths" protobuf:"bytes,1,rep,name=paths"`
} }
@ -499,14 +505,14 @@ const (
// HTTPIngressPath associates a path with a backend. Incoming urls matching the // HTTPIngressPath associates a path with a backend. Incoming urls matching the
// path are forwarded to the backend. // path are forwarded to the backend.
type HTTPIngressPath struct { type HTTPIngressPath struct {
// Path is matched against the path of an incoming request. Currently it can // path is matched against the path of an incoming request. Currently it can
// contain characters disallowed from the conventional "path" part of a URL // 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 // as defined by RFC 3986. Paths must begin with a '/' and must be present
// when using PathType with value "Exact" or "Prefix". // when using PathType with value "Exact" or "Prefix".
// +optional // +optional
Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"` Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"`
// PathType determines the interpretation of the Path matching. PathType can // pathType determines the interpretation of the path matching. PathType can
// be one of the following values: // be one of the following values:
// * Exact: Matches the URL path exactly. // * Exact: Matches the URL path exactly.
// * Prefix: Matches based on a URL path prefix split by '/'. Matching is // * Prefix: Matches based on a URL path prefix split by '/'. Matching is
@ -522,19 +528,19 @@ type HTTPIngressPath struct {
// Implementations are required to support all path types. // Implementations are required to support all path types.
PathType *PathType `json:"pathType" protobuf:"bytes,3,opt,name=pathType"` PathType *PathType `json:"pathType" protobuf:"bytes,3,opt,name=pathType"`
// Backend defines the referenced service endpoint to which the traffic // backend defines the referenced service endpoint to which the traffic
// will be forwarded to. // will be forwarded to.
Backend IngressBackend `json:"backend" protobuf:"bytes,2,opt,name=backend"` Backend IngressBackend `json:"backend" protobuf:"bytes,2,opt,name=backend"`
} }
// IngressBackend describes all endpoints for a given service and port. // IngressBackend describes all endpoints for a given service and port.
type IngressBackend struct { type IngressBackend struct {
// Service references a Service as a Backend. // service references a service as a backend.
// This is a mutually exclusive setting with "Resource". // This is a mutually exclusive setting with "Resource".
// +optional // +optional
Service *IngressServiceBackend `json:"service,omitempty" protobuf:"bytes,4,opt,name=service"` Service *IngressServiceBackend `json:"service,omitempty" protobuf:"bytes,4,opt,name=service"`
// Resource is an ObjectRef to another Kubernetes resource in the namespace // resource is an ObjectRef to another Kubernetes resource in the namespace
// of the Ingress object. If resource is specified, a service.Name and // of the Ingress object. If resource is specified, a service.Name and
// service.Port must not be specified. // service.Port must not be specified.
// This is a mutually exclusive setting with "Service". // This is a mutually exclusive setting with "Service".
@ -544,23 +550,23 @@ type IngressBackend struct {
// IngressServiceBackend references a Kubernetes Service as a Backend. // IngressServiceBackend references a Kubernetes Service as a Backend.
type IngressServiceBackend struct { type IngressServiceBackend struct {
// Name is the referenced service. The service must exist in // name is the referenced service. The service must exist in
// the same namespace as the Ingress object. // the same namespace as the Ingress object.
Name string `json:"name" protobuf:"bytes,1,opt,name=name"` Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
// Port of the referenced service. A port name or port number // port of the referenced service. A port name or port number
// is required for a IngressServiceBackend. // is required for a IngressServiceBackend.
Port ServiceBackendPort `json:"port,omitempty" protobuf:"bytes,2,opt,name=port"` Port ServiceBackendPort `json:"port,omitempty" protobuf:"bytes,2,opt,name=port"`
} }
// ServiceBackendPort is the service port being referenced. // ServiceBackendPort is the service port being referenced.
type ServiceBackendPort struct { type ServiceBackendPort struct {
// Name is the name of the port on the Service. // name is the name of the port on the Service.
// This is a mutually exclusive setting with "Number". // This is a mutually exclusive setting with "Number".
// +optional // +optional
Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"` Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`
// Number is the numerical port number (e.g. 80) on the Service. // number is the numerical port number (e.g. 80) on the Service.
// This is a mutually exclusive setting with "Name". // This is a mutually exclusive setting with "Name".
// +optional // +optional
Number int32 `json:"number,omitempty" protobuf:"bytes,2,opt,name=number"` Number int32 `json:"number,omitempty" protobuf:"bytes,2,opt,name=number"`
@ -577,12 +583,13 @@ type ServiceBackendPort struct {
// resources without a class specified will be assigned this default class. // resources without a class specified will be assigned this default class.
type IngressClass struct { type IngressClass struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is the desired state of the IngressClass. // spec is the desired state of the IngressClass.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec IngressClassSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec IngressClassSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
@ -590,15 +597,15 @@ type IngressClass struct {
// IngressClassSpec provides information about the class of an Ingress. // IngressClassSpec provides information about the class of an Ingress.
type IngressClassSpec struct { type IngressClassSpec struct {
// Controller refers to the name of the controller that should handle this // controller refers to the name of the controller that should handle this
// class. This allows for different "flavors" that are controlled by the // class. This allows for different "flavors" that are controlled by the
// same controller. For example, you may have different Parameters for the // same controller. For example, you may have different parameters for the
// same implementing controller. This should be specified as a // same implementing controller. This should be specified as a
// domain-prefixed path no more than 250 characters in length, e.g. // domain-prefixed path no more than 250 characters in length, e.g.
// "acme.io/ingress-controller". This field is immutable. // "acme.io/ingress-controller". This field is immutable.
Controller string `json:"controller,omitempty" protobuf:"bytes,1,opt,name=controller"` Controller string `json:"controller,omitempty" protobuf:"bytes,1,opt,name=controller"`
// Parameters is a link to a custom resource containing additional // parameters is a link to a custom resource containing additional
// configuration for the controller. This is optional if the controller does // configuration for the controller. This is optional if the controller does
// not require extra parameters. // not require extra parameters.
// +optional // +optional
@ -617,20 +624,24 @@ const (
// IngressClassParametersReference identifies an API object. This can be used // IngressClassParametersReference identifies an API object. This can be used
// to specify a cluster or namespace-scoped resource. // to specify a cluster or namespace-scoped resource.
type IngressClassParametersReference struct { type IngressClassParametersReference struct {
// APIGroup is the group for the resource being referenced. If APIGroup is // 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 // not specified, the specified Kind must be in the core API group. For any
// other third-party types, APIGroup is required. // other third-party types, APIGroup is required.
// +optional // +optional
APIGroup *string `json:"apiGroup,omitempty" protobuf:"bytes,1,opt,name=aPIGroup"` APIGroup *string `json:"apiGroup,omitempty" protobuf:"bytes,1,opt,name=aPIGroup"`
// Kind is the type of resource being referenced.
// kind is the type of resource being referenced.
Kind string `json:"kind" protobuf:"bytes,2,opt,name=kind"` Kind string `json:"kind" protobuf:"bytes,2,opt,name=kind"`
// Name is the name of resource being referenced.
// name is the name of resource being referenced.
Name string `json:"name" protobuf:"bytes,3,opt,name=name"` Name string `json:"name" protobuf:"bytes,3,opt,name=name"`
// Scope represents if this refers to a cluster or namespace scoped resource.
// scope represents if this refers to a cluster or namespace scoped resource.
// This may be set to "Cluster" (default) or "Namespace". // This may be set to "Cluster" (default) or "Namespace".
// +optional // +optional
Scope *string `json:"scope" protobuf:"bytes,4,opt,name=scope"` Scope *string `json:"scope" protobuf:"bytes,4,opt,name=scope"`
// Namespace is the namespace of the resource being referenced. This field is
// namespace is the namespace of the resource being referenced. This field is
// required when scope is set to "Namespace" and must be unset when scope is set to // required when scope is set to "Namespace" and must be unset when scope is set to
// "Cluster". // "Cluster".
// +optional // +optional
@ -642,10 +653,11 @@ type IngressClassParametersReference struct {
// IngressClassList is a collection of IngressClasses. // IngressClassList is a collection of IngressClasses.
type IngressClassList struct { type IngressClassList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard list metadata. // Standard list metadata.
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of IngressClasses. // items is the list of IngressClasses.
Items []IngressClass `json:"items" protobuf:"bytes,2,rep,name=items"` Items []IngressClass `json:"items" protobuf:"bytes,2,rep,name=items"`
} }

118
staging/src/k8s.io/api/networking/v1/types_swagger_doc_generated.go generated
View File

@ -29,9 +29,9 @@ package v1
// AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT. // AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT.
var map_HTTPIngressPath = map[string]string{ var map_HTTPIngressPath = map[string]string{
"": "HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.", "": "HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.",
"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\".", "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\".",
"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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.", "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types.",
"backend": "Backend defines the referenced service endpoint to which the traffic will be forwarded to.", "backend": "backend defines the referenced service endpoint to which the traffic will be forwarded to.",
} }
func (HTTPIngressPath) SwaggerDoc() map[string]string { func (HTTPIngressPath) SwaggerDoc() map[string]string {
@ -40,7 +40,7 @@ func (HTTPIngressPath) SwaggerDoc() map[string]string {
var map_HTTPIngressRuleValue = map[string]string{ var map_HTTPIngressRuleValue = map[string]string{
"": "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 '#'.", "": "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 '#'.",
"paths": "A collection of paths that map requests to backends.", "paths": "paths is a collection of paths that map requests to backends.",
} }
func (HTTPIngressRuleValue) SwaggerDoc() map[string]string { func (HTTPIngressRuleValue) SwaggerDoc() map[string]string {
@ -49,8 +49,8 @@ func (HTTPIngressRuleValue) SwaggerDoc() map[string]string {
var map_IPBlock = map[string]string{ var map_IPBlock = map[string]string{
"": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.", "": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.",
"cidr": "CIDR is a string representing the IP Block Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"", "cidr": "cidr is a string representing the IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"",
"except": "Except is a slice of CIDRs that should not be included within an IP Block Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the CIDR range", "except": "except is a slice of CIDRs that should not be included within an IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the cidr range",
} }
func (IPBlock) SwaggerDoc() map[string]string { func (IPBlock) SwaggerDoc() map[string]string {
@ -60,8 +60,8 @@ func (IPBlock) SwaggerDoc() map[string]string {
var map_Ingress = map[string]string{ var map_Ingress = map[string]string{
"": "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.", "": "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.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"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", "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",
"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", "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",
} }
func (Ingress) SwaggerDoc() map[string]string { func (Ingress) SwaggerDoc() map[string]string {
@ -70,8 +70,8 @@ func (Ingress) SwaggerDoc() map[string]string {
var map_IngressBackend = map[string]string{ var map_IngressBackend = map[string]string{
"": "IngressBackend describes all endpoints for a given service and port.", "": "IngressBackend describes all endpoints for a given service and port.",
"service": "Service references a Service as a Backend. This is a mutually exclusive setting with \"Resource\".", "service": "service references a service as a backend. This is a mutually exclusive setting with \"Resource\".",
"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\".", "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\".",
} }
func (IngressBackend) SwaggerDoc() map[string]string { func (IngressBackend) SwaggerDoc() map[string]string {
@ -81,7 +81,7 @@ func (IngressBackend) SwaggerDoc() map[string]string {
var map_IngressClass = map[string]string{ var map_IngressClass = map[string]string{
"": "IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.", "": "IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "spec": "spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
} }
func (IngressClass) SwaggerDoc() map[string]string { func (IngressClass) SwaggerDoc() map[string]string {
@ -91,7 +91,7 @@ func (IngressClass) SwaggerDoc() map[string]string {
var map_IngressClassList = map[string]string{ var map_IngressClassList = map[string]string{
"": "IngressClassList is a collection of IngressClasses.", "": "IngressClassList is a collection of IngressClasses.",
"metadata": "Standard list metadata.", "metadata": "Standard list metadata.",
"items": "Items is the list of IngressClasses.", "items": "items is the list of IngressClasses.",
} }
func (IngressClassList) SwaggerDoc() map[string]string { func (IngressClassList) SwaggerDoc() map[string]string {
@ -100,11 +100,11 @@ func (IngressClassList) SwaggerDoc() map[string]string {
var map_IngressClassParametersReference = map[string]string{ var map_IngressClassParametersReference = map[string]string{
"": "IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.", "": "IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped 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.", "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.",
"kind": "Kind is the type of resource being referenced.", "kind": "kind is the type of resource being referenced.",
"name": "Name is the name of resource being referenced.", "name": "name is the name of resource being referenced.",
"scope": "Scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".", "scope": "scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".",
"namespace": "Namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".", "namespace": "namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".",
} }
func (IngressClassParametersReference) SwaggerDoc() map[string]string { func (IngressClassParametersReference) SwaggerDoc() map[string]string {
@ -113,8 +113,8 @@ func (IngressClassParametersReference) SwaggerDoc() map[string]string {
var map_IngressClassSpec = map[string]string{ var map_IngressClassSpec = map[string]string{
"": "IngressClassSpec provides information about the class of an Ingress.", "": "IngressClassSpec provides information about the class of an Ingress.",
"controller": "Controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.", "controller": "controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.",
"parameters": "Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.", "parameters": "parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.",
} }
func (IngressClassSpec) SwaggerDoc() map[string]string { func (IngressClassSpec) SwaggerDoc() map[string]string {
@ -124,7 +124,7 @@ func (IngressClassSpec) SwaggerDoc() map[string]string {
var map_IngressList = map[string]string{ var map_IngressList = map[string]string{
"": "IngressList is a collection of Ingress.", "": "IngressList is a collection of Ingress.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"items": "Items is the list of Ingress.", "items": "items is the list of Ingress.",
} }
func (IngressList) SwaggerDoc() map[string]string { func (IngressList) SwaggerDoc() map[string]string {
@ -133,9 +133,9 @@ func (IngressList) SwaggerDoc() map[string]string {
var map_IngressLoadBalancerIngress = map[string]string{ var map_IngressLoadBalancerIngress = map[string]string{
"": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.", "": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.",
"ip": "IP is set for load-balancer ingress points that are IP based.", "ip": "ip is set for load-balancer ingress points that are IP based.",
"hostname": "Hostname is set for load-balancer ingress points that are DNS based.", "hostname": "hostname is set for load-balancer ingress points that are DNS based.",
"ports": "Ports provides information about the ports exposed by this LoadBalancer.", "ports": "ports provides information about the ports exposed by this LoadBalancer.",
} }
func (IngressLoadBalancerIngress) SwaggerDoc() map[string]string { func (IngressLoadBalancerIngress) SwaggerDoc() map[string]string {
@ -144,7 +144,7 @@ func (IngressLoadBalancerIngress) SwaggerDoc() map[string]string {
var map_IngressLoadBalancerStatus = map[string]string{ var map_IngressLoadBalancerStatus = map[string]string{
"": "IngressLoadBalancerStatus represents the status of a load-balancer.", "": "IngressLoadBalancerStatus represents the status of a load-balancer.",
"ingress": "Ingress is a list containing ingress points for the load-balancer.", "ingress": "ingress is a list containing ingress points for the load-balancer.",
} }
func (IngressLoadBalancerStatus) SwaggerDoc() map[string]string { func (IngressLoadBalancerStatus) SwaggerDoc() map[string]string {
@ -153,9 +153,9 @@ func (IngressLoadBalancerStatus) SwaggerDoc() map[string]string {
var map_IngressPortStatus = map[string]string{ var map_IngressPortStatus = map[string]string{
"": "IngressPortStatus represents the error condition of a service port", "": "IngressPortStatus represents the error condition of a service port",
"port": "Port is the port number of the ingress port.", "port": "port is the port number of the ingress port.",
"protocol": "Protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"", "protocol": "protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"",
"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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.", "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.",
} }
func (IngressPortStatus) SwaggerDoc() map[string]string { func (IngressPortStatus) SwaggerDoc() map[string]string {
@ -164,7 +164,7 @@ func (IngressPortStatus) SwaggerDoc() map[string]string {
var map_IngressRule = map[string]string{ var map_IngressRule = map[string]string{
"": "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.", "": "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.",
"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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nHost 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.", "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nhost 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.",
} }
func (IngressRule) SwaggerDoc() map[string]string { func (IngressRule) SwaggerDoc() map[string]string {
@ -181,8 +181,8 @@ func (IngressRuleValue) SwaggerDoc() map[string]string {
var map_IngressServiceBackend = map[string]string{ var map_IngressServiceBackend = map[string]string{
"": "IngressServiceBackend references a Kubernetes Service as a Backend.", "": "IngressServiceBackend references a Kubernetes Service as a Backend.",
"name": "Name is the referenced service. The service must exist in the same namespace as the Ingress object.", "name": "name is the referenced service. The service must exist in the same namespace as the Ingress object.",
"port": "Port of the referenced service. A port name or port number is required for a IngressServiceBackend.", "port": "port of the referenced service. A port name or port number is required for a IngressServiceBackend.",
} }
func (IngressServiceBackend) SwaggerDoc() map[string]string { func (IngressServiceBackend) SwaggerDoc() map[string]string {
@ -191,10 +191,10 @@ func (IngressServiceBackend) SwaggerDoc() map[string]string {
var map_IngressSpec = map[string]string{ var map_IngressSpec = map[string]string{
"": "IngressSpec describes the Ingress the user wishes to exist.", "": "IngressSpec describes the Ingress the user wishes to exist.",
"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.", "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.",
"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.", "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.",
"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.", "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.",
"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.", "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.",
} }
func (IngressSpec) SwaggerDoc() map[string]string { func (IngressSpec) SwaggerDoc() map[string]string {
@ -203,7 +203,7 @@ func (IngressSpec) SwaggerDoc() map[string]string {
var map_IngressStatus = map[string]string{ var map_IngressStatus = map[string]string{
"": "IngressStatus describe the current state of the Ingress.", "": "IngressStatus describe the current state of the Ingress.",
"loadBalancer": "LoadBalancer contains the current status of the load-balancer.", "loadBalancer": "loadBalancer contains the current status of the load-balancer.",
} }
func (IngressStatus) SwaggerDoc() map[string]string { func (IngressStatus) SwaggerDoc() map[string]string {
@ -211,9 +211,9 @@ func (IngressStatus) SwaggerDoc() map[string]string {
} }
var map_IngressTLS = map[string]string{ var map_IngressTLS = map[string]string{
"": "IngressTLS describes the transport layer security associated with an Ingress.", "": "IngressTLS describes the transport layer security associated with an ingress.",
"hosts": "Hosts are 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.", "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.",
"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.", "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.",
} }
func (IngressTLS) SwaggerDoc() map[string]string { func (IngressTLS) SwaggerDoc() map[string]string {
@ -223,8 +223,8 @@ func (IngressTLS) SwaggerDoc() map[string]string {
var map_NetworkPolicy = map[string]string{ var map_NetworkPolicy = map[string]string{
"": "NetworkPolicy describes what network traffic is allowed for a set of Pods", "": "NetworkPolicy describes what network traffic is allowed for a set of Pods",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Specification of the desired behavior for this NetworkPolicy.", "spec": "spec represents the specification of the desired behavior for this NetworkPolicy.",
"status": "Status is the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "status": "status represents the current state of the NetworkPolicy. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
} }
func (NetworkPolicy) SwaggerDoc() map[string]string { func (NetworkPolicy) SwaggerDoc() map[string]string {
@ -233,8 +233,8 @@ func (NetworkPolicy) SwaggerDoc() map[string]string {
var map_NetworkPolicyEgressRule = map[string]string{ var map_NetworkPolicyEgressRule = map[string]string{
"": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8", "": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8",
"ports": "List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", "ports": "ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"to": "List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.", "to": "to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.",
} }
func (NetworkPolicyEgressRule) SwaggerDoc() map[string]string { func (NetworkPolicyEgressRule) SwaggerDoc() map[string]string {
@ -243,8 +243,8 @@ func (NetworkPolicyEgressRule) SwaggerDoc() map[string]string {
var map_NetworkPolicyIngressRule = map[string]string{ var map_NetworkPolicyIngressRule = map[string]string{
"": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.", "": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.",
"ports": "List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", "ports": "ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.",
"from": "List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.", "from": "from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.",
} }
func (NetworkPolicyIngressRule) SwaggerDoc() map[string]string { func (NetworkPolicyIngressRule) SwaggerDoc() map[string]string {
@ -254,7 +254,7 @@ func (NetworkPolicyIngressRule) SwaggerDoc() map[string]string {
var map_NetworkPolicyList = map[string]string{ var map_NetworkPolicyList = map[string]string{
"": "NetworkPolicyList is a list of NetworkPolicy objects.", "": "NetworkPolicyList is a list of NetworkPolicy objects.",
"metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"items": "Items is a list of schema objects.", "items": "items is a list of schema objects.",
} }
func (NetworkPolicyList) SwaggerDoc() map[string]string { func (NetworkPolicyList) SwaggerDoc() map[string]string {
@ -263,9 +263,9 @@ func (NetworkPolicyList) SwaggerDoc() map[string]string {
var map_NetworkPolicyPeer = map[string]string{ var map_NetworkPolicyPeer = map[string]string{
"": "NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed", "": "NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed",
"podSelector": "This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.", "podSelector": "podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace.",
"namespaceSelector": "Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.", "namespaceSelector": "namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector.",
"ipBlock": "IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.", "ipBlock": "ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.",
} }
func (NetworkPolicyPeer) SwaggerDoc() map[string]string { func (NetworkPolicyPeer) SwaggerDoc() map[string]string {
@ -274,9 +274,9 @@ func (NetworkPolicyPeer) SwaggerDoc() map[string]string {
var map_NetworkPolicyPort = map[string]string{ var map_NetworkPolicyPort = map[string]string{
"": "NetworkPolicyPort describes a port to allow traffic on", "": "NetworkPolicyPort describes a port to allow traffic on",
"protocol": "The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.", "protocol": "protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.",
"port": "The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.", "port": "port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched.",
"endPort": "If set, indicates that the range of ports from port to endPort, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.", "endPort": "endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.",
} }
func (NetworkPolicyPort) SwaggerDoc() map[string]string { func (NetworkPolicyPort) SwaggerDoc() map[string]string {
@ -285,10 +285,10 @@ func (NetworkPolicyPort) SwaggerDoc() map[string]string {
var map_NetworkPolicySpec = map[string]string{ var map_NetworkPolicySpec = map[string]string{
"": "NetworkPolicySpec provides the specification of a NetworkPolicy", "": "NetworkPolicySpec provides the specification of a NetworkPolicy",
"podSelector": "Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.", "podSelector": "podSelector selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.",
"ingress": "List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)", "ingress": "ingress is a list of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)",
"egress": "List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8", "egress": "egress is a list of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8",
"policyTypes": "List of rule types that the NetworkPolicy relates to. Valid options are [\"Ingress\"], [\"Egress\"], or [\"Ingress\", \"Egress\"]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an Egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8", "policyTypes": "policyTypes is a list of rule types that the NetworkPolicy relates to. Valid options are [\"Ingress\"], [\"Egress\"], or [\"Ingress\", \"Egress\"]. If this field is not specified, it will default based on the existence of ingress or egress rules; policies that contain an egress section are assumed to affect egress, and all policies (whether or not they contain an ingress section) are assumed to affect ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ \"Egress\" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include \"Egress\" (since such a policy would not include an egress section and would otherwise default to just [ \"Ingress\" ]). This field is beta-level in 1.8",
} }
func (NetworkPolicySpec) SwaggerDoc() map[string]string { func (NetworkPolicySpec) SwaggerDoc() map[string]string {
@ -296,8 +296,8 @@ func (NetworkPolicySpec) SwaggerDoc() map[string]string {
} }
var map_NetworkPolicyStatus = map[string]string{ var map_NetworkPolicyStatus = map[string]string{
"": "NetworkPolicyStatus describe the current state of the NetworkPolicy.", "": "NetworkPolicyStatus describes the current state of the NetworkPolicy.",
"conditions": "Conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state", "conditions": "conditions holds an array of metav1.Condition that describe the state of the NetworkPolicy. Current service state",
} }
func (NetworkPolicyStatus) SwaggerDoc() map[string]string { func (NetworkPolicyStatus) SwaggerDoc() map[string]string {
@ -306,8 +306,8 @@ func (NetworkPolicyStatus) SwaggerDoc() map[string]string {
var map_ServiceBackendPort = map[string]string{ var map_ServiceBackendPort = map[string]string{
"": "ServiceBackendPort is the service port being referenced.", "": "ServiceBackendPort is the service port being referenced.",
"name": "Name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".", "name": "name is the name of the port on the Service. This is a mutually exclusive setting with \"Number\".",
"number": "Number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".", "number": "number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with \"Name\".",
} }
func (ServiceBackendPort) SwaggerDoc() map[string]string { func (ServiceBackendPort) SwaggerDoc() map[string]string {

18
staging/src/k8s.io/api/networking/v1alpha1/generated.proto
View File

@ -44,7 +44,7 @@ message ClusterCIDR {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is the desired state of the ClusterCIDR. // spec is the desired state of the ClusterCIDR.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional ClusterCIDRSpec spec = 2; optional ClusterCIDRSpec spec = 2;
@ -57,19 +57,19 @@ message ClusterCIDRList {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of ClusterCIDRs. // items is the list of ClusterCIDRs.
repeated ClusterCIDR items = 2; repeated ClusterCIDR items = 2;
} }
// ClusterCIDRSpec defines the desired state of ClusterCIDR. // ClusterCIDRSpec defines the desired state of ClusterCIDR.
message ClusterCIDRSpec { message ClusterCIDRSpec {
// NodeSelector defines which nodes the config is applicable to. // nodeSelector defines which nodes the config is applicable to.
// An empty or nil NodeSelector selects all nodes. // An empty or nil nodeSelector selects all nodes.
// This field is immutable. // This field is immutable.
// +optional // +optional
optional k8s.io.api.core.v1.NodeSelector nodeSelector = 1; optional k8s.io.api.core.v1.NodeSelector nodeSelector = 1;
// PerNodeHostBits defines the number of host bits to be configured per node. // perNodeHostBits defines the number of host bits to be configured per node.
// A subnet mask determines how much of the address is used for network bits // A subnet mask determines how much of the address is used for network bits
// and host bits. For example an IPv4 address of 192.168.0.0/24, splits the // and host bits. For example an IPv4 address of 192.168.0.0/24, splits the
// address into 24 bits for the network portion and 8 bits for the host portion. // address into 24 bits for the network portion and 8 bits for the host portion.
@ -79,14 +79,14 @@ message ClusterCIDRSpec {
// +required // +required
optional int32 perNodeHostBits = 2; optional int32 perNodeHostBits = 2;
// IPv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8"). // ipv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8").
// At least one of IPv4 and IPv6 must be specified. // At least one of ipv4 and ipv6 must be specified.
// This field is immutable. // This field is immutable.
// +optional // +optional
optional string ipv4 = 3; optional string ipv4 = 3;
// IPv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64"). // ipv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64").
// At least one of IPv4 and IPv6 must be specified. // At least one of ipv4 and ipv6 must be specified.
// This field is immutable. // This field is immutable.
// +optional // +optional
optional string ipv6 = 4; optional string ipv6 = 4;

20
staging/src/k8s.io/api/networking/v1alpha1/types.go
View File

@ -37,12 +37,13 @@ import (
// selector matches the Node may be used. // selector matches the Node may be used.
type ClusterCIDR struct { type ClusterCIDR struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is the desired state of the ClusterCIDR. // spec is the desired state of the ClusterCIDR.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec ClusterCIDRSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec ClusterCIDRSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
@ -50,13 +51,13 @@ type ClusterCIDR struct {
// ClusterCIDRSpec defines the desired state of ClusterCIDR. // ClusterCIDRSpec defines the desired state of ClusterCIDR.
type ClusterCIDRSpec struct { type ClusterCIDRSpec struct {
// NodeSelector defines which nodes the config is applicable to. // nodeSelector defines which nodes the config is applicable to.
// An empty or nil NodeSelector selects all nodes. // An empty or nil nodeSelector selects all nodes.
// This field is immutable. // This field is immutable.
// +optional // +optional
NodeSelector *v1.NodeSelector `json:"nodeSelector,omitempty" protobuf:"bytes,1,opt,name=nodeSelector"` NodeSelector *v1.NodeSelector `json:"nodeSelector,omitempty" protobuf:"bytes,1,opt,name=nodeSelector"`
// PerNodeHostBits defines the number of host bits to be configured per node. // perNodeHostBits defines the number of host bits to be configured per node.
// A subnet mask determines how much of the address is used for network bits // A subnet mask determines how much of the address is used for network bits
// and host bits. For example an IPv4 address of 192.168.0.0/24, splits the // and host bits. For example an IPv4 address of 192.168.0.0/24, splits the
// address into 24 bits for the network portion and 8 bits for the host portion. // address into 24 bits for the network portion and 8 bits for the host portion.
@ -66,14 +67,14 @@ type ClusterCIDRSpec struct {
// +required // +required
PerNodeHostBits int32 `json:"perNodeHostBits" protobuf:"varint,2,opt,name=perNodeHostBits"` PerNodeHostBits int32 `json:"perNodeHostBits" protobuf:"varint,2,opt,name=perNodeHostBits"`
// IPv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8"). // ipv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8").
// At least one of IPv4 and IPv6 must be specified. // At least one of ipv4 and ipv6 must be specified.
// This field is immutable. // This field is immutable.
// +optional // +optional
IPv4 string `json:"ipv4" protobuf:"bytes,3,opt,name=ipv4"` IPv4 string `json:"ipv4" protobuf:"bytes,3,opt,name=ipv4"`
// IPv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64"). // ipv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64").
// At least one of IPv4 and IPv6 must be specified. // At least one of ipv4 and ipv6 must be specified.
// This field is immutable. // This field is immutable.
// +optional // +optional
IPv6 string `json:"ipv6" protobuf:"bytes,4,opt,name=ipv6"` IPv6 string `json:"ipv6" protobuf:"bytes,4,opt,name=ipv6"`
@ -85,11 +86,12 @@ type ClusterCIDRSpec struct {
// ClusterCIDRList contains a list of ClusterCIDR. // ClusterCIDRList contains a list of ClusterCIDR.
type ClusterCIDRList struct { type ClusterCIDRList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of ClusterCIDRs. // items is the list of ClusterCIDRs.
Items []ClusterCIDR `json:"items" protobuf:"bytes,2,rep,name=items"` Items []ClusterCIDR `json:"items" protobuf:"bytes,2,rep,name=items"`
} }

12
staging/src/k8s.io/api/networking/v1alpha1/types_swagger_doc_generated.go generated
View File

@ -30,7 +30,7 @@ package v1alpha1
var map_ClusterCIDR = map[string]string{ var map_ClusterCIDR = map[string]string{
"": "ClusterCIDR represents a single configuration for per-Node Pod CIDR allocations when the MultiCIDRRangeAllocator is enabled (see the config for kube-controller-manager). A cluster may have any number of ClusterCIDR resources, all of which will be considered when allocating a CIDR for a Node. A ClusterCIDR is eligible to be used for a given Node when the node selector matches the node in question and has free CIDRs to allocate. In case of multiple matching ClusterCIDR resources, the allocator will attempt to break ties using internal heuristics, but any ClusterCIDR whose node selector matches the Node may be used.", "": "ClusterCIDR represents a single configuration for per-Node Pod CIDR allocations when the MultiCIDRRangeAllocator is enabled (see the config for kube-controller-manager). A cluster may have any number of ClusterCIDR resources, all of which will be considered when allocating a CIDR for a Node. A ClusterCIDR is eligible to be used for a given Node when the node selector matches the node in question and has free CIDRs to allocate. In case of multiple matching ClusterCIDR resources, the allocator will attempt to break ties using internal heuristics, but any ClusterCIDR whose node selector matches the Node may be used.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "spec": "spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
} }
func (ClusterCIDR) SwaggerDoc() map[string]string { func (ClusterCIDR) SwaggerDoc() map[string]string {
@ -40,7 +40,7 @@ func (ClusterCIDR) SwaggerDoc() map[string]string {
var map_ClusterCIDRList = map[string]string{ var map_ClusterCIDRList = map[string]string{
"": "ClusterCIDRList contains a list of ClusterCIDR.", "": "ClusterCIDRList contains a list of ClusterCIDR.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"items": "Items is the list of ClusterCIDRs.", "items": "items is the list of ClusterCIDRs.",
} }
func (ClusterCIDRList) SwaggerDoc() map[string]string { func (ClusterCIDRList) SwaggerDoc() map[string]string {
@ -49,10 +49,10 @@ func (ClusterCIDRList) SwaggerDoc() map[string]string {
var map_ClusterCIDRSpec = map[string]string{ var map_ClusterCIDRSpec = map[string]string{
"": "ClusterCIDRSpec defines the desired state of ClusterCIDR.", "": "ClusterCIDRSpec defines the desired state of ClusterCIDR.",
"nodeSelector": "NodeSelector defines which nodes the config is applicable to. An empty or nil NodeSelector selects all nodes. This field is immutable.", "nodeSelector": "nodeSelector defines which nodes the config is applicable to. An empty or nil nodeSelector selects all nodes. This field is immutable.",
"perNodeHostBits": "PerNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.", "perNodeHostBits": "perNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable.",
"ipv4": "IPv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.", "ipv4": "ipv4 defines an IPv4 IP block in CIDR notation(e.g. \"10.0.0.0/8\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
"ipv6": "IPv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of IPv4 and IPv6 must be specified. This field is immutable.", "ipv6": "ipv6 defines an IPv6 IP block in CIDR notation(e.g. \"2001:db8::/64\"). At least one of ipv4 and ipv6 must be specified. This field is immutable.",
} }
func (ClusterCIDRSpec) SwaggerDoc() map[string]string { func (ClusterCIDRSpec) SwaggerDoc() map[string]string {

78
staging/src/k8s.io/api/networking/v1beta1/generated.proto
View File

@ -33,14 +33,14 @@ option go_package = "k8s.io/api/networking/v1beta1";
// HTTPIngressPath associates a path with a backend. Incoming urls matching the // HTTPIngressPath associates a path with a backend. Incoming urls matching the
// path are forwarded to the backend. // path are forwarded to the backend.
message HTTPIngressPath { message HTTPIngressPath {
// Path is matched against the path of an incoming request. Currently it can // path is matched against the path of an incoming request. Currently it can
// contain characters disallowed from the conventional "path" part of a URL // 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 // as defined by RFC 3986. Paths must begin with a '/' and must be present
// when using PathType with value "Exact" or "Prefix". // when using PathType with value "Exact" or "Prefix".
// +optional // +optional
optional string path = 1; optional string path = 1;
// PathType determines the interpretation of the Path matching. PathType can // pathType determines the interpretation of the path matching. PathType can
// be one of the following values: // be one of the following values:
// * Exact: Matches the URL path exactly. // * Exact: Matches the URL path exactly.
// * Prefix: Matches based on a URL path prefix split by '/'. Matching is // * Prefix: Matches based on a URL path prefix split by '/'. Matching is
@ -57,7 +57,7 @@ message HTTPIngressPath {
// Defaults to ImplementationSpecific. // Defaults to ImplementationSpecific.
optional string pathType = 3; optional string pathType = 3;
// Backend defines the referenced service endpoint to which the traffic // backend defines the referenced service endpoint to which the traffic
// will be forwarded to. // will be forwarded to.
optional IngressBackend backend = 2; optional IngressBackend backend = 2;
} }
@ -68,7 +68,7 @@ message HTTPIngressPath {
// to match against everything after the last '/' and before the first '?' // to match against everything after the last '/' and before the first '?'
// or '#'. // or '#'.
message HTTPIngressRuleValue { message HTTPIngressRuleValue {
// A collection of paths that map requests to backends. // paths is a collection of paths that map requests to backends.
repeated HTTPIngressPath paths = 1; repeated HTTPIngressPath paths = 1;
} }
@ -82,12 +82,12 @@ message Ingress {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is the desired state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional IngressSpec spec = 2; optional IngressSpec spec = 2;
// Status is the current state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional IngressStatus status = 3; optional IngressStatus status = 3;
@ -95,15 +95,15 @@ message Ingress {
// IngressBackend describes all endpoints for a given service and port. // IngressBackend describes all endpoints for a given service and port.
message IngressBackend { message IngressBackend {
// Specifies the name of the referenced service. // serviceName specifies the name of the referenced service.
// +optional // +optional
optional string serviceName = 1; optional string serviceName = 1;
// Specifies the port of the referenced service. // servicePort Specifies the port of the referenced service.
// +optional // +optional
optional k8s.io.apimachinery.pkg.util.intstr.IntOrString servicePort = 2; optional k8s.io.apimachinery.pkg.util.intstr.IntOrString servicePort = 2;
// Resource is an ObjectRef to another Kubernetes resource in the namespace // resource is an ObjectRef to another Kubernetes resource in the namespace
// of the Ingress object. If resource is specified, serviceName and servicePort // of the Ingress object. If resource is specified, serviceName and servicePort
// must not be specified. // must not be specified.
// +optional // +optional
@ -121,7 +121,7 @@ message IngressClass {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta metadata = 1;
// Spec is the desired state of the IngressClass. // spec is the desired state of the IngressClass.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
optional IngressClassSpec spec = 2; optional IngressClassSpec spec = 2;
@ -133,30 +133,30 @@ message IngressClassList {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of IngressClasses. // items is the list of IngressClasses.
repeated IngressClass items = 2; repeated IngressClass items = 2;
} }
// IngressClassParametersReference identifies an API object. This can be used // IngressClassParametersReference identifies an API object. This can be used
// to specify a cluster or namespace-scoped resource. // to specify a cluster or namespace-scoped resource.
message IngressClassParametersReference { message IngressClassParametersReference {
// APIGroup is the group for the resource being referenced. If APIGroup is // 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 // not specified, the specified Kind must be in the core API group. For any
// other third-party types, APIGroup is required. // other third-party types, APIGroup is required.
// +optional // +optional
optional string aPIGroup = 1; optional string aPIGroup = 1;
// Kind is the type of resource being referenced. // kind is the type of resource being referenced.
optional string kind = 2; optional string kind = 2;
// Name is the name of resource being referenced. // name is the name of resource being referenced.
optional string name = 3; optional string name = 3;
// Scope represents if this refers to a cluster or namespace scoped resource. // scope represents if this refers to a cluster or namespace scoped resource.
// This may be set to "Cluster" (default) or "Namespace". // This may be set to "Cluster" (default) or "Namespace".
optional string scope = 4; optional string scope = 4;
// Namespace is the namespace of the resource being referenced. This field is // namespace is the namespace of the resource being referenced. This field is
// required when scope is set to "Namespace" and must be unset when scope is set to // required when scope is set to "Namespace" and must be unset when scope is set to
// "Cluster". // "Cluster".
// +optional // +optional
@ -165,15 +165,15 @@ message IngressClassParametersReference {
// IngressClassSpec provides information about the class of an Ingress. // IngressClassSpec provides information about the class of an Ingress.
message IngressClassSpec { message IngressClassSpec {
// Controller refers to the name of the controller that should handle this // controller refers to the name of the controller that should handle this
// class. This allows for different "flavors" that are controlled by the // class. This allows for different "flavors" that are controlled by the
// same controller. For example, you may have different Parameters for the // same controller. For example, you may have different parameters for the
// same implementing controller. This should be specified as a // same implementing controller. This should be specified as a
// domain-prefixed path no more than 250 characters in length, e.g. // domain-prefixed path no more than 250 characters in length, e.g.
// "acme.io/ingress-controller". This field is immutable. // "acme.io/ingress-controller". This field is immutable.
optional string controller = 1; optional string controller = 1;
// Parameters is a link to a custom resource containing additional // parameters is a link to a custom resource containing additional
// configuration for the controller. This is optional if the controller does // configuration for the controller. This is optional if the controller does
// not require extra parameters. // not require extra parameters.
// +optional // +optional
@ -187,21 +187,21 @@ message IngressList {
// +optional // +optional
optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1; optional k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta metadata = 1;
// Items is the list of Ingress. // items is the list of Ingress.
repeated Ingress items = 2; repeated Ingress items = 2;
} }
// IngressLoadBalancerIngress represents the status of a load-balancer ingress point. // IngressLoadBalancerIngress represents the status of a load-balancer ingress point.
message IngressLoadBalancerIngress { message IngressLoadBalancerIngress {
// IP is set for load-balancer ingress points that are IP based. // ip is set for load-balancer ingress points that are IP based.
// +optional // +optional
optional string ip = 1; optional string ip = 1;
// Hostname is set for load-balancer ingress points that are DNS based. // hostname is set for load-balancer ingress points that are DNS based.
// +optional // +optional
optional string hostname = 2; optional string hostname = 2;
// Ports provides information about the ports exposed by this LoadBalancer. // ports provides information about the ports exposed by this LoadBalancer.
// +listType=atomic // +listType=atomic
// +optional // +optional
repeated IngressPortStatus ports = 4; repeated IngressPortStatus ports = 4;
@ -209,21 +209,21 @@ message IngressLoadBalancerIngress {
// LoadBalancerStatus represents the status of a load-balancer. // LoadBalancerStatus represents the status of a load-balancer.
message IngressLoadBalancerStatus { message IngressLoadBalancerStatus {
// Ingress is a list containing ingress points for the load-balancer. // ingress is a list containing ingress points for the load-balancer.
// +optional // +optional
repeated IngressLoadBalancerIngress ingress = 1; repeated IngressLoadBalancerIngress ingress = 1;
} }
// IngressPortStatus represents the error condition of a service port // IngressPortStatus represents the error condition of a service port
message IngressPortStatus { message IngressPortStatus {
// Port is the port number of the ingress port. // port is the port number of the ingress port.
optional int32 port = 1; optional int32 port = 1;
// Protocol is the protocol of the ingress port. // protocol is the protocol of the ingress port.
// The supported values are: "TCP", "UDP", "SCTP" // The supported values are: "TCP", "UDP", "SCTP"
optional string protocol = 2; optional string protocol = 2;
// Error is to record the problem with the service port // error is to record the problem with the service port
// The format of the error shall comply with the following rules: // 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 // - built-in error values shall be specified in this file and those shall use
// CamelCase names // CamelCase names
@ -242,7 +242,7 @@ message IngressPortStatus {
// the related backend services. Incoming requests are first evaluated for a host // the related backend services. Incoming requests are first evaluated for a host
// match, then routed to the backend associated with the matching IngressRuleValue. // match, then routed to the backend associated with the matching IngressRuleValue.
message IngressRule { message IngressRule {
// Host is the fully qualified domain name of a network host, as defined by RFC 3986. // 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 // Note the following deviations from the "host" part of the
// URI as defined in RFC 3986: // URI as defined in RFC 3986:
// 1. IPs are not allowed. Currently an IngressRuleValue can only apply to // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
@ -255,7 +255,7 @@ message IngressRule {
// IngressRuleValue. If the host is unspecified, the Ingress routes all // IngressRuleValue. If the host is unspecified, the Ingress routes all
// traffic based on the specified IngressRuleValue. // traffic based on the specified IngressRuleValue.
// //
// Host can be "precise" which is a domain name without the terminating dot of // 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 // 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"). // prefixed with a single wildcard label (e.g. "*.foo.com").
// The wildcard character '*' must appear by itself as the first DNS label and // The wildcard character '*' must appear by itself as the first DNS label and
@ -287,7 +287,7 @@ message IngressRuleValue {
// IngressSpec describes the Ingress the user wishes to exist. // IngressSpec describes the Ingress the user wishes to exist.
message IngressSpec { message IngressSpec {
// IngressClassName is the name of the IngressClass cluster resource. The // ingressClassName is the name of the IngressClass cluster resource. The
// associated IngressClass defines which controller will implement the // associated IngressClass defines which controller will implement the
// resource. This replaces the deprecated `kubernetes.io/ingress.class` // resource. This replaces the deprecated `kubernetes.io/ingress.class`
// annotation. For backwards compatibility, when that annotation is set, it // annotation. For backwards compatibility, when that annotation is set, it
@ -300,44 +300,44 @@ message IngressSpec {
// +optional // +optional
optional string ingressClassName = 4; optional string ingressClassName = 4;
// A default backend capable of servicing requests that don't match any // backend is the default backend capable of servicing requests that don't match any
// rule. At least one of 'backend' or 'rules' must be specified. This field // rule. At least one of 'backend' or 'rules' must be specified. This field
// is optional to allow the loadbalancer controller or defaulting logic to // is optional to allow the loadbalancer controller or defaulting logic to
// specify a global default. // specify a global default.
// +optional // +optional
optional IngressBackend backend = 1; optional IngressBackend backend = 1;
// TLS configuration. Currently the Ingress only supports a single TLS // tls represents the TLS configuration. Currently the Ingress only supports a
// port, 443. If multiple members of this list specify different hosts, they // single TLS port, 443. If multiple members of this list specify different hosts,
// will be multiplexed on the same port according to the hostname specified // they will be multiplexed on the same port according to the hostname specified
// through the SNI TLS extension, if the ingress controller fulfilling the // through the SNI TLS extension, if the ingress controller fulfilling the
// ingress supports SNI. // ingress supports SNI.
// +optional // +optional
repeated IngressTLS tls = 2; repeated IngressTLS tls = 2;
// A list of host rules used to configure the Ingress. If unspecified, or // 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. // no rule matches, all traffic is sent to the default backend.
// +optional // +optional
repeated IngressRule rules = 3; repeated IngressRule rules = 3;
} }
// IngressStatus describe the current state of the Ingress. // IngressStatus describes the current state of the Ingress.
message IngressStatus { message IngressStatus {
// LoadBalancer contains the current status of the load-balancer. // loadBalancer contains the current status of the load-balancer.
// +optional // +optional
optional IngressLoadBalancerStatus loadBalancer = 1; optional IngressLoadBalancerStatus loadBalancer = 1;
} }
// IngressTLS describes the transport layer security associated with an Ingress. // IngressTLS describes the transport layer security associated with an Ingress.
message IngressTLS { message IngressTLS {
// Hosts are a list of hosts included in the TLS certificate. The values in // 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 // this list must match the name/s used in the tlsSecret. Defaults to the
// wildcard host setting for the loadbalancer controller fulfilling this // wildcard host setting for the loadbalancer controller fulfilling this
// Ingress, if left unspecified. // Ingress, if left unspecified.
// +optional // +optional
repeated string hosts = 1; repeated string hosts = 1;
// SecretName is the name of the secret used to terminate TLS traffic on // 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 // 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" // 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 // header field used by an IngressRule, the SNI host is used for termination

87
staging/src/k8s.io/api/networking/v1beta1/types.go
View File

@ -34,17 +34,18 @@ import (
// based virtual hosting etc. // based virtual hosting etc.
type Ingress struct { type Ingress struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is the desired state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec IngressSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec IngressSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// Status is the current state of the Ingress. // 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 // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Status IngressStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` Status IngressStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
@ -58,18 +59,19 @@ type Ingress struct {
// IngressList is a collection of Ingress. // IngressList is a collection of Ingress.
type IngressList struct { type IngressList struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of Ingress. // items is the list of Ingress.
Items []Ingress `json:"items" protobuf:"bytes,2,rep,name=items"` Items []Ingress `json:"items" protobuf:"bytes,2,rep,name=items"`
} }
// IngressSpec describes the Ingress the user wishes to exist. // IngressSpec describes the Ingress the user wishes to exist.
type IngressSpec struct { type IngressSpec struct {
// IngressClassName is the name of the IngressClass cluster resource. The // ingressClassName is the name of the IngressClass cluster resource. The
// associated IngressClass defines which controller will implement the // associated IngressClass defines which controller will implement the
// resource. This replaces the deprecated `kubernetes.io/ingress.class` // resource. This replaces the deprecated `kubernetes.io/ingress.class`
// annotation. For backwards compatibility, when that annotation is set, it // annotation. For backwards compatibility, when that annotation is set, it
@ -82,22 +84,22 @@ type IngressSpec struct {
// +optional // +optional
IngressClassName *string `json:"ingressClassName,omitempty" protobuf:"bytes,4,opt,name=ingressClassName"` IngressClassName *string `json:"ingressClassName,omitempty" protobuf:"bytes,4,opt,name=ingressClassName"`
// A default backend capable of servicing requests that don't match any // backend is the default backend capable of servicing requests that don't match any
// rule. At least one of 'backend' or 'rules' must be specified. This field // rule. At least one of 'backend' or 'rules' must be specified. This field
// is optional to allow the loadbalancer controller or defaulting logic to // is optional to allow the loadbalancer controller or defaulting logic to
// specify a global default. // specify a global default.
// +optional // +optional
Backend *IngressBackend `json:"backend,omitempty" protobuf:"bytes,1,opt,name=backend"` Backend *IngressBackend `json:"backend,omitempty" protobuf:"bytes,1,opt,name=backend"`
// TLS configuration. Currently the Ingress only supports a single TLS // tls represents the TLS configuration. Currently the Ingress only supports a
// port, 443. If multiple members of this list specify different hosts, they // single TLS port, 443. If multiple members of this list specify different hosts,
// will be multiplexed on the same port according to the hostname specified // they will be multiplexed on the same port according to the hostname specified
// through the SNI TLS extension, if the ingress controller fulfilling the // through the SNI TLS extension, if the ingress controller fulfilling the
// ingress supports SNI. // ingress supports SNI.
// +optional // +optional
TLS []IngressTLS `json:"tls,omitempty" protobuf:"bytes,2,rep,name=tls"` TLS []IngressTLS `json:"tls,omitempty" protobuf:"bytes,2,rep,name=tls"`
// A list of host rules used to configure the Ingress. If unspecified, or // 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. // no rule matches, all traffic is sent to the default backend.
// +optional // +optional
Rules []IngressRule `json:"rules,omitempty" protobuf:"bytes,3,rep,name=rules"` Rules []IngressRule `json:"rules,omitempty" protobuf:"bytes,3,rep,name=rules"`
@ -106,13 +108,14 @@ type IngressSpec struct {
// IngressTLS describes the transport layer security associated with an Ingress. // IngressTLS describes the transport layer security associated with an Ingress.
type IngressTLS struct { type IngressTLS struct {
// Hosts are a list of hosts included in the TLS certificate. The values in // 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 // this list must match the name/s used in the tlsSecret. Defaults to the
// wildcard host setting for the loadbalancer controller fulfilling this // wildcard host setting for the loadbalancer controller fulfilling this
// Ingress, if left unspecified. // Ingress, if left unspecified.
// +optional // +optional
Hosts []string `json:"hosts,omitempty" protobuf:"bytes,1,rep,name=hosts"` Hosts []string `json:"hosts,omitempty" protobuf:"bytes,1,rep,name=hosts"`
// SecretName is the name of the secret used to terminate TLS traffic on
// 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 // 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" // 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 // header field used by an IngressRule, the SNI host is used for termination
@ -122,31 +125,31 @@ type IngressTLS struct {
// TODO: Consider specifying different modes of termination, protocols etc. // TODO: Consider specifying different modes of termination, protocols etc.
} }
// IngressStatus describe the current state of the Ingress. // IngressStatus describes the current state of the Ingress.
type IngressStatus struct { type IngressStatus struct {
// LoadBalancer contains the current status of the load-balancer. // loadBalancer contains the current status of the load-balancer.
// +optional // +optional
LoadBalancer IngressLoadBalancerStatus `json:"loadBalancer,omitempty" protobuf:"bytes,1,opt,name=loadBalancer"` LoadBalancer IngressLoadBalancerStatus `json:"loadBalancer,omitempty" protobuf:"bytes,1,opt,name=loadBalancer"`
} }
// LoadBalancerStatus represents the status of a load-balancer. // LoadBalancerStatus represents the status of a load-balancer.
type IngressLoadBalancerStatus struct { type IngressLoadBalancerStatus struct {
// Ingress is a list containing ingress points for the load-balancer. // ingress is a list containing ingress points for the load-balancer.
// +optional // +optional
Ingress []IngressLoadBalancerIngress `json:"ingress,omitempty" protobuf:"bytes,1,rep,name=ingress"` Ingress []IngressLoadBalancerIngress `json:"ingress,omitempty" protobuf:"bytes,1,rep,name=ingress"`
} }
// IngressLoadBalancerIngress represents the status of a load-balancer ingress point. // IngressLoadBalancerIngress represents the status of a load-balancer ingress point.
type IngressLoadBalancerIngress struct { type IngressLoadBalancerIngress struct {
// IP is set for load-balancer ingress points that are IP based. // ip is set for load-balancer ingress points that are IP based.
// +optional // +optional
IP string `json:"ip,omitempty" protobuf:"bytes,1,opt,name=ip"` IP string `json:"ip,omitempty" protobuf:"bytes,1,opt,name=ip"`
// Hostname is set for load-balancer ingress points that are DNS based. // hostname is set for load-balancer ingress points that are DNS based.
// +optional // +optional
Hostname string `json:"hostname,omitempty" protobuf:"bytes,2,opt,name=hostname"` Hostname string `json:"hostname,omitempty" protobuf:"bytes,2,opt,name=hostname"`
// Ports provides information about the ports exposed by this LoadBalancer. // ports provides information about the ports exposed by this LoadBalancer.
// +listType=atomic // +listType=atomic
// +optional // +optional
Ports []IngressPortStatus `json:"ports,omitempty" protobuf:"bytes,4,rep,name=ports"` Ports []IngressPortStatus `json:"ports,omitempty" protobuf:"bytes,4,rep,name=ports"`
@ -154,14 +157,14 @@ type IngressLoadBalancerIngress struct {
// IngressPortStatus represents the error condition of a service port // IngressPortStatus represents the error condition of a service port
type IngressPortStatus struct { type IngressPortStatus struct {
// Port is the port number of the ingress port. // port is the port number of the ingress port.
Port int32 `json:"port" protobuf:"varint,1,opt,name=port"` Port int32 `json:"port" protobuf:"varint,1,opt,name=port"`
// Protocol is the protocol of the ingress port. // protocol is the protocol of the ingress port.
// The supported values are: "TCP", "UDP", "SCTP" // The supported values are: "TCP", "UDP", "SCTP"
Protocol v1.Protocol `json:"protocol" protobuf:"bytes,2,opt,name=protocol,casttype=Protocol"` Protocol v1.Protocol `json:"protocol" protobuf:"bytes,2,opt,name=protocol,casttype=Protocol"`
// Error is to record the problem with the service port // error is to record the problem with the service port
// The format of the error shall comply with the following rules: // 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 // - built-in error values shall be specified in this file and those shall use
// CamelCase names // CamelCase names
@ -180,7 +183,7 @@ type IngressPortStatus struct {
// the related backend services. Incoming requests are first evaluated for a host // the related backend services. Incoming requests are first evaluated for a host
// match, then routed to the backend associated with the matching IngressRuleValue. // match, then routed to the backend associated with the matching IngressRuleValue.
type IngressRule struct { type IngressRule struct {
// Host is the fully qualified domain name of a network host, as defined by RFC 3986. // 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 // Note the following deviations from the "host" part of the
// URI as defined in RFC 3986: // URI as defined in RFC 3986:
// 1. IPs are not allowed. Currently an IngressRuleValue can only apply to // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to
@ -193,7 +196,7 @@ type IngressRule struct {
// IngressRuleValue. If the host is unspecified, the Ingress routes all // IngressRuleValue. If the host is unspecified, the Ingress routes all
// traffic based on the specified IngressRuleValue. // traffic based on the specified IngressRuleValue.
// //
// Host can be "precise" which is a domain name without the terminating dot of // 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 // 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"). // prefixed with a single wildcard label (e.g. "*.foo.com").
// The wildcard character '*' must appear by itself as the first DNS label and // The wildcard character '*' must appear by itself as the first DNS label and
@ -204,6 +207,7 @@ type IngressRule struct {
// is to equal to the suffix (removing the first label) of the wildcard rule. // is to equal to the suffix (removing the first label) of the wildcard rule.
// +optional // +optional
Host string `json:"host,omitempty" protobuf:"bytes,1,opt,name=host"` Host string `json:"host,omitempty" protobuf:"bytes,1,opt,name=host"`
// IngressRuleValue represents a rule to route requests for this IngressRule. // IngressRuleValue represents a rule to route requests for this IngressRule.
// If unspecified, the rule defaults to a http catch-all. Whether that sends // If unspecified, the rule defaults to a http catch-all. Whether that sends
// just traffic matching the host to the default backend or all traffic to the // just traffic matching the host to the default backend or all traffic to the
@ -234,7 +238,7 @@ type IngressRuleValue struct {
// to match against everything after the last '/' and before the first '?' // to match against everything after the last '/' and before the first '?'
// or '#'. // or '#'.
type HTTPIngressRuleValue struct { type HTTPIngressRuleValue struct {
// A collection of paths that map requests to backends. // paths is a collection of paths that map requests to backends.
Paths []HTTPIngressPath `json:"paths" protobuf:"bytes,1,rep,name=paths"` Paths []HTTPIngressPath `json:"paths" protobuf:"bytes,1,rep,name=paths"`
// TODO: Consider adding fields for ingress-type specific global // TODO: Consider adding fields for ingress-type specific global
// options usable by a loadbalancer, like http keep-alive. // options usable by a loadbalancer, like http keep-alive.
@ -273,14 +277,14 @@ const (
// HTTPIngressPath associates a path with a backend. Incoming urls matching the // HTTPIngressPath associates a path with a backend. Incoming urls matching the
// path are forwarded to the backend. // path are forwarded to the backend.
type HTTPIngressPath struct { type HTTPIngressPath struct {
// Path is matched against the path of an incoming request. Currently it can // path is matched against the path of an incoming request. Currently it can
// contain characters disallowed from the conventional "path" part of a URL // 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 // as defined by RFC 3986. Paths must begin with a '/' and must be present
// when using PathType with value "Exact" or "Prefix". // when using PathType with value "Exact" or "Prefix".
// +optional // +optional
Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"` Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"`
// PathType determines the interpretation of the Path matching. PathType can // pathType determines the interpretation of the path matching. PathType can
// be one of the following values: // be one of the following values:
// * Exact: Matches the URL path exactly. // * Exact: Matches the URL path exactly.
// * Prefix: Matches based on a URL path prefix split by '/'. Matching is // * Prefix: Matches based on a URL path prefix split by '/'. Matching is
@ -297,22 +301,22 @@ type HTTPIngressPath struct {
// Defaults to ImplementationSpecific. // Defaults to ImplementationSpecific.
PathType *PathType `json:"pathType,omitempty" protobuf:"bytes,3,opt,name=pathType"` PathType *PathType `json:"pathType,omitempty" protobuf:"bytes,3,opt,name=pathType"`
// Backend defines the referenced service endpoint to which the traffic // backend defines the referenced service endpoint to which the traffic
// will be forwarded to. // will be forwarded to.
Backend IngressBackend `json:"backend" protobuf:"bytes,2,opt,name=backend"` Backend IngressBackend `json:"backend" protobuf:"bytes,2,opt,name=backend"`
} }
// IngressBackend describes all endpoints for a given service and port. // IngressBackend describes all endpoints for a given service and port.
type IngressBackend struct { type IngressBackend struct {
// Specifies the name of the referenced service. // serviceName specifies the name of the referenced service.
// +optional // +optional
ServiceName string `json:"serviceName,omitempty" protobuf:"bytes,1,opt,name=serviceName"` ServiceName string `json:"serviceName,omitempty" protobuf:"bytes,1,opt,name=serviceName"`
// Specifies the port of the referenced service. // servicePort Specifies the port of the referenced service.
// +optional // +optional
ServicePort intstr.IntOrString `json:"servicePort,omitempty" protobuf:"bytes,2,opt,name=servicePort"` ServicePort intstr.IntOrString `json:"servicePort,omitempty" protobuf:"bytes,2,opt,name=servicePort"`
// Resource is an ObjectRef to another Kubernetes resource in the namespace // resource is an ObjectRef to another Kubernetes resource in the namespace
// of the Ingress object. If resource is specified, serviceName and servicePort // of the Ingress object. If resource is specified, serviceName and servicePort
// must not be specified. // must not be specified.
// +optional // +optional
@ -333,12 +337,13 @@ type IngressBackend struct {
// resources without a class specified will be assigned this default class. // resources without a class specified will be assigned this default class.
type IngressClass struct { type IngressClass struct {
metav1.TypeMeta `json:",inline"` metav1.TypeMeta `json:",inline"`
// Standard object's metadata. // Standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional // +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec is the desired state of the IngressClass. // spec is the desired state of the IngressClass.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
// +optional // +optional
Spec IngressClassSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` Spec IngressClassSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
@ -346,15 +351,15 @@ type IngressClass struct {
// IngressClassSpec provides information about the class of an Ingress. // IngressClassSpec provides information about the class of an Ingress.
type IngressClassSpec struct { type IngressClassSpec struct {
// Controller refers to the name of the controller that should handle this // controller refers to the name of the controller that should handle this
// class. This allows for different "flavors" that are controlled by the // class. This allows for different "flavors" that are controlled by the
// same controller. For example, you may have different Parameters for the // same controller. For example, you may have different parameters for the
// same implementing controller. This should be specified as a // same implementing controller. This should be specified as a
// domain-prefixed path no more than 250 characters in length, e.g. // domain-prefixed path no more than 250 characters in length, e.g.
// "acme.io/ingress-controller". This field is immutable. // "acme.io/ingress-controller". This field is immutable.
Controller string `json:"controller,omitempty" protobuf:"bytes,1,opt,name=controller"` Controller string `json:"controller,omitempty" protobuf:"bytes,1,opt,name=controller"`
// Parameters is a link to a custom resource containing additional // parameters is a link to a custom resource containing additional
// configuration for the controller. This is optional if the controller does // configuration for the controller. This is optional if the controller does
// not require extra parameters. // not require extra parameters.
// +optional // +optional
@ -373,19 +378,23 @@ const (
// IngressClassParametersReference identifies an API object. This can be used // IngressClassParametersReference identifies an API object. This can be used
// to specify a cluster or namespace-scoped resource. // to specify a cluster or namespace-scoped resource.
type IngressClassParametersReference struct { type IngressClassParametersReference struct {
// APIGroup is the group for the resource being referenced. If APIGroup is // 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 // not specified, the specified Kind must be in the core API group. For any
// other third-party types, APIGroup is required. // other third-party types, APIGroup is required.
// +optional // +optional
APIGroup *string `json:"apiGroup,omitempty" protobuf:"bytes,1,opt,name=aPIGroup"` APIGroup *string `json:"apiGroup,omitempty" protobuf:"bytes,1,opt,name=aPIGroup"`
// Kind is the type of resource being referenced.
// kind is the type of resource being referenced.
Kind string `json:"kind" protobuf:"bytes,2,opt,name=kind"` Kind string `json:"kind" protobuf:"bytes,2,opt,name=kind"`
// Name is the name of resource being referenced.
// name is the name of resource being referenced.
Name string `json:"name" protobuf:"bytes,3,opt,name=name"` Name string `json:"name" protobuf:"bytes,3,opt,name=name"`
// Scope represents if this refers to a cluster or namespace scoped resource.
// scope represents if this refers to a cluster or namespace scoped resource.
// This may be set to "Cluster" (default) or "Namespace". // This may be set to "Cluster" (default) or "Namespace".
Scope *string `json:"scope" protobuf:"bytes,4,opt,name=scope"` Scope *string `json:"scope" protobuf:"bytes,4,opt,name=scope"`
// Namespace is the namespace of the resource being referenced. This field is
// namespace is the namespace of the resource being referenced. This field is
// required when scope is set to "Namespace" and must be unset when scope is set to // required when scope is set to "Namespace" and must be unset when scope is set to
// "Cluster". // "Cluster".
// +optional // +optional
@ -404,6 +413,6 @@ type IngressClassList struct {
// +optional // +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is the list of IngressClasses. // items is the list of IngressClasses.
Items []IngressClass `json:"items" protobuf:"bytes,2,rep,name=items"` Items []IngressClass `json:"items" protobuf:"bytes,2,rep,name=items"`
} }

70
staging/src/k8s.io/api/networking/v1beta1/types_swagger_doc_generated.go generated
View File

@ -29,9 +29,9 @@ package v1beta1
// AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT. // AUTO-GENERATED FUNCTIONS START HERE. DO NOT EDIT.
var map_HTTPIngressPath = map[string]string{ var map_HTTPIngressPath = map[string]string{
"": "HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.", "": "HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.",
"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\".", "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\".",
"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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types. Defaults to ImplementationSpecific.", "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\n done on a path element by element basis. A path element refers is the\n list of labels in the path split by the '/' separator. A request is a\n match for path p if every p is an element-wise prefix of p of the\n request path. Note that if the last element of the path is a substring\n of the last element in request path, it is not a match (e.g. /foo/bar\n matches /foo/bar/baz, but does not match /foo/barbaz).\n* ImplementationSpecific: Interpretation of the Path matching is up to\n the IngressClass. Implementations can treat this as a separate PathType\n or treat it identically to Prefix or Exact path types.\nImplementations are required to support all path types. Defaults to ImplementationSpecific.",
"backend": "Backend defines the referenced service endpoint to which the traffic will be forwarded to.", "backend": "backend defines the referenced service endpoint to which the traffic will be forwarded to.",
} }
func (HTTPIngressPath) SwaggerDoc() map[string]string { func (HTTPIngressPath) SwaggerDoc() map[string]string {
@ -40,7 +40,7 @@ func (HTTPIngressPath) SwaggerDoc() map[string]string {
var map_HTTPIngressRuleValue = map[string]string{ var map_HTTPIngressRuleValue = map[string]string{
"": "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 '#'.", "": "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 '#'.",
"paths": "A collection of paths that map requests to backends.", "paths": "paths is a collection of paths that map requests to backends.",
} }
func (HTTPIngressRuleValue) SwaggerDoc() map[string]string { func (HTTPIngressRuleValue) SwaggerDoc() map[string]string {
@ -50,8 +50,8 @@ func (HTTPIngressRuleValue) SwaggerDoc() map[string]string {
var map_Ingress = map[string]string{ var map_Ingress = map[string]string{
"": "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.", "": "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.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"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", "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",
"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", "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",
} }
func (Ingress) SwaggerDoc() map[string]string { func (Ingress) SwaggerDoc() map[string]string {
@ -60,9 +60,9 @@ func (Ingress) SwaggerDoc() map[string]string {
var map_IngressBackend = map[string]string{ var map_IngressBackend = map[string]string{
"": "IngressBackend describes all endpoints for a given service and port.", "": "IngressBackend describes all endpoints for a given service and port.",
"serviceName": "Specifies the name of the referenced service.", "serviceName": "serviceName specifies the name of the referenced service.",
"servicePort": "Specifies the port of the referenced service.", "servicePort": "servicePort Specifies the port of the referenced service.",
"resource": "Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.", "resource": "resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified.",
} }
func (IngressBackend) SwaggerDoc() map[string]string { func (IngressBackend) SwaggerDoc() map[string]string {
@ -72,7 +72,7 @@ func (IngressBackend) SwaggerDoc() map[string]string {
var map_IngressClass = map[string]string{ var map_IngressClass = map[string]string{
"": "IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.", "": "IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"spec": "Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "spec": "spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
} }
func (IngressClass) SwaggerDoc() map[string]string { func (IngressClass) SwaggerDoc() map[string]string {
@ -82,7 +82,7 @@ func (IngressClass) SwaggerDoc() map[string]string {
var map_IngressClassList = map[string]string{ var map_IngressClassList = map[string]string{
"": "IngressClassList is a collection of IngressClasses.", "": "IngressClassList is a collection of IngressClasses.",
"metadata": "Standard list metadata.", "metadata": "Standard list metadata.",
"items": "Items is the list of IngressClasses.", "items": "items is the list of IngressClasses.",
} }
func (IngressClassList) SwaggerDoc() map[string]string { func (IngressClassList) SwaggerDoc() map[string]string {
@ -91,11 +91,11 @@ func (IngressClassList) SwaggerDoc() map[string]string {
var map_IngressClassParametersReference = map[string]string{ var map_IngressClassParametersReference = map[string]string{
"": "IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.", "": "IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped 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.", "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.",
"kind": "Kind is the type of resource being referenced.", "kind": "kind is the type of resource being referenced.",
"name": "Name is the name of resource being referenced.", "name": "name is the name of resource being referenced.",
"scope": "Scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".", "scope": "scope represents if this refers to a cluster or namespace scoped resource. This may be set to \"Cluster\" (default) or \"Namespace\".",
"namespace": "Namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".", "namespace": "namespace is the namespace of the resource being referenced. This field is required when scope is set to \"Namespace\" and must be unset when scope is set to \"Cluster\".",
} }
func (IngressClassParametersReference) SwaggerDoc() map[string]string { func (IngressClassParametersReference) SwaggerDoc() map[string]string {
@ -104,8 +104,8 @@ func (IngressClassParametersReference) SwaggerDoc() map[string]string {
var map_IngressClassSpec = map[string]string{ var map_IngressClassSpec = map[string]string{
"": "IngressClassSpec provides information about the class of an Ingress.", "": "IngressClassSpec provides information about the class of an Ingress.",
"controller": "Controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.", "controller": "controller refers to the name of the controller that should handle this class. This allows for different \"flavors\" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. \"acme.io/ingress-controller\". This field is immutable.",
"parameters": "Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.", "parameters": "parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.",
} }
func (IngressClassSpec) SwaggerDoc() map[string]string { func (IngressClassSpec) SwaggerDoc() map[string]string {
@ -115,7 +115,7 @@ func (IngressClassSpec) SwaggerDoc() map[string]string {
var map_IngressList = map[string]string{ var map_IngressList = map[string]string{
"": "IngressList is a collection of Ingress.", "": "IngressList is a collection of Ingress.",
"metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata", "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"items": "Items is the list of Ingress.", "items": "items is the list of Ingress.",
} }
func (IngressList) SwaggerDoc() map[string]string { func (IngressList) SwaggerDoc() map[string]string {
@ -124,9 +124,9 @@ func (IngressList) SwaggerDoc() map[string]string {
var map_IngressLoadBalancerIngress = map[string]string{ var map_IngressLoadBalancerIngress = map[string]string{
"": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.", "": "IngressLoadBalancerIngress represents the status of a load-balancer ingress point.",
"ip": "IP is set for load-balancer ingress points that are IP based.", "ip": "ip is set for load-balancer ingress points that are IP based.",
"hostname": "Hostname is set for load-balancer ingress points that are DNS based.", "hostname": "hostname is set for load-balancer ingress points that are DNS based.",
"ports": "Ports provides information about the ports exposed by this LoadBalancer.", "ports": "ports provides information about the ports exposed by this LoadBalancer.",
} }
func (IngressLoadBalancerIngress) SwaggerDoc() map[string]string { func (IngressLoadBalancerIngress) SwaggerDoc() map[string]string {
@ -135,7 +135,7 @@ func (IngressLoadBalancerIngress) SwaggerDoc() map[string]string {
var map_IngressLoadBalancerStatus = map[string]string{ var map_IngressLoadBalancerStatus = map[string]string{
"": "LoadBalancerStatus represents the status of a load-balancer.", "": "LoadBalancerStatus represents the status of a load-balancer.",
"ingress": "Ingress is a list containing ingress points for the load-balancer.", "ingress": "ingress is a list containing ingress points for the load-balancer.",
} }
func (IngressLoadBalancerStatus) SwaggerDoc() map[string]string { func (IngressLoadBalancerStatus) SwaggerDoc() map[string]string {
@ -144,9 +144,9 @@ func (IngressLoadBalancerStatus) SwaggerDoc() map[string]string {
var map_IngressPortStatus = map[string]string{ var map_IngressPortStatus = map[string]string{
"": "IngressPortStatus represents the error condition of a service port", "": "IngressPortStatus represents the error condition of a service port",
"port": "Port is the port number of the ingress port.", "port": "port is the port number of the ingress port.",
"protocol": "Protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"", "protocol": "protocol is the protocol of the ingress port. The supported values are: \"TCP\", \"UDP\", \"SCTP\"",
"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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.", "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\n CamelCase names\n- cloud provider specific error values must have names that comply with the\n format foo.example.com/CamelCase.",
} }
func (IngressPortStatus) SwaggerDoc() map[string]string { func (IngressPortStatus) SwaggerDoc() map[string]string {
@ -155,7 +155,7 @@ func (IngressPortStatus) SwaggerDoc() map[string]string {
var map_IngressRule = map[string]string{ var map_IngressRule = map[string]string{
"": "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.", "": "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.",
"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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nHost 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.", "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\n the IP in the Spec of the parent Ingress.\n2. The `:` delimiter is not respected because ports are not allowed.\n\t Currently the port of an Ingress is implicitly :80 for http and\n\t :443 for https.\nBoth 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.\n\nhost 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.",
} }
func (IngressRule) SwaggerDoc() map[string]string { func (IngressRule) SwaggerDoc() map[string]string {
@ -172,10 +172,10 @@ func (IngressRuleValue) SwaggerDoc() map[string]string {
var map_IngressSpec = map[string]string{ var map_IngressSpec = map[string]string{
"": "IngressSpec describes the Ingress the user wishes to exist.", "": "IngressSpec describes the Ingress the user wishes to exist.",
"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.", "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.",
"backend": "A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.", "backend": "backend is the default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default.",
"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.", "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.",
"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.", "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.",
} }
func (IngressSpec) SwaggerDoc() map[string]string { func (IngressSpec) SwaggerDoc() map[string]string {
@ -183,8 +183,8 @@ func (IngressSpec) SwaggerDoc() map[string]string {
} }
var map_IngressStatus = map[string]string{ var map_IngressStatus = map[string]string{
"": "IngressStatus describe the current state of the Ingress.", "": "IngressStatus describes the current state of the Ingress.",
"loadBalancer": "LoadBalancer contains the current status of the load-balancer.", "loadBalancer": "loadBalancer contains the current status of the load-balancer.",
} }
func (IngressStatus) SwaggerDoc() map[string]string { func (IngressStatus) SwaggerDoc() map[string]string {
@ -193,8 +193,8 @@ func (IngressStatus) SwaggerDoc() map[string]string {
var map_IngressTLS = map[string]string{ var map_IngressTLS = map[string]string{
"": "IngressTLS describes the transport layer security associated with an Ingress.", "": "IngressTLS describes the transport layer security associated with an Ingress.",
"hosts": "Hosts are 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.", "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.",
"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.", "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.",
} }
func (IngressTLS) SwaggerDoc() map[string]string { func (IngressTLS) SwaggerDoc() map[string]string {