Skip to content

Commit e13ec60

Browse files
committed
Update docs from [email protected]
This is an automated commit created by GitHub Actions workflow, in the gateway repository. Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 15c9d07 commit e13ec60

File tree

1 file changed

+87
-1
lines changed

1 file changed

+87
-1
lines changed

docs/reference/gateway-api.md.gen

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Packages
44
- [gateway.githedgehog.com/v1alpha1](#gatewaygithedgehogcomv1alpha1)
5+
- [gwint.githedgehog.com/v1alpha1](#gwintgithedgehogcomv1alpha1)
56

67

78
## gateway.githedgehog.com/v1alpha1
@@ -186,6 +187,7 @@ PeeringSpec defines the desired state of Peering.
186187

187188

188189
_Appears in:_
190+
- [GatewayAgentSpec](#gatewayagentspec)
189191
- [Peering](#peering)
190192

191193
| Field | Description | Default | Validation |
@@ -210,7 +212,7 @@ _Appears in:_
210212

211213

212214

213-
VPCInfo is the Schema for the vpcinfoes API.
215+
VPCInfo is the Schema for the vpcinfos API.
214216

215217

216218

@@ -235,6 +237,7 @@ VPCInfoSpec defines the desired state of VPCInfo.
235237

236238
_Appears in:_
237239
- [VPCInfo](#vpcinfo)
240+
- [VPCInfoData](#vpcinfodata)
238241

239242
| Field | Description | Default | Validation |
240243
| --- | --- | --- | --- |
@@ -253,7 +256,11 @@ VPCInfoStatus defines the observed state of VPCInfo.
253256

254257
_Appears in:_
255258
- [VPCInfo](#vpcinfo)
259+
- [VPCInfoData](#vpcinfodata)
256260

261+
| Field | Description | Default | Validation |
262+
| --- | --- | --- | --- |
263+
| `internalID` _string_ | | | |
257264

258265

259266
#### VPCInfoSubnet
@@ -265,6 +272,7 @@ _Appears in:_
265272

266273

267274
_Appears in:_
275+
- [VPCInfoData](#vpcinfodata)
268276
- [VPCInfoSpec](#vpcinfospec)
269277

270278
| Field | Description | Default | Validation |
@@ -274,3 +282,81 @@ _Appears in:_
274282
| `vni` _integer_ | VNI is the VNI for the subnet | | |
275283

276284

285+
286+
## gwint.githedgehog.com/v1alpha1
287+
288+
Package v1alpha1 contains API Schema definitions for the gwint v1alpha1 API group.
289+
290+
### Resource Types
291+
- [GatewayAgent](#gatewayagent)
292+
293+
294+
295+
#### GatewayAgent
296+
297+
298+
299+
GatewayAgent is the Schema for the gatewayagents API.
300+
301+
302+
303+
304+
305+
| Field | Description | Default | Validation |
306+
| --- | --- | --- | --- |
307+
| `apiVersion` _string_ | `gwint.githedgehog.com/v1alpha1` | | |
308+
| `kind` _string_ | `GatewayAgent` | | |
309+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
310+
| `spec` _[GatewayAgentSpec](#gatewayagentspec)_ | | | |
311+
| `status` _[GatewayAgentStatus](#gatewayagentstatus)_ | | | |
312+
313+
314+
#### GatewayAgentSpec
315+
316+
317+
318+
GatewayAgentSpec defines the desired state of GatewayAgent.
319+
320+
321+
322+
_Appears in:_
323+
- [GatewayAgent](#gatewayagent)
324+
325+
| Field | Description | Default | Validation |
326+
| --- | --- | --- | --- |
327+
| `vpcs` _object (keys:string, values:[VPCInfoData](#vpcinfodata))_ | | | |
328+
| `peerings` _object (keys:string, values:[PeeringSpec](#peeringspec))_ | | | |
329+
330+
331+
#### GatewayAgentStatus
332+
333+
334+
335+
GatewayAgentStatus defines the observed state of GatewayAgent.
336+
337+
338+
339+
_Appears in:_
340+
- [GatewayAgent](#gatewayagent)
341+
342+
343+
344+
#### VPCInfoData
345+
346+
347+
348+
349+
350+
351+
352+
_Appears in:_
353+
- [GatewayAgentSpec](#gatewayagentspec)
354+
355+
| Field | Description | Default | Validation |
356+
| --- | --- | --- | --- |
357+
| `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 | | |
358+
| `vni` _integer_ | VNI is the VNI for the VPC | | |
359+
| `vrf` _string_ | VRF (optional) is the VRF name for the VPC, if not specified, predictable VRF name is generated | | |
360+
| `internalID` _string_ | | | |
361+
362+

0 commit comments

Comments
 (0)