Skip to content

Commit c559737

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 604be52 commit c559737

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

docs/reference/gateway-api.md.gen

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,92 @@ Package v1alpha1 contains API Schema definitions for the gateway v1alpha1 API gr
1616

1717

1818

19+
#### AlloyBasicAuth
20+
21+
22+
23+
24+
25+
26+
27+
_Appears in:_
28+
- [AlloyPrometheusTarget](#alloyprometheustarget)
29+
- [AlloyTarget](#alloytarget)
30+
31+
| Field | Description | Default | Validation |
32+
| --- | --- | --- | --- |
33+
| `username` _string_ | | | |
34+
| `password` _string_ | | | |
35+
36+
37+
#### AlloyConfig
38+
39+
40+
41+
42+
43+
44+
45+
_Appears in:_
46+
- [GatewaySpec](#gatewayspec)
47+
48+
| Field | Description | Default | Validation |
49+
| --- | --- | --- | --- |
50+
| `dataplaneScrapeIntervalSeconds` _integer_ | | | |
51+
| `frrScrapeIntervalSeconds` _integer_ | | | |
52+
| `unixExporterEnabled` _boolean_ | | | |
53+
| `unixExporterCollectors` _string array_ | | | |
54+
| `unixScrapeIntervalSeconds` _integer_ | | | |
55+
| `prometheusTargets` _object (keys:string, values:[AlloyPrometheusTarget](#alloyprometheustarget))_ | | | |
56+
57+
58+
#### AlloyPrometheusTarget
59+
60+
61+
62+
63+
64+
65+
66+
_Appears in:_
67+
- [AlloyConfig](#alloyconfig)
68+
69+
| Field | Description | Default | Validation |
70+
| --- | --- | --- | --- |
71+
| `url` _string_ | | | |
72+
| `basicAuth` _[AlloyBasicAuth](#alloybasicauth)_ | | | |
73+
| `bearerToken` _string_ | | | |
74+
| `labels` _object (keys:string, values:string)_ | | | |
75+
| `useControlProxy` _boolean_ | | | |
76+
| `insecureSkipVerify` _boolean_ | | | |
77+
| `caPEM` _string_ | | | |
78+
| `certPEM` _string_ | | | |
79+
| `sendIntervalSeconds` _integer_ | | | |
80+
81+
82+
#### AlloyTarget
83+
84+
85+
86+
87+
88+
89+
90+
_Appears in:_
91+
- [AlloyPrometheusTarget](#alloyprometheustarget)
92+
93+
| Field | Description | Default | Validation |
94+
| --- | --- | --- | --- |
95+
| `url` _string_ | | | |
96+
| `basicAuth` _[AlloyBasicAuth](#alloybasicauth)_ | | | |
97+
| `bearerToken` _string_ | | | |
98+
| `labels` _object (keys:string, values:string)_ | | | |
99+
| `useControlProxy` _boolean_ | | | |
100+
| `insecureSkipVerify` _boolean_ | | | |
101+
| `caPEM` _string_ | | | |
102+
| `certPEM` _string_ | | | |
103+
104+
19105
#### Gateway
20106

21107

@@ -91,6 +177,7 @@ _Appears in:_
91177
| `vtepMTU` _integer_ | VTEPMTU is the MTU for the VTEP interface | | |
92178
| `interfaces` _object (keys:string, values:[GatewayInterface](#gatewayinterface))_ | Interfaces is a map of interface names to their configurations | | |
93179
| `neighbors` _[GatewayBGPNeighbor](#gatewaybgpneighbor) array_ | Neighbors is a list of BGP neighbors | | |
180+
| `alloy` _[AlloyConfig](#alloyconfig)_ | Alloy is the Alloy configuration for the gateway | | |
94181

95182

96183
#### GatewayStatus

0 commit comments

Comments
 (0)