API Reference¶
Packages¶
k8s.ovn.org/v1¶
Package v1 contains API Schema definitions for the RouteAdvertisements v1 API group
Resource Types¶
AdvertisementType¶
Underlying type: string
AdvertisementType determines the type of advertisement.
Validation: - Enum: [PodNetwork EgressIP]
Appears in: - RouteAdvertisementsSpec
Field | Description |
---|---|
PodNetwork |
PodNetwork determines that the pod network is advertised. |
EgressIP |
EgressIP determines that egress IPs are being advertised. |
RouteAdvertisements¶
RouteAdvertisements is the Schema for the routeadvertisements API
Appears in: - RouteAdvertisementsList
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string |
k8s.ovn.org/v1 |
||
kind string |
RouteAdvertisements |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata . |
||
spec RouteAdvertisementsSpec |
|||
status RouteAdvertisementsStatus |
RouteAdvertisementsList¶
RouteAdvertisementsList contains a list of RouteAdvertisements
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string |
k8s.ovn.org/v1 |
||
kind string |
RouteAdvertisementsList |
||
metadata ListMeta |
Refer to Kubernetes API documentation for fields of metadata . |
||
items RouteAdvertisements array |
RouteAdvertisementsSpec¶
RouteAdvertisementsSpec defines the desired state of RouteAdvertisements
Appears in: - RouteAdvertisements
Field | Description | Default | Validation |
---|---|---|---|
targetVRF string |
targetVRF determines which VRF the routes should be advertised in. | Optional: {} |
|
networkSelectors NetworkSelectors |
networkSelectors determines which network routes should be advertised. Only ClusterUserDefinedNetworks and the default network can be selected. |
Required: {} |
|
nodeSelector LabelSelector |
nodeSelector limits the advertisements to selected nodes. This field follows standard label selector semantics. |
Required: {} |
|
frrConfigurationSelector LabelSelector |
frrConfigurationSelector determines which FRRConfigurations will the OVN-Kubernetes driven FRRConfigurations be based on. This field follows standard label selector semantics. |
Required: {} |
|
advertisements AdvertisementType array |
advertisements determines what is advertised. | Enum: [PodNetwork EgressIP] MaxItems: 2 MinItems: 1 Required: {} |
RouteAdvertisementsStatus¶
RouteAdvertisementsStatus defines the observed state of RouteAdvertisements. It should always be reconstructable from the state of the cluster and/or outside world.
Appears in: - RouteAdvertisements
Field | Description | Default | Validation |
---|---|---|---|
status string |
status is a concise indication of whether the RouteAdvertisements resource is applied with success. |
Optional: {} |
|
conditions Condition array |
conditions is an array of condition objects indicating details about status of RouteAdvertisements object. |
Optional: {} |