This is a cache of https://docs.openshift.com/container-platform/4.16/rest_api/network_apis/egressrouter-network-operator-openshift-io-v1.html. It is a snapshot of the page at 2024-11-23T10:33:55.794+0000.
<strong>egress</strong>Router [network.operator.openshift.io/v1] - Network APIs | API reference | OpenShift Container Platform 4.16
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
×

egressRouter [network.operator.openshift.io/v1]

Description

egressRouter is a feature allowing the user to define an egress router that acts as a bridge between pods and external systems. The egress router runs a service that redirects egress traffic originating from a pod or a group of pods to a remote external system or multiple destinations as per configuration. It is consumed by the cluster-network-operator. More specifically, given an egressRouter CR with <name>, the CNO will create and manage: - A service called <name> - An egress pod called <name> - A NAD called <name> Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). egressRouter is a single egressrouter pod configuration object.

Type

object

Required

  • spec

Specification

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 egress router.

status

object

Observed status of egressRouter.

.spec

Description

Specification of the desired egress router.

Type

object

Required

  • addresses

  • mode

  • networkInterface

Property Type Description

addresses

array

List of IP addresses to configure on the pod’s secondary interface.

addresses[]

object

egressRouterAddress contains a pair of IP CIDR and gateway to be configured on the router’s interface

mode

string

Mode depicts the mode that is used for the egress router. The default mode is "Redirect" and is the only supported mode currently.

networkInterface

object

Specification of interface to create/use. The default is macvlan. Currently only macvlan is supported.

redirect

object

Redirect represents the configuration parameters specific to redirect mode.

.spec.addresses

Description

List of IP addresses to configure on the pod’s secondary interface.

Type

array

.spec.addresses[]

Description

egressRouterAddress contains a pair of IP CIDR and gateway to be configured on the router’s interface

Type

object

Required

  • ip

Property Type Description

gateway

string

IP address of the next-hop gateway, if it cannot be automatically determined. Can be IPv4 or IPv6.

ip

string

IP is the address to configure on the router’s interface. Can be IPv4 or IPv6.

.spec.networkInterface

Description

Specification of interface to create/use. The default is macvlan. Currently only macvlan is supported.

Type

object

Property Type Description

macvlan

object

Arguments specific to the interfaceType macvlan

.spec.networkInterface.macvlan

Description

Arguments specific to the interfaceType macvlan

Type

object

Required

  • mode

Property Type Description

master

string

Name of the master interface. Need not be specified if it can be inferred from the IP address.

mode

string

Mode depicts the mode that is used for the macvlan interface; one of Bridge|Private|VEPA|Passthru. The default mode is "Bridge".

.spec.redirect

Description

Redirect represents the configuration parameters specific to redirect mode.

Type

object

Property Type Description

fallbackIP

string

FallbackIP specifies the remote destination’s IP address. Can be IPv4 or IPv6. If no redirect rules are specified, all traffic from the router are redirected to this IP. If redirect rules are specified, then any connections on any other port (undefined in the rules) on the router will be redirected to this IP. If redirect rules are specified and no fallback IP is provided, connections on other ports will simply be rejected.

redirectRules

array

List of L4RedirectRules that define the DNAT redirection from the pod to the destination in redirect mode.

redirectRules[]

object

L4RedirectRule defines a DNAT redirection from a given port to a destination IP and port.

.spec.redirect.redirectRules

Description

List of L4RedirectRules that define the DNAT redirection from the pod to the destination in redirect mode.

Type

array

.spec.redirect.redirectRules[]

Description

L4RedirectRule defines a DNAT redirection from a given port to a destination IP and port.

Type

object

Required

  • destinationIP

  • port

  • protocol

Property Type Description

destinationIP

string

IP specifies the remote destination’s IP address. Can be IPv4 or IPv6.

port

integer

Port is the port number to which clients should send traffic to be redirected.

protocol

string

Protocol can be TCP, SCTP or UDP.

targetPort

integer

TargetPort allows specifying the port number on the remote destination to which the traffic gets redirected to. If unspecified, the value from "Port" is used.

.status

Description

Observed status of egressRouter.

Type

object

Required

  • conditions

Property Type Description

conditions

array

Observed status of the egress router

conditions[]

object

egressRouterStatusCondition represents the state of the egress router’s managed and monitored components.

.status.conditions

Description

Observed status of the egress router

Type

array

.status.conditions[]

Description

egressRouterStatusCondition represents the state of the egress router’s managed and monitored components.

Type

object

Required

  • status

  • type

Property Type Description

lastTransitionTime

``

LastTransitionTime is the time of the last update to the current status property.

message

string

Message provides additional information about the current condition. This is only to be consumed by humans. It may contain Line Feed characters (U+000A), which should be rendered as new lines.

reason

string

Reason is the CamelCase reason for the condition’s current status.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type specifies the aspect reported by this condition; one of Available, Progressing, Degraded

API endpoints

The following API endpoints are available:

  • /apis/network.operator.openshift.io/v1/egressrouters

    • GET: list objects of kind egressRouter

  • /apis/network.operator.openshift.io/v1/namespaces/{namespace}/egressrouters

    • DELETE: delete collection of egressRouter

    • GET: list objects of kind egressRouter

    • POST: create an egressRouter

  • /apis/network.operator.openshift.io/v1/namespaces/{namespace}/egressrouters/{name}

    • DELETE: delete an egressRouter

    • GET: read the specified egressRouter

    • PATCH: partially update the specified egressRouter

    • PUT: replace the specified egressRouter

  • /apis/network.operator.openshift.io/v1/namespaces/{namespace}/egressrouters/{name}/status

    • GET: read status of the specified egressRouter

    • PATCH: partially update status of the specified egressRouter

    • PUT: replace status of the specified egressRouter

/apis/network.operator.openshift.io/v1/egressrouters

HTTP method

GET

Description

list objects of kind egressRouter

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

egressRouterList schema

401 - Unauthorized

Empty

/apis/network.operator.openshift.io/v1/namespaces/{namespace}/egressrouters

HTTP method

DELETE

Description

delete collection of egressRouter

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

list objects of kind egressRouter

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

egressRouterList schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create an egressRouter

Table 4. 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 5. Body parameters
Parameter Type Description

body

egressRouter schema
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

egressRouter schema

201 - Created

egressRouter schema

202 - Accepted

egressRouter schema

401 - Unauthorized

Empty

/apis/network.operator.openshift.io/v1/namespaces/{namespace}/egressrouters/{name}

Table 7. Global path parameters
Parameter Type Description

name

string

name of the egressRouter
HTTP method

DELETE

Description

delete an egressRouter

Table 8. 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 9. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified egressRouter

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

egressRouter schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified egressRouter

Table 11. 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 12. HTTP responses
HTTP code Reponse body

200 - OK

egressRouter schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified egressRouter

Table 13. 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 14. Body parameters
Parameter Type Description

body

egressRouter schema
Table 15. HTTP responses
HTTP code Reponse body

200 - OK

egressRouter schema

201 - Created

egressRouter schema

401 - Unauthorized

Empty

/apis/network.operator.openshift.io/v1/namespaces/{namespace}/egressrouters/{name}/status

Table 16. Global path parameters
Parameter Type Description

name

string

name of the egressRouter
HTTP method

GET

Description

read status of the specified egressRouter

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

egressRouter schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update status of the specified egressRouter

Table 18. 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 19. HTTP responses
HTTP code Reponse body

200 - OK

egressRouter schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace status of the specified egressRouter

Table 20. 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 21. Body parameters
Parameter Type Description

body

egressRouter schema
Table 22. HTTP responses
HTTP code Reponse body

200 - OK

egressRouter schema

201 - Created

egressRouter schema

401 - Unauthorized

Empty