Skip to content

Commit 54c4e34

Browse files
XunzhuoXunzhuo
committed
release: cut v0.3.0 versioned docs
Signed-off-by: bitliu <bitliu@tencent.com>
1 parent e55c15f commit 54c4e34

50 files changed

Lines changed: 6544 additions & 2 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v0.3.0-rc.1
1+
v0.3.0

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<html>
22
<head>
3-
<meta http-equiv="refresh" content="0; url=/v0.2.0">
3+
<meta http-equiv="refresh" content="0; url=/v0.3.0">
44
</head>
55
</html>

‎docs/v0.3.0/about_docs.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
About the Documentation
2+
=======================
3+
4+
Learn how to contribute to Envoy Gateway documentation.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
dev/DOCS

‎docs/v0.3.0/api/config_types.md‎

Lines changed: 279 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,279 @@
1+
# API Reference
2+
3+
## Packages
4+
- [config.gateway.envoyproxy.io/v1alpha1](#configgatewayenvoyproxyiov1alpha1)
5+
6+
7+
## config.gateway.envoyproxy.io/v1alpha1
8+
9+
Package v1alpha1 contains API schema definitions for the config.gateway.envoyproxy.io
10+
API group.
11+
12+
13+
### Resource Types
14+
- [EnvoyGateway](#envoygateway)
15+
- [EnvoyProxy](#envoyproxy)
16+
17+
18+
19+
## EnvoyGateway
20+
21+
22+
23+
EnvoyGateway is the schema for the envoygateways API.
24+
25+
26+
27+
| Field | Description |
28+
| --- | --- |
29+
| `apiVersion` _string_ | `config.gateway.envoyproxy.io/v1alpha1`
30+
| `kind` _string_ | `EnvoyGateway`
31+
| `EnvoyGatewaySpec` _[EnvoyGatewaySpec](#envoygatewayspec)_ | EnvoyGatewaySpec defines the desired state of EnvoyGateway. |
32+
33+
34+
## EnvoyGatewaySpec
35+
36+
37+
38+
EnvoyGatewaySpec defines the desired state of Envoy Gateway.
39+
40+
_Appears in:_
41+
- [EnvoyGateway](#envoygateway)
42+
43+
| Field | Description |
44+
| --- | --- |
45+
| `gateway` _[Gateway](#gateway)_ | Gateway defines desired Gateway API specific configuration. If unset, default configuration parameters will apply. |
46+
| `provider` _[Provider](#provider)_ | Provider defines the desired provider and provider-specific configuration. If unspecified, the Kubernetes provider is used with default configuration parameters. |
47+
| `rateLimit` _[RateLimit](#ratelimit)_ | RateLimit defines the configuration associated with the Rate Limit service deployed by Envoy Gateway required to implement the Global Rate limiting functionality. The specific rate limit service used here is the reference implementation in Envoy. For more details visit https://github.com/envoyproxy/ratelimit. This configuration is unneeded for "Local" rate limiting. |
48+
49+
50+
## EnvoyProxy
51+
52+
53+
54+
EnvoyProxy is the schema for the envoyproxies API.
55+
56+
57+
58+
| Field | Description |
59+
| --- | --- |
60+
| `apiVersion` _string_ | `config.gateway.envoyproxy.io/v1alpha1`
61+
| `kind` _string_ | `EnvoyProxy`
62+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
63+
| `spec` _[EnvoyProxySpec](#envoyproxyspec)_ | EnvoyProxySpec defines the desired state of EnvoyProxy. |
64+
65+
66+
## EnvoyProxySpec
67+
68+
69+
70+
EnvoyProxySpec defines the desired state of EnvoyProxy.
71+
72+
_Appears in:_
73+
- [EnvoyProxy](#envoyproxy)
74+
75+
| Field | Description |
76+
| --- | --- |
77+
| `provider` _[ResourceProvider](#resourceprovider)_ | Provider defines the desired resource provider and provider-specific configuration. If unspecified, the "Kubernetes" resource provider is used with default configuration parameters. |
78+
| `logging` _[ProxyLogging](#proxylogging)_ | Logging defines logging parameters for managed proxies. If unspecified, default settings apply. This type is not implemented until https://github.com/envoyproxy/gateway/issues/280 is fixed. |
79+
80+
81+
82+
83+
## FileProvider
84+
85+
86+
87+
FileProvider defines configuration for the File provider.
88+
89+
_Appears in:_
90+
- [Provider](#provider)
91+
92+
93+
94+
## Gateway
95+
96+
97+
98+
Gateway defines the desired Gateway API configuration of Envoy Gateway.
99+
100+
_Appears in:_
101+
- [EnvoyGatewaySpec](#envoygatewayspec)
102+
103+
| Field | Description |
104+
| --- | --- |
105+
| `controllerName` _string_ | ControllerName defines the name of the Gateway API controller. If unspecified, defaults to "gateway.envoyproxy.io/gatewayclass-controller". See the following for additional details: https://gateway-api.sigs.k8s.io/v1alpha2/references/spec/#gateway.networking.k8s.io/v1alpha2.GatewayClass |
106+
107+
108+
## KubernetesDeploymentSpec
109+
110+
111+
112+
KubernetesDeploymentSpec defines the desired state of the Kubernetes deployment resource.
113+
114+
_Appears in:_
115+
- [KubernetesResourceProvider](#kubernetesresourceprovider)
116+
117+
| Field | Description |
118+
| --- | --- |
119+
| `replicas` _integer_ | Replicas is the number of desired pods. Defaults to 1. |
120+
121+
122+
## KubernetesProvider
123+
124+
125+
126+
KubernetesProvider defines configuration for the Kubernetes provider.
127+
128+
_Appears in:_
129+
- [Provider](#provider)
130+
131+
132+
133+
## KubernetesResourceProvider
134+
135+
136+
137+
KubernetesResourceProvider defines configuration for the Kubernetes resource provider.
138+
139+
_Appears in:_
140+
- [ResourceProvider](#resourceprovider)
141+
142+
| Field | Description |
143+
| --- | --- |
144+
| `envoyDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the manged Envoy deployment resource are applied. |
145+
146+
147+
## LogComponent
148+
149+
_Underlying type:_ `string`
150+
151+
LogComponent defines a component that supports a configured logging level. This type is not implemented until https://github.com/envoyproxy/gateway/issues/280 is fixed.
152+
153+
_Appears in:_
154+
- [ProxyLogging](#proxylogging)
155+
156+
157+
158+
## LogLevel
159+
160+
_Underlying type:_ `string`
161+
162+
LogLevel defines a log level for system logs. This type is not implemented until https://github.com/envoyproxy/gateway/issues/280 is fixed.
163+
164+
_Appears in:_
165+
- [ProxyLogging](#proxylogging)
166+
167+
168+
169+
## Provider
170+
171+
172+
173+
Provider defines the desired configuration of a provider.
174+
175+
_Appears in:_
176+
- [EnvoyGatewaySpec](#envoygatewayspec)
177+
178+
| Field | Description |
179+
| --- | --- |
180+
| `type` _[ProviderType](#providertype)_ | Type is the type of provider to use. Supported types are "Kubernetes". |
181+
| `kubernetes` _[KubernetesProvider](#kubernetesprovider)_ | Kubernetes defines the configuration of the Kubernetes provider. Kubernetes provides runtime configuration via the Kubernetes API. |
182+
| `file` _[FileProvider](#fileprovider)_ | File defines the configuration of the File provider. File provides runtime configuration defined by one or more files. This type is not implemented until https://github.com/envoyproxy/gateway/issues/1001 is fixed. |
183+
184+
185+
## ProviderType
186+
187+
_Underlying type:_ `string`
188+
189+
ProviderType defines the types of providers supported by Envoy Gateway.
190+
191+
_Appears in:_
192+
- [Provider](#provider)
193+
- [ResourceProvider](#resourceprovider)
194+
195+
196+
197+
## ProxyLogging
198+
199+
200+
201+
ProxyLogging defines logging parameters for managed proxies. This type is not implemented until https://github.com/envoyproxy/gateway/issues/280 is fixed.
202+
203+
_Appears in:_
204+
- [EnvoyProxySpec](#envoyproxyspec)
205+
206+
| Field | Description |
207+
| --- | --- |
208+
| `level` _object (keys:[LogComponent](#logcomponent), values:[LogLevel](#loglevel))_ | Level is a map of logging level per component, where the component is the key and the log level is the value. If unspecified, defaults to "System: Info". |
209+
210+
211+
## RateLimit
212+
213+
214+
215+
RateLimit defines the configuration associated with the Rate Limit Service used for Global Rate Limiting.
216+
217+
_Appears in:_
218+
- [EnvoyGatewaySpec](#envoygatewayspec)
219+
220+
| Field | Description |
221+
| --- | --- |
222+
| `backend` _[RateLimitDatabaseBackend](#ratelimitdatabasebackend)_ | Backend holds the configuration associated with the database backend used by the rate limit service to store state associated with global ratelimiting. |
223+
224+
225+
## RateLimitDatabaseBackend
226+
227+
228+
229+
RateLimitDatabaseBackend defines the configuration associated with the database backend used by the rate limit service.
230+
231+
_Appears in:_
232+
- [RateLimit](#ratelimit)
233+
234+
| Field | Description |
235+
| --- | --- |
236+
| `type` _[RateLimitDatabaseBackendType](#ratelimitdatabasebackendtype)_ | Type is the type of database backend to use. Supported types are: * Redis: Connects to a Redis database. |
237+
| `redis` _[RateLimitRedisSettings](#ratelimitredissettings)_ | Redis defines the settings needed to connect to a Redis database. |
238+
239+
240+
## RateLimitDatabaseBackendType
241+
242+
_Underlying type:_ `string`
243+
244+
RateLimitDatabaseBackendType specifies the types of database backend to be used by the rate limit service.
245+
246+
_Appears in:_
247+
- [RateLimitDatabaseBackend](#ratelimitdatabasebackend)
248+
249+
250+
251+
## RateLimitRedisSettings
252+
253+
254+
255+
RateLimitRedisSettings defines the configuration for connecting to a Redis database.
256+
257+
_Appears in:_
258+
- [RateLimitDatabaseBackend](#ratelimitdatabasebackend)
259+
260+
| Field | Description |
261+
| --- | --- |
262+
| `url` _string_ | URL of the Redis Database. |
263+
264+
265+
## ResourceProvider
266+
267+
268+
269+
ResourceProvider defines the desired state of a resource provider.
270+
271+
_Appears in:_
272+
- [EnvoyProxySpec](#envoyproxyspec)
273+
274+
| Field | Description |
275+
| --- | --- |
276+
| `type` _[ProviderType](#providertype)_ | Type is the type of resource provider to use. A resource provider provides infrastructure resources for running the data plane, e.g. Envoy proxy, and optional auxiliary control planes. Supported types are "Kubernetes". |
277+
| `kubernetes` _[KubernetesResourceProvider](#kubernetesresourceprovider)_ | Kubernetes defines the desired state of the Kubernetes resource provider. Kubernetes provides infrastructure resources for running the data plane, e.g. Envoy proxy. If unspecified and type is "Kubernetes", default settings for managed Kubernetes resources are applied. |
278+
279+

0 commit comments

Comments
 (0)