Skip to content

Update docs from gateway@v0.39.0 #267

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
Merged

Update docs from gateway@v0.39.0 #267

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
96 changes: 0 additions & 96 deletions docs/reference/gateway-api.md.gen
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,6 @@ GatewaySpec defines the desired state of Gateway.

_Appears in:_
- [Gateway](#gateway)
- [GatewayAgentSpec](#gatewayagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -346,7 +345,6 @@ PeeringSpec defines the desired state of Peering.


_Appears in:_
- [GatewayAgentSpec](#gatewayagentspec)
- [Peering](#peering)

| Field | Description | Default | Validation |
Expand Down Expand Up @@ -426,7 +424,6 @@ VPCInfoSpec defines the desired state of VPCInfo.

_Appears in:_
- [VPCInfo](#vpcinfo)
- [VPCInfoData](#vpcinfodata)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand All @@ -444,7 +441,6 @@ VPCInfoStatus defines the observed state of VPCInfo.

_Appears in:_
- [VPCInfo](#vpcinfo)
- [VPCInfoData](#vpcinfodata)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
Expand All @@ -460,7 +456,6 @@ _Appears in:_


_Appears in:_
- [VPCInfoData](#vpcinfodata)
- [VPCInfoSpec](#vpcinfospec)

| Field | Description | Default | Validation |
Expand Down Expand Up @@ -662,48 +657,9 @@ GatewayAgent is the Schema for the gatewayagents API.
| `apiVersion` _string_ | `gwint.githedgehog.com/v1alpha1` | | |
| `kind` _string_ | `GatewayAgent` | | |
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
| `spec` _[GatewayAgentSpec](#gatewayagentspec)_ | | | |
| `status` _[GatewayAgentStatus](#gatewayagentstatus)_ | | | |


#### GatewayAgentSpec



GatewayAgentSpec defines the desired state of GatewayAgent.



_Appears in:_
- [GatewayAgent](#gatewayagent)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `agentVersion` _string_ | AgentVersion is the desired version of the gateway agent to trigger generation changes on controller upgrades | | |
| `gateway` _[GatewaySpec](#gatewayspec)_ | | | |
| `vpcs` _object (keys:string, values:[VPCInfoData](#vpcinfodata))_ | | | |
| `peerings` _object (keys:string, values:[PeeringSpec](#peeringspec))_ | | | |
| `groups` _object (keys:string, values:[GatewayGroupInfo](#gatewaygroupinfo))_ | | | |
| `communities` _object (keys:string, values:string)_ | | | |
| `config` _[GatewayAgentSpecConfig](#gatewayagentspecconfig)_ | | | |


#### GatewayAgentSpecConfig







_Appears in:_
- [GatewayAgentSpec](#gatewayagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `fabricBFD` _boolean_ | FabricBFD defines if fabric-facing links should be configured with BFD | | |


#### GatewayAgentStatus


Expand All @@ -724,40 +680,6 @@ _Appears in:_
| `state` _[GatewayState](#gatewaystate)_ | State represents collected data from the dataplane API that includes FRR as well | | |


#### GatewayGroupInfo







_Appears in:_
- [GatewayAgentSpec](#gatewayagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `members` _[GatewayGroupMember](#gatewaygroupmember) array_ | | | |


#### GatewayGroupMember







_Appears in:_
- [GatewayGroupInfo](#gatewaygroupinfo)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `name` _string_ | | | |
| `priority` _integer_ | | | |
| `vtepIP` _string_ | | | |


#### GatewayState


Expand Down Expand Up @@ -799,24 +721,6 @@ _Appears in:_
| `pps` _float_ | PktsPerSecond is the number of packets sent per second on the peering | | |


#### VPCInfoData







_Appears in:_
- [GatewayAgentSpec](#gatewayagentspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `subnets` _object (keys:string, values:[VPCInfoSubnet](#vpcinfosubnet))_ | Subnets is a map of all subnets in the VPC (incl. CIDRs, VNIs, etc) keyed by the subnet name | | |
| `vni` _integer_ | VNI is the VNI for the VPC | | |
| `internalID` _string_ | | | |


#### VPCStatus


Expand Down