Skip to content

Commit 2974d73

Browse files
author
HHDocs
committed
Deployed 3037b00 to dev with MkDocs 1.6.1 and mike 2.1.3
1 parent 703e5c6 commit 2974d73

File tree

10 files changed

+816
-82
lines changed

10 files changed

+816
-82
lines changed

dev/reference/gateway-api.md.gen

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Package v1alpha1 contains API Schema definitions for the gateway v1alpha1 API gr
1111

1212
### Resource Types
1313
- [Gateway](#gateway)
14+
- [GatewayGroup](#gatewaygroup)
1415
- [Peering](#peering)
1516
- [VPCInfo](#vpcinfo)
1617

@@ -53,6 +54,68 @@ _Appears in:_
5354
| `asn` _integer_ | ASN is the remote ASN of the BGP neighbor | | |
5455

5556

57+
#### GatewayGroup
58+
59+
60+
61+
GatewayGroup is the Schema for the gatewaygroups API
62+
63+
64+
65+
66+
67+
| Field | Description | Default | Validation |
68+
| --- | --- | --- | --- |
69+
| `apiVersion` _string_ | `gateway.githedgehog.com/v1alpha1` | | |
70+
| `kind` _string_ | `GatewayGroup` | | |
71+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
72+
| `spec` _[GatewayGroupSpec](#gatewaygroupspec)_ | | | |
73+
| `status` _[GatewayGroupStatus](#gatewaygroupstatus)_ | | | |
74+
75+
76+
#### GatewayGroupMembership
77+
78+
79+
80+
81+
82+
83+
84+
_Appears in:_
85+
- [GatewaySpec](#gatewayspec)
86+
87+
| Field | Description | Default | Validation |
88+
| --- | --- | --- | --- |
89+
| `name` _string_ | Name is the name of the group to which the gateway belongs | | |
90+
| `priority` _integer_ | Priority is the priority of the gateway within the group | | |
91+
92+
93+
#### GatewayGroupSpec
94+
95+
96+
97+
GatewayGroupSpec defines the desired state of GatewayGroup
98+
99+
100+
101+
_Appears in:_
102+
- [GatewayGroup](#gatewaygroup)
103+
104+
105+
106+
#### GatewayGroupStatus
107+
108+
109+
110+
GatewayGroupStatus defines the observed state of GatewayGroup.
111+
112+
113+
114+
_Appears in:_
115+
- [GatewayGroup](#gatewaygroup)
116+
117+
118+
56119
#### GatewayInterface
57120

58121

@@ -150,6 +213,7 @@ _Appears in:_
150213
| `logs` _[GatewayLogs](#gatewaylogs)_ | Logs defines the configuration for logging levels | | |
151214
| `profiling` _[GatewayProfiling](#gatewayprofiling)_ | Profiling defines the configuration for profiling | | |
152215
| `workers` _integer_ | Workers defines the number of worker threads to use for dataplane | | |
216+
| `groups` _[GatewayGroupMembership](#gatewaygroupmembership) array_ | Groups is a list of group memberships for the gateway | | |
153217

154218

155219
#### GatewayStatus
@@ -284,6 +348,7 @@ _Appears in:_
284348

285349
| Field | Description | Default | Validation |
286350
| --- | --- | --- | --- |
351+
| `gatewayGroup` _string_ | GatewayGroup is the name of the gateway group that should process the peering | | |
287352
| `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) | | |
288353

289354

@@ -462,6 +527,8 @@ _Appears in:_
462527
| `gateway` _[GatewaySpec](#gatewayspec)_ | | | |
463528
| `vpcs` _object (keys:string, values:[VPCInfoData](#vpcinfodata))_ | | | |
464529
| `peerings` _object (keys:string, values:[PeeringSpec](#peeringspec))_ | | | |
530+
| `groups` _object (keys:string, values:[GatewayGroupInfo](#gatewaygroupinfo))_ | | | |
531+
| `communities` _object (keys:string, values:string)_ | | | |
465532

466533

467534
#### GatewayAgentStatus
@@ -484,6 +551,40 @@ _Appears in:_
484551
| `state` _[GatewayState](#gatewaystate)_ | State represents collected data from the dataplane API that includes FRR as well | | |
485552

486553

554+
#### GatewayGroupInfo
555+
556+
557+
558+
559+
560+
561+
562+
_Appears in:_
563+
- [GatewayAgentSpec](#gatewayagentspec)
564+
565+
| Field | Description | Default | Validation |
566+
| --- | --- | --- | --- |
567+
| `members` _[GatewayGroupMember](#gatewaygroupmember) array_ | | | |
568+
569+
570+
#### GatewayGroupMember
571+
572+
573+
574+
575+
576+
577+
578+
_Appears in:_
579+
- [GatewayGroupInfo](#gatewaygroupinfo)
580+
581+
| Field | Description | Default | Validation |
582+
| --- | --- | --- | --- |
583+
| `name` _string_ | | | |
584+
| `priority` _integer_ | | | |
585+
| `vtepIP` _string_ | | | |
586+
587+
487588
#### GatewayState
488589

489590

0 commit comments

Comments
 (0)