API Reference¶
Packages¶
k8s.ovn.org/v1¶
Package v1 contains API Schema definitions for the network v1 API group
Resource Types¶
EgressService¶
EgressService is a CRD that allows the user to request that the source IP of egress packets originating from all of the pods that are endpoints of the corresponding LoadBalancer Service would be its ingress IP. In addition, it allows the user to request that egress packets originating from all of the pods that are endpoints of the LoadBalancer service would use a different network than the main one.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
k8s.ovn.org/v1 |
||
kind string |
EgressService |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec EgressServiceSpec |
|||
status EgressServiceStatus |
EgressServiceSpec¶
EgressServiceSpec defines the desired state of EgressService
Appears in: - EgressService
| Field | Description | Default | Validation |
|---|---|---|---|
sourceIPBy SourceIPMode |
Determines the source IP of egress traffic originating from the pods backing the LoadBalancer Service. When LoadBalancerIP the source IP is set to its LoadBalancer ingress IP.When Network the source IP is set according to the interface of the Network,leveraging the masquerade rules that are already in place. Typically these rules specify SNAT to the IP of the outgoing interface, which means the packet will typically leave with the IP of the node. |
Enum: [LoadBalancerIP Network] |
|
nodeSelector LabelSelector |
Allows limiting the nodes that can be selected to handle the service's traffic when sourceIPBy=LoadBalancerIP. When present only a node whose labels match the specified selectors can be selected for handling the service's traffic. When it is not specified any node in the cluster can be chosen to manage the service's traffic. |
||
network string |
The network which this service should send egress and corresponding ingress replies to. This is typically implemented as VRF mapping, representing a numeric id or string name of a routing table which by omission uses the default host routing. |
EgressServiceStatus¶
EgressServiceStatus defines the observed state of EgressService
Appears in: - EgressService
| Field | Description | Default | Validation |
|---|---|---|---|
host string |
The name of the node selected to handle the service's traffic. In case sourceIPBy=Network the field will be set to "ALL". |
SourceIPMode¶
Underlying type: string
Validation: - Enum: [LoadBalancerIP Network]
Appears in: - EgressServiceSpec