Skip to content

Update docs from fabric@v0.104.0 #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Frostman merged 1 commit into from
Feb 3, 2026
+35 −35
Merged

Update docs from fabric@v0.104.0 #266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 35 additions & 35 deletions docs/reference/fabric-api.md.gen
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -850,25 +850,6 @@ Effectively it represents BGP peering between the switch and external system inc
| `status` _[ExternalAttachmentStatus](#externalattachmentstatus)_ | Status is the observed state of the ExternalAttachment | | |


#### ExternalAttachmentL2



ExternalAttachmentL2 defines parameters used for L2 external attachments



_Appears in:_
- [ExternalAttachmentSpec](#externalattachmentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `ip` _string_ | IP is the actual IP address of the external, which will be used as nexthop for prefixes reachable via this external attachment | | |
| `vlan` _integer_ | VLAN (optional) is the VLAN ID used for the subinterface on a switch port specified in the connection, set to 0 if no VLAN is required | | |
| `gatewayIPs` _string array_ | GatewayIPs is the list of IP addresses (with prefix length) which can be used for NAT on the fabric side for this L2 external attachment | | |
| `fabricEdgeIP` _string_ | FabricEdgeIP is an IP address (with prefix length) that will be configured on the fabric edge switch; it is needed for proxy-ARP | | |


#### ExternalAttachmentNeighbor


Expand Down Expand Up @@ -903,53 +884,56 @@ _Appears in:_
| `connection` _string_ | Connection is the name of the Connection object this attachment belongs to (essentially the name of the switch/port) | | |
| `switch` _[ExternalAttachmentSwitch](#externalattachmentswitch)_ | Switch is the switch port configuration for the external attachment in case of a BGP external | | |
| `neighbor` _[ExternalAttachmentNeighbor](#externalattachmentneighbor)_ | Neighbor is the BGP neighbor configuration for the external attachment in case of a BGP external | | |
| `l2` _[ExternalAttachmentL2](#externalattachmentl2)_ | L2 contains parameters specific to an L2 external attachment | | |
| `static` _[ExternalAttachmentStatic](#externalattachmentstatic)_ | Static contains parameters specific to a static external attachment | | |


#### ExternalAttachmentStatus
#### ExternalAttachmentStatic



ExternalAttachmentStatus defines the observed state of ExternalAttachment
ExternalAttachmentStatic defines parameters used for staticexternal attachments



_Appears in:_
- [ExternalAttachment](#externalattachment)
- [ExternalAttachmentSpec](#externalattachmentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `remoteIP` _string_ | RemoteIP is the IP address of the external, which will be used as nexthop for prefixes reachable via this external attachment | | |
| `vlan` _integer_ | VLAN (optional) is the VLAN ID used for the subinterface on a switch port specified in the connection, set to 0 if no VLAN is required | | |
| `ip` _string_ | IP is the IP address (with prefix length) to be configured on the switch when not using Proxy mode | | |
| `proxy` _boolean_ | Proxy is a flag to enable proxy-ARP, used in conjunction with Gateway peering | | |


#### ExternalAttachmentSwitch
#### ExternalAttachmentStatus



ExternalAttachmentSwitch defines the switch port configuration for the external attachment
ExternalAttachmentStatus defines the observed state of ExternalAttachment



_Appears in:_
- [ExternalAttachmentSpec](#externalattachmentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `vlan` _integer_ | VLAN (optional) is the VLAN ID used for the subinterface on a switch port specified in the connection, set to 0 if no VLAN is used | | |
| `ip` _string_ | IP is the IP address of the subinterface on a switch port specified in the connection, it should include the prefix length | | |
- [ExternalAttachment](#externalattachment)


#### ExternalL2

#### ExternalAttachmentSwitch



ExternalAttachmentSwitch defines the switch port configuration for the external attachment



_Appears in:_
- [ExternalSpec](#externalspec)
- [ExternalAttachmentSpec](#externalattachmentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `prefixes` _string array_ | Prefixes is the list of IPv4 prefixes reachable via the external | | |
| `vlan` _integer_ | VLAN (optional) is the VLAN ID used for the subinterface on a switch port specified in the connection, set to 0 if no VLAN is used | | |
| `ip` _string_ | IP is the IP address of the subinterface on a switch port specified in the connection, it should include the prefix length | | |


#### ExternalPeering
Expand Down Expand Up @@ -1084,7 +1068,23 @@ _Appears in:_
| `ipv4Namespace` _string_ | IPv4Namespace is the name of the IPv4Namespace this External belongs to | | |
| `inboundCommunity` _string_ | InboundCommunity is the inbound community to filter routes from the external system (e.g. 65102:5000) | | |
| `outboundCommunity` _string_ | OutboundCommunity is theoutbound community that all outbound routes will be stamped with (e.g. 50000:50001) | | |
| `l2` _[ExternalL2](#externall2)_ | L2 contains L2 specific parameters | | |
| `static` _[ExternalStaticSpec](#externalstaticspec)_ | Static contains parameters specific to static externals | | |


#### ExternalStaticSpec







_Appears in:_
- [ExternalSpec](#externalspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `prefixes` _string array_ | Prefixes is the list of IPv4 prefixes reachable via the external | | |


#### ExternalStatus
Expand Down