diff --git a/docs/reference/gateway-api.md.gen b/docs/reference/gateway-api.md.gen index 97c660b4..c1c307cd 100644 --- a/docs/reference/gateway-api.md.gen +++ b/docs/reference/gateway-api.md.gen @@ -11,6 +11,7 @@ Package v1alpha1 contains API Schema definitions for the gateway v1alpha1 API gr ### Resource Types - [Gateway](#gateway) +- [GatewayGroup](#gatewaygroup) - [Peering](#peering) - [VPCInfo](#vpcinfo) @@ -53,6 +54,68 @@ _Appears in:_ | `asn` _integer_ | ASN is the remote ASN of the BGP neighbor | | | +#### GatewayGroup + + + +GatewayGroup is the Schema for the gatewaygroups API + + + + + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `apiVersion` _string_ | `gateway.githedgehog.com/v1alpha1` | | | +| `kind` _string_ | `GatewayGroup` | | | +| `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` _[GatewayGroupSpec](#gatewaygroupspec)_ | | | | +| `status` _[GatewayGroupStatus](#gatewaygroupstatus)_ | | | | + + +#### GatewayGroupMembership + + + + + + + +_Appears in:_ +- [GatewaySpec](#gatewayspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | Name is the name of the group to which the gateway belongs | | | +| `priority` _integer_ | Priority is the priority of the gateway within the group | | | + + +#### GatewayGroupSpec + + + +GatewayGroupSpec defines the desired state of GatewayGroup + + + +_Appears in:_ +- [GatewayGroup](#gatewaygroup) + + + +#### GatewayGroupStatus + + + +GatewayGroupStatus defines the observed state of GatewayGroup. + + + +_Appears in:_ +- [GatewayGroup](#gatewaygroup) + + + #### GatewayInterface @@ -150,6 +213,7 @@ _Appears in:_ | `logs` _[GatewayLogs](#gatewaylogs)_ | Logs defines the configuration for logging levels | | | | `profiling` _[GatewayProfiling](#gatewayprofiling)_ | Profiling defines the configuration for profiling | | | | `workers` _integer_ | Workers defines the number of worker threads to use for dataplane | | | +| `groups` _[GatewayGroupMembership](#gatewaygroupmembership) array_ | Groups is a list of group memberships for the gateway | | | #### GatewayStatus @@ -284,6 +348,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | +| `gatewayGroup` _string_ | GatewayGroup is the name of the gateway group that should process the peering | | | | `peering` _object (keys:string, values:[PeeringEntry](#peeringentry))_ | Peerings is a map of peering entries for each VPC participating in the peering (keyed by VPC name) | | | @@ -462,6 +527,8 @@ _Appears in:_ | `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)_ | | | | #### GatewayAgentStatus @@ -484,6 +551,40 @@ _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