<strong>egress</strong>IP [k8s.ovn.org/v1] - Network APIs | API reference

Specification
API endpoints
- /apis/k8s.ovn.org/v1/egressips
- /apis/k8s.ovn.org/v1/egressips/{name}

Description

egressIP is a CRD allowing the user to define a fixed source IP for all egress traffic originating from any pods which match the egressIP resource according to its spec definition.

Type

object

Required

spec

Specification

Property Type Description

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`object`	Specification of the desired behavior of egressIP.
`status`	`object`	Observed status of egressIP. Read-only.

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

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

spec

object

Specification of the desired behavior of egressIP.

status

object

Observed status of egressIP. Read-only.

.spec

Description

Specification of the desired behavior of egressIP.

Type

object

Required

egressIPs
namespaceSelector

Property Type Description

Property	Type	Description
`egressIPs`	`array (string)`	egressIPs is the list of egress IP addresses requested. Can be IPv4 and/or IPv6. This field is mandatory.
`namespaceSelector`	`object`	NamespaceSelector applies the egress IP only to the namespace(s) whose label matches this definition. This field is mandatory.
`podSelector`	`object`	PodSelector applies the egress IP only to the pods whose label matches this definition. This field is optional, and in case it is not set: results in the egress IP being applied to all pods in the namespace(s) matched by the NamespaceSelector. In case it is set: is intersected with the NamespaceSelector, thus applying the egress IP to the pods (in the namespace(s) already matched by the NamespaceSelector) which match this pod selector.

egressIPs

array (string)

egressIPs is the list of egress IP addresses requested. Can be IPv4 and/or IPv6. This field is mandatory.

namespaceSelector

object

NamespaceSelector applies the egress IP only to the namespace(s) whose label matches this definition. This field is mandatory.

podSelector

object

PodSelector applies the egress IP only to the pods whose label matches this definition. This field is optional, and in case it is not set: results in the egress IP being applied to all pods in the namespace(s) matched by the NamespaceSelector. In case it is set: is intersected with the NamespaceSelector, thus applying the egress IP to the pods (in the namespace(s) already matched by the NamespaceSelector) which match this pod selector.

.spec.namespaceSelector

Description: NamespaceSelector applies the egress IP only to the namespace(s) whose label matches this definition. This field is mandatory.
Type: object

Property Type Description

Property	Type	Description
`matchExpressions`	`array`	matchExpressions is a list of label selector requirements. The requirements are ANDed.
`matchExpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (string)`	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.namespaceSelector.matchExpressions

Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.namespaceSelector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
`values`	`array (string)`	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.podSelector

Description: PodSelector applies the egress IP only to the pods whose label matches this definition. This field is optional, and in case it is not set: results in the egress IP being applied to all pods in the namespace(s) matched by the NamespaceSelector. In case it is set: is intersected with the NamespaceSelector, thus applying the egress IP to the pods (in the namespace(s) already matched by the NamespaceSelector) which match this pod selector.
Type: object

Property Type Description

Property	Type	Description
`matchExpressions`	`array`	matchExpressions is a list of label selector requirements. The requirements are ANDed.
`matchExpressions[]`	`object`	A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
`matchLabels`	`object (string)`	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchExpressions[]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

matchLabels

object (string)

.spec.podSelector.matchExpressions

Description: matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type: array

.spec.podSelector.matchExpressions[]

Description

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Type

object

Required

key
operator

Property Type Description

Property	Type	Description
`key`	`string`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
`values`	`array (string)`	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

key

string

key is the label key that the selector applies to.

operator

string

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values

array (string)

.status

Description

Observed status of egressIP. Read-only.

Type

object

Required

items

Property Type Description

Property	Type	Description
`items`	`array`	The list of assigned egress IPs and their corresponding node assignment.
`items[]`	`object`	The per node status, for those egress IPs who have been assigned.

items

array

The list of assigned egress IPs and their corresponding node assignment.

items[]

object

The per node status, for those egress IPs who have been assigned.

.status.items

Description: The list of assigned egress IPs and their corresponding node assignment.
Type: array

.status.items[]

Description

The per node status, for those egress IPs who have been assigned.

Type

object

Required

egressIP
node

Property Type Description

Property	Type	Description
`egressIP`	`string`	Assigned egress IP
`node`	`string`	Assigned node name

egressIP

string

Assigned egress IP

node

string

Assigned node name

API endpoints

The following API endpoints are available:

/apis/k8s.ovn.org/v1/egressips
- DELETE: delete collection of egressIP
- GET: list objects of kind egressIP
- POST: create an egressIP
/apis/k8s.ovn.org/v1/egressips/{name}
- DELETE: delete an egressIP
- GET: read the specified egressIP
- PATCH: partially update the specified egressIP
- PUT: replace the specified egressIP

/apis/k8s.ovn.org/v1/egressips

HTTP method: DELETE
Description: delete collection of egressIP

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind egressIP

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`egressIPList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create an egressIP

Table 3. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 4. Body parameters
Parameter	Type	Description
`body`	`egressIP` schema

Table 5. HTTP responses
HTTP code	Reponse body
200 - OK	`egressIP` schema
201 - Created	`egressIP` schema
202 - Accepted	`egressIP` schema
401 - Unauthorized	Empty

/apis/k8s.ovn.org/v1/egressips/{name}

Table 6. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the egressIP

HTTP method: DELETE
Description: delete an egressIP

Table 7. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 8. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified egressIP

Table 9. HTTP responses
HTTP code	Reponse body
200 - OK	`egressIP` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified egressIP

Table 10. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 11. HTTP responses
HTTP code	Reponse body
200 - OK	`egressIP` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified egressIP

Table 12. Query parameters
Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 13. Body parameters
Parameter	Type	Description
`body`	`egressIP` schema

Table 14. HTTP responses
HTTP code	Reponse body
200 - OK	`egressIP` schema
201 - Created	`egressIP` schema
401 - Unauthorized	Empty

egressIP [k8s.ovn.org/v1]

Specification

.spec

.spec.namespaceSelector

.spec.namespaceSelector.matchExpressions

.spec.namespaceSelector.matchExpressions[]

.spec.podSelector

.spec.podSelector.matchExpressions

.spec.podSelector.matchExpressions[]

.status

.status.items

.status.items[]

API endpoints

/apis/k8s.ovn.org/v1/egressips

/apis/k8s.ovn.org/v1/egressips/{name}