| /* |
| Copyright 2017 The Kubernetes Authors. |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| */ |
| |
| package v1 |
| |
| import ( |
| "k8s.io/api/core/v1" |
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| "k8s.io/apimachinery/pkg/util/intstr" |
| ) |
| |
| // +genclient |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // NetworkPolicy describes what network traffic is allowed for a set of Pods |
| type NetworkPolicy struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard object's metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Specification of the desired behavior for this NetworkPolicy. |
| // +optional |
| Spec NetworkPolicySpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` |
| } |
| |
| // Policy Type string describes the NetworkPolicy type |
| // This type is beta-level in 1.8 |
| type PolicyType string |
| |
| const ( |
| // PolicyTypeIngress is a NetworkPolicy that affects ingress traffic on selected pods |
| PolicyTypeIngress PolicyType = "Ingress" |
| // PolicyTypeEgress is a NetworkPolicy that affects egress traffic on selected pods |
| PolicyTypeEgress PolicyType = "Egress" |
| ) |
| |
| // NetworkPolicySpec provides the specification of a NetworkPolicy |
| type NetworkPolicySpec struct { |
| // 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 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 |
| // 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) |
| // +optional |
| 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 |
| // 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 |
| // +optional |
| Egress []NetworkPolicyEgressRule `json:"egress,omitempty" protobuf:"bytes,3,rep,name=egress"` |
| |
| // 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 |
| // +optional |
| PolicyTypes []PolicyType `json:"policyTypes,omitempty" protobuf:"bytes,4,rep,name=policyTypes,casttype=PolicyType"` |
| } |
| |
| // 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. |
| type NetworkPolicyIngressRule struct { |
| // 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. |
| // +optional |
| 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. |
| // 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. |
| // +optional |
| From []NetworkPolicyPeer `json:"from,omitempty" protobuf:"bytes,2,rep,name=from"` |
| } |
| |
| // 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 |
| type NetworkPolicyEgressRule struct { |
| // 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. |
| // +optional |
| Ports []NetworkPolicyPort `json:"ports,omitempty" protobuf:"bytes,1,rep,name=ports"` |
| |
| // 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. |
| // +optional |
| To []NetworkPolicyPeer `json:"to,omitempty" protobuf:"bytes,2,rep,name=to"` |
| } |
| |
| // NetworkPolicyPort describes a port to allow traffic on |
| type NetworkPolicyPort struct { |
| // The protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this |
| // field defaults to TCP. |
| // +optional |
| 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 on |
| // a pod. If this field is not provided, this matches all port names and numbers. |
| // +optional |
| Port *intstr.IntOrString `json:"port,omitempty" protobuf:"bytes,2,opt,name=port"` |
| } |
| |
| // IPBlock describes a particular CIDR (Ex. "192.168.1.1/24","2001:db9::/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. |
| type IPBlock struct { |
| // CIDR is a string representing the IP Block |
| // Valid examples are "192.168.1.1/24" or "2001:db9::/64" |
| CIDR string `json:"cidr" protobuf:"bytes,1,name=cidr"` |
| // Except is a slice of CIDRs that should not be included within an IP Block |
| // Valid examples are "192.168.1.1/24" or "2001:db9::/64" |
| // Except values will be rejected if they are outside the CIDR range |
| // +optional |
| Except []string `json:"except,omitempty" protobuf:"bytes,2,rep,name=except"` |
| } |
| |
| // NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of |
| // fields are allowed |
| type NetworkPolicyPeer struct { |
| // This is a label selector which selects Pods. This field follows standard label |
| // selector semantics; if present but empty, it selects all pods. |
| // |
| // If 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. |
| // +optional |
| PodSelector *metav1.LabelSelector `json:"podSelector,omitempty" protobuf:"bytes,1,opt,name=podSelector"` |
| |
| // Selects Namespaces using cluster-scoped labels. This field follows standard label |
| // selector semantics; if present but empty, it selects all namespaces. |
| // |
| // If 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. |
| // +optional |
| 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 |
| // neither of the other fields can be. |
| // +optional |
| IPBlock *IPBlock `json:"ipBlock,omitempty" protobuf:"bytes,3,rep,name=ipBlock"` |
| } |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // NetworkPolicyList is a list of NetworkPolicy objects. |
| type NetworkPolicyList struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard list metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| // +optional |
| metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Items is a list of schema objects. |
| Items []NetworkPolicy `json:"items" protobuf:"bytes,2,rep,name=items"` |
| } |
| |
| // +genclient |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // Ingress is a collection of rules that allow inbound connections to reach the |
| // endpoints defined by a backend. An Ingress can be configured to give services |
| // externally-reachable urls, load balance traffic, terminate SSL, offer name |
| // based virtual hosting etc. |
| type Ingress struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard object's metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // 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 |
| // +optional |
| Spec IngressSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` |
| |
| // 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 |
| // +optional |
| Status IngressStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"` |
| } |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // IngressList is a collection of Ingress. |
| type IngressList struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard object's metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| // +optional |
| metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Items is the list of Ingress. |
| Items []Ingress `json:"items" protobuf:"bytes,2,rep,name=items"` |
| } |
| |
| // IngressSpec describes the Ingress the user wishes to exist. |
| type IngressSpec struct { |
| // 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. |
| // +optional |
| IngressClassName *string `json:"ingressClassName,omitempty" protobuf:"bytes,4,opt,name=ingressClassName"` |
| |
| // 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. |
| // +optional |
| DefaultBackend *IngressBackend `json:"defaultBackend,omitempty" protobuf:"bytes,1,opt,name=defaultBackend"` |
| |
| // 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. |
| // +listType=atomic |
| // +optional |
| TLS []IngressTLS `json:"tls,omitempty" protobuf:"bytes,2,rep,name=tls"` |
| |
| // A list of host rules used to configure the Ingress. If unspecified, or |
| // no rule matches, all traffic is sent to the default backend. |
| // +listType=atomic |
| // +optional |
| Rules []IngressRule `json:"rules,omitempty" protobuf:"bytes,3,rep,name=rules"` |
| } |
| |
| // IngressTLS describes the transport layer security associated with an Ingress. |
| type IngressTLS struct { |
| // 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. |
| // +listType=atomic |
| // +optional |
| Hosts []string `json:"hosts,omitempty" protobuf:"bytes,1,rep,name=hosts"` |
| // 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. |
| // +optional |
| SecretName string `json:"secretName,omitempty" protobuf:"bytes,2,opt,name=secretName"` |
| } |
| |
| // IngressStatus describe the current state of the Ingress. |
| type IngressStatus struct { |
| // LoadBalancer contains the current status of the load-balancer. |
| // +optional |
| LoadBalancer v1.LoadBalancerStatus `json:"loadBalancer,omitempty" protobuf:"bytes,1,opt,name=loadBalancer"` |
| } |
| |
| // IngressRule represents the rules mapping the paths under a specified host to |
| // the related backend services. Incoming requests are first evaluated for a host |
| // match, then routed to the backend associated with the matching IngressRuleValue. |
| type IngressRule struct { |
| // Host is the fully qualified domain name of a network host, as defined by RFC 3986. |
| // Note the following deviations from the "host" part of the |
| // URI as defined in RFC 3986: |
| // 1. IPs are not allowed. Currently an IngressRuleValue can only apply to |
| // the IP in the Spec of the parent Ingress. |
| // 2. The `:` delimiter is not respected because ports are not allowed. |
| // Currently the port of an Ingress is implicitly :80 for http and |
| // :443 for https. |
| // Both these may change in the future. |
| // Incoming requests are matched against the host before the |
| // IngressRuleValue. If the host is unspecified, the Ingress routes all |
| // traffic based on the specified IngressRuleValue. |
| // |
| // Host can be "precise" which is a domain name without the terminating dot of |
| // a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name |
| // prefixed with a single wildcard label (e.g. "*.foo.com"). |
| // The wildcard character '*' must appear by itself as the first DNS label and |
| // matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). |
| // Requests will be matched against the Host field in the following way: |
| // 1. If Host is precise, the request matches this rule if the http host header is equal to Host. |
| // 2. If Host is a wildcard, then the request matches this rule if the http host header |
| // is to equal to the suffix (removing the first label) of the wildcard rule. |
| // +optional |
| Host string `json:"host,omitempty" protobuf:"bytes,1,opt,name=host"` |
| // IngressRuleValue represents a rule to route requests for this IngressRule. |
| // 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 |
| // default backend, is left to the controller fulfilling the Ingress. Http is |
| // currently the only supported IngressRuleValue. |
| // +optional |
| IngressRuleValue `json:",inline,omitempty" protobuf:"bytes,2,opt,name=ingressRuleValue"` |
| } |
| |
| // IngressRuleValue represents a rule to apply against incoming requests. If the |
| // rule is satisfied, the request is routed to the specified backend. Currently |
| // mixing different types of rules in a single Ingress is disallowed, so exactly |
| // one of the following must be set. |
| type IngressRuleValue struct { |
| // +optional |
| HTTP *HTTPIngressRuleValue `json:"http,omitempty" protobuf:"bytes,1,opt,name=http"` |
| } |
| |
| // HTTPIngressRuleValue is a list of http selectors pointing to backends. |
| // In the example: http://<host>/<path>?<searchpart> -> backend where |
| // where parts of the url correspond to RFC 3986, this resource will be used |
| // to match against everything after the last '/' and before the first '?' |
| // or '#'. |
| type HTTPIngressRuleValue struct { |
| // A collection of paths that map requests to backends. |
| // +listType=atomic |
| Paths []HTTPIngressPath `json:"paths" protobuf:"bytes,1,rep,name=paths"` |
| } |
| |
| // PathType represents the type of path referred to by a HTTPIngressPath. |
| type PathType string |
| |
| const ( |
| // PathTypeExact matches the URL path exactly and with case sensitivity. |
| PathTypeExact = PathType("Exact") |
| |
| // PathTypePrefix 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. |
| PathTypePrefix = PathType("Prefix") |
| |
| // PathTypeImplementationSpecific matching is up to the IngressClass. |
| // Implementations can treat this as a separate PathType or treat it |
| // identically to Prefix or Exact path types. |
| PathTypeImplementationSpecific = PathType("ImplementationSpecific") |
| ) |
| |
| // HTTPIngressPath associates a path with a backend. Incoming urls matching the |
| // path are forwarded to the backend. |
| type HTTPIngressPath struct { |
| // 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 '/'. When unspecified, |
| // all paths from incoming requests are matched. |
| // +optional |
| Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"` |
| |
| // PathType determines the interpretation of the Path matching. PathType can |
| // be one of the following values: |
| // * Exact: Matches the URL path exactly. |
| // * Prefix: Matches based on a URL path prefix split by '/'. Matching is |
| // done on a path element by element basis. A path element refers is the |
| // list of labels in the path split by the '/' separator. A request is a |
| // match for path p if every p is an element-wise prefix of p of the |
| // request path. Note that if the last element of the path is a substring |
| // of the last element in request path, it is not a match (e.g. /foo/bar |
| // matches /foo/bar/baz, but does not match /foo/barbaz). |
| // * ImplementationSpecific: Interpretation of the Path matching is up to |
| // the IngressClass. Implementations can treat this as a separate PathType |
| // or treat it identically to Prefix or Exact path types. |
| // Implementations are required to support all path types. |
| PathType *PathType `json:"pathType,omitempty" protobuf:"bytes,3,opt,name=pathType"` |
| |
| // Backend defines the referenced service endpoint to which the traffic |
| // will be forwarded to. |
| Backend IngressBackend `json:"backend" protobuf:"bytes,2,opt,name=backend"` |
| } |
| |
| // IngressBackend describes all endpoints for a given service and port. |
| type IngressBackend struct { |
| // Service references a Service as a Backend. |
| // This is a mutually exclusive setting with "Resource". |
| // +optional |
| Service *IngressServiceBackend `json:"service,omitempty" protobuf:"bytes,4,opt,name=service"` |
| |
| // 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". |
| // +optional |
| Resource *v1.TypedLocalObjectReference `json:"resource,omitempty" protobuf:"bytes,3,opt,name=resource"` |
| } |
| |
| // IngressServiceBackend references a Kubernetes Service as a Backend. |
| type IngressServiceBackend struct { |
| // Name is the referenced service. The service must exist in |
| // the same namespace as the Ingress object. |
| Name string `json:"name" protobuf:"bytes,1,opt,name=name"` |
| |
| // Port of the referenced service. A port name or port number |
| // is required for a IngressServiceBackend. |
| Port ServiceBackendPort `json:"port,omitempty" protobuf:"bytes,2,opt,name=port"` |
| } |
| |
| // ServiceBackendPort is the service port being referenced. |
| type ServiceBackendPort struct { |
| // Name is the name of the port on the Service. |
| // This is a mutually exclusive setting with "Number". |
| // +optional |
| Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"` |
| |
| // Number is the numerical port number (e.g. 80) on the Service. |
| // This is a mutually exclusive setting with "Name". |
| // +optional |
| Number int32 `json:"number,omitempty" protobuf:"bytes,2,opt,name=number"` |
| } |
| |
| // +genclient |
| // +genclient:nonNamespaced |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // 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. |
| type IngressClass struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard object's metadata. |
| // More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| // +optional |
| metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // 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 |
| // +optional |
| Spec IngressClassSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"` |
| } |
| |
| // IngressClassSpec provides information about the class of an Ingress. |
| type IngressClassSpec struct { |
| // 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 string `json:"controller,omitempty" protobuf:"bytes,1,opt,name=controller"` |
| |
| // 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. |
| // +optional |
| Parameters *v1.TypedLocalObjectReference `json:"parameters,omitempty" protobuf:"bytes,2,opt,name=parameters"` |
| } |
| |
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object |
| |
| // IngressClassList is a collection of IngressClasses. |
| type IngressClassList struct { |
| metav1.TypeMeta `json:",inline"` |
| // Standard list metadata. |
| // +optional |
| metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"` |
| |
| // Items is the list of IngressClasses. |
| Items []IngressClass `json:"items" protobuf:"bytes,2,rep,name=items"` |
| } |