Skip to content

Commit

Permalink
chore:bump codespell and fix existing codespell errs (#1933)
Browse files Browse the repository at this point in the history
* bump codespell and fix existing codespell errs

Taking #1924 forward

Signed-off-by: Arko Dasgupta <[email protected]>

* more spelling fixes

Signed-off-by: Arko Dasgupta <[email protected]>

* last one

Signed-off-by: Arko Dasgupta <[email protected]>

---------

Signed-off-by: Arko Dasgupta <[email protected]>
  • Loading branch information
arkodg authored Oct 7, 2023
1 parent 5d3c1b4 commit 1e73685
Show file tree
Hide file tree
Showing 30 changed files with 38 additions and 38 deletions.
2 changes: 1 addition & 1 deletion api/v1alpha1/envoygateway_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ type EnvoyGatewayProvider struct {
// EnvoyGatewayKubernetesProvider defines configuration for the Kubernetes provider.
type EnvoyGatewayKubernetesProvider struct {
// RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource.
// If unspecified, default settings for the manged Envoy ratelimit deployment resource
// If unspecified, default settings for the managed Envoy ratelimit deployment resource
// are applied.
//
// +optional
Expand Down
4 changes: 2 additions & 2 deletions api/v1alpha1/envoyproxy_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,14 @@ type EnvoyProxyProvider struct {
// provider.
type EnvoyProxyKubernetesProvider struct {
// EnvoyDeployment defines the desired state of the Envoy deployment resource.
// If unspecified, default settings for the manged Envoy deployment resource
// If unspecified, default settings for the managed Envoy deployment resource
// are applied.
//
// +optional
EnvoyDeployment *KubernetesDeploymentSpec `json:"envoyDeployment,omitempty"`

// EnvoyService defines the desired state of the Envoy service resource.
// If unspecified, default settings for the manged Envoy service resource
// If unspecified, default settings for the managed Envoy service resource
// are applied.
//
// +optional
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ spec:
envoyDeployment:
description: EnvoyDeployment defines the desired state of
the Envoy deployment resource. If unspecified, default settings
for the manged Envoy deployment resource are applied.
for the managed Envoy deployment resource are applied.
properties:
container:
description: Container defines the resources and securityContext
Expand Down Expand Up @@ -3800,7 +3800,7 @@ spec:
envoyService:
description: EnvoyService defines the desired state of the
Envoy service resource. If unspecified, default settings
for the manged Envoy service resource are applied.
for the managed Envoy service resource are applied.
properties:
allocateLoadBalancerNodePorts:
description: AllocateLoadBalancerNodePorts defines if
Expand Down
6 changes: 3 additions & 3 deletions docs/latest/api/extension_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `rateLimitDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource. If unspecified, default settings for the manged Envoy ratelimit deployment resource are applied. |
| `rateLimitDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource. If unspecified, default settings for the managed Envoy ratelimit deployment resource are applied. |
| `watch` _[KubernetesWatchMode](#kuberneteswatchmode)_ | Watch holds configuration of which input resources should be watched and reconciled. |
| `deploy` _[KubernetesDeployMode](#kubernetesdeploymode)_ | Deploy holds configuration of how output managed resources such as the Envoy Proxy data plane should be deployed |
| `overwrite_control_plane_certs` _boolean_ | OverwriteControlPlaneCerts updates the secrets containing the control plane certs, when set. |
Expand Down Expand Up @@ -491,8 +491,8 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `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. |
| `envoyService` _[KubernetesServiceSpec](#kubernetesservicespec)_ | EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the manged Envoy service resource are applied. |
| `envoyDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the managed Envoy deployment resource are applied. |
| `envoyService` _[KubernetesServiceSpec](#kubernetesservicespec)_ | EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the managed Envoy service resource are applied. |


## EnvoyProxyProvider
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/design/accesslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Envoy supports extensible accesslog to different sinks, File, gRPC etc. Envoy supports customizable access log formats using predefined fields as well as arbitrary HTTP request and response headers. Envoy supports several built-in access log filters and extension filters that are registered at runtime.

Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementors such as Envoy Gateway to expose features. Since accesslog is not covered by `Core` or `Extended` APIs, EG should provide an easy to config access log formats and sinks per `EnvoyProxy`.
Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementers such as Envoy Gateway to expose features. Since accesslog is not covered by `Core` or `Extended` APIs, EG should provide an easy to config access log formats and sinks per `EnvoyProxy`.

## Goals

Expand Down
2 changes: 1 addition & 1 deletion docs/latest/design/client-traffic-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ it targets a specific Listener within a `Gateway` and Policy B has a `targetRef`
entire Gateway then
* Policy A will be applied/attached to the specific Listener defined in the `targetRef.SectionName`
* Policy B will be applied to the remaining Listeners within the Gateway. Policy B will have an additional
status condition `Overriden=True`.
status condition `Overridden=True`.

## Alternatives
* The project can indefintely wait for these configuration parameters to be part of the [Gateway API].
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/design/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Envoy enables prometheus format output via the `/stats/prometheus` [admin endpoi

Envoy support different kinds of sinks, but EG will only support [Open Telemetry sink](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/stat_sinks/open_telemetry/v3/open_telemetry.proto).

Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementors such as Envoy Gateway to expose features. Since metrics is not covered by `Core` or `Extended` APIs, EG should provide an easy to config metrics per `EnvoyProxy`.
Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementers such as Envoy Gateway to expose features. Since metrics is not covered by `Core` or `Extended` APIs, EG should provide an easy to config metrics per `EnvoyProxy`.

## Goals

Expand Down
2 changes: 1 addition & 1 deletion docs/latest/design/rate-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ attribute such as [IP subnet][] in the future that are not relevant in the [HTTP
### Global Rate limiting

* [Global rate limiting][] in Envoy Proxy can be achieved using the following -
* [Actions][] can be conifgured per [xDS Route][].
* [Actions][] can be configured per [xDS Route][].
* If the match criteria defined within these actions is met for a specific HTTP Request, a set of key value pairs called [descriptors][]
defined within the above actions is sent to a remote [rate limit service][], whose configuration (such as the URL for the rate limit service) is defined
using a [rate limit filter][].
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/design/request-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ will be rejected if it contains invalid authentication information, based on the
proposed in this design document.

Envoy Gateway leverages [Gateway API][] for configuring managed Envoy proxies. Gateway API defines core, extended, and
implementation-specific API [support levels][] for implementors such as Envoy Gateway to expose features. Since
implementation-specific API [support levels][] for implementers such as Envoy Gateway to expose features. Since
implementing request authentication is not covered by `Core` or `Extended` APIs, an `Implementation-specific` API will
be created for this purpose.

Expand Down
2 changes: 1 addition & 1 deletion docs/latest/design/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Envoy supports extensible tracing to different sinks, Zipkin, OpenTelemetry etc. Overview of Envoy tracing can be found [here](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/observability/tracing).

Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementors such as Envoy Gateway to expose features. Since tracing is not covered by `Core` or `Extended` APIs, EG should provide an easy to config tracing per `EnvoyProxy`.
Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementers such as Envoy Gateway to expose features. Since tracing is not covered by `Core` or `Extended` APIs, EG should provide an easy to config tracing per `EnvoyProxy`.

Only OpenTelemetry sink can be configured currently, you can use [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) to export to other tracing backends.

Expand Down
2 changes: 1 addition & 1 deletion docs/latest/releases/v0.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The release adds a ton of features and functionality. Here are some highlights:
### Ratelimiting

+ Added Support for Distinct Ratelimiting Based On IP Addresses
+ Added upport for JWT Claim based Ratelimiting
+ Added Support for JWT Claim based Ratelimiting
+ Switched to Xds SOTW Server for RateLimit Service Configuration

### API Updates
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/user/envoy-patch-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ not exposed by Envoy Gateway APIs today.

## Quickstart

### Prerequistes
### Prerequisites

* Follow the steps from the [Quickstart](quickstart.md) guide to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.3.0/api/config_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `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. |
| `envoyDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the managed Envoy deployment resource are applied. |


## LogComponent
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.3.0/design/ratelimit.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ attribute such as [IP subnet][] in the future that are not relevant in the [HTTP
### Global Rate limiting

* [Global rate limiting][] in Envoy Proxy can be achieved using the following -
* [Actions][] can be conifgured per [xDS Route][].
* [Actions][] can be configured per [xDS Route][].
* If the match criteria defined within these actions is met for a specific HTTP Request, a set of key value pairs called [descriptors][]
defined within the above actions is sent to a remote [rate limit service][], whose configuration (such as the URL for the rate limit service) is defined
using a [rate limit filter][].
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.3.0/design/request-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ will be rejected if it contains invalid authentication information, based on the
proposed in this design document.

Envoy Gateway leverages [Gateway API][] for configuring managed Envoy proxies. Gateway API defines core, extended, and
implementation-specific API [support levels][] for implementors such as Envoy Gateway to expose features. Since
implementation-specific API [support levels][] for implementers such as Envoy Gateway to expose features. Since
implementing request authentication is not covered by `Core` or `Extended` APIs, an `Implementation-specific` API will
be created for this purpose.

Expand Down
6 changes: 3 additions & 3 deletions docs/v0.4.0/api/config_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `rateLimitDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource. If unspecified, default settings for the manged Envoy ratelimit deployment resource are applied. |
| `rateLimitDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource. If unspecified, default settings for the managed Envoy ratelimit deployment resource are applied. |


## EnvoyGatewayProvider
Expand Down Expand Up @@ -116,8 +116,8 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `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. |
| `envoyService` _[KubernetesServiceSpec](#kubernetesservicespec)_ | EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the manged Envoy service resource are applied. |
| `envoyDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the managed Envoy deployment resource are applied. |
| `envoyService` _[KubernetesServiceSpec](#kubernetesservicespec)_ | EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the managed Envoy service resource are applied. |


## EnvoyProxyProvider
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.4.0/design/rate-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ attribute such as [IP subnet][] in the future that are not relevant in the [HTTP
### Global Rate limiting

* [Global rate limiting][] in Envoy Proxy can be achieved using the following -
* [Actions][] can be conifgured per [xDS Route][].
* [Actions][] can be configured per [xDS Route][].
* If the match criteria defined within these actions is met for a specific HTTP Request, a set of key value pairs called [descriptors][]
defined within the above actions is sent to a remote [rate limit service][], whose configuration (such as the URL for the rate limit service) is defined
using a [rate limit filter][].
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.4.0/design/request-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ will be rejected if it contains invalid authentication information, based on the
proposed in this design document.

Envoy Gateway leverages [Gateway API][] for configuring managed Envoy proxies. Gateway API defines core, extended, and
implementation-specific API [support levels][] for implementors such as Envoy Gateway to expose features. Since
implementation-specific API [support levels][] for implementers such as Envoy Gateway to expose features. Since
implementing request authentication is not covered by `Core` or `Extended` APIs, an `Implementation-specific` API will
be created for this purpose.

Expand Down
6 changes: 3 additions & 3 deletions docs/v0.5.0/api/config_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `rateLimitDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource. If unspecified, default settings for the manged Envoy ratelimit deployment resource are applied. |
| `rateLimitDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | RateLimitDeployment defines the desired state of the Envoy ratelimit deployment resource. If unspecified, default settings for the managed Envoy ratelimit deployment resource are applied. |
| `watch` _[KubernetesWatchMode](#kuberneteswatchmode)_ | Watch holds configuration of which input resources should be watched and reconciled. |
| `deploy` _[KubernetesDeployMode](#kubernetesdeploymode)_ | Deploy holds configuration of how output managed resources such as the Envoy Proxy data plane should be deployed |
| `overwrite_control_plane_certs` _boolean_ | OverwriteControlPlaneCerts updates the secrets containing the control plane certs, when set. |
Expand Down Expand Up @@ -288,8 +288,8 @@ _Appears in:_

| Field | Description |
| --- | --- |
| `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. |
| `envoyService` _[KubernetesServiceSpec](#kubernetesservicespec)_ | EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the manged Envoy service resource are applied. |
| `envoyDeployment` _[KubernetesDeploymentSpec](#kubernetesdeploymentspec)_ | EnvoyDeployment defines the desired state of the Envoy deployment resource. If unspecified, default settings for the managed Envoy deployment resource are applied. |
| `envoyService` _[KubernetesServiceSpec](#kubernetesservicespec)_ | EnvoyService defines the desired state of the Envoy service resource. If unspecified, default settings for the managed Envoy service resource are applied. |


## EnvoyProxyProvider
Expand Down
2 changes: 1 addition & 1 deletion docs/v0.5.0/design/accesslog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Envoy supports extensible accesslog to different sinks, File, gRPC etc. Envoy supports customizable access log formats using predefined fields as well as arbitrary HTTP request and response headers. Envoy supports several built-in access log filters and extension filters that are registered at runtime.

Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementors such as Envoy Gateway to expose features. Since accesslog is not covered by `Core` or `Extended` APIs, EG should provide an easy to config access log formats and sinks per `EnvoyProxy`.
Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementers such as Envoy Gateway to expose features. Since accesslog is not covered by `Core` or `Extended` APIs, EG should provide an easy to config access log formats and sinks per `EnvoyProxy`.

## Goals

Expand Down
2 changes: 1 addition & 1 deletion docs/v0.5.0/design/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Envoy enables prometheus format output via the `/stats/prometheus` [admin endpoi

Envoy support different kinds of sinks, but EG will only support [Open Telemetry sink](https://www.envoyproxy.io/docs/envoy/latest/api-v3/extensions/stat_sinks/open_telemetry/v3/open_telemetry.proto).

Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementors such as Envoy Gateway to expose features. Since metrics is not covered by `Core` or `Extended` APIs, EG should provide an easy to config metrics per `EnvoyProxy`.
Envoy Gateway leverages [Gateway API](https://gateway-api.sigs.k8s.io/) for configuring managed Envoy proxies. Gateway API defines core, extended, and implementation-specific API [support levels](https://gateway-api.sigs.k8s.io/concepts/conformance/?h=extended#2-support-levels) for implementers such as Envoy Gateway to expose features. Since metrics is not covered by `Core` or `Extended` APIs, EG should provide an easy to config metrics per `EnvoyProxy`.

## Goals

Expand Down
Loading

0 comments on commit 1e73685

Please sign in to comment.