Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Attach EnvoyProxy to Gateway #4020

Merged
merged 4 commits into from
Aug 10, 2024
Merged

docs: Attach EnvoyProxy to Gateway #4020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
80d433e
docs: Attach EnvoyProxy to Gateway
arkodg Aug 8, 2024
8183c10
fix lint
arkodg Aug 8, 2024
f0acc47
copy prerequisites into v1.1
arkodg Aug 8, 2024
e11b477
Merge branch 'main' into attach-gw
zirain Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions site/content/en/docs/boilerplates/prerequisites.md
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recall there's a PR from @shawnh2 handle this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like it was only added to latest

Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
---

Follow the steps from the [Quickstart](../tasks/quickstart) task to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.

Verify the Gateway status:

{{< tabpane text=true >}}
{{% tab header="kubectl" %}}

```shell
kubectl get gateway/eg -o yaml
```

{{% /tab %}}
{{% tab header="egctl (experimental)" %}}

```shell
egctl x status gateway -v
```

{{% /tab %}}
{{< /tabpane >}}
117 changes: 85 additions & 32 deletions site/content/en/docs/tasks/operations/customize-envoyproxy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,68 @@ title: "Customize EnvoyProxy"
---

Envoy Gateway provides an [EnvoyProxy][] CRD that can be linked to the ParametersRef
in GatewayClass, allowing cluster admins to customize the managed EnvoyProxy Deployment and
in a Gateway and GatewayClass, allowing cluster admins to customize the managed EnvoyProxy Deployment and
Service. To learn more about GatewayClass and ParametersRef, please refer to [Gateway API documentation][].

## Prerequisites

Follow the steps from the [Quickstart](../../quickstart) to install Envoy Gateway and the example manifest.
Before proceeding, you should be able to query the example backend using HTTP.
{{< boilerplate prerequisites >}}

Before you start, you need to add `ParametersRef` in GatewayClass, and refer to EnvoyProxy Config:
Before you start, you need to add `Infrastructure.ParametersRef` in Gateway, and refer to EnvoyProxy Config:
**Note**: `MergeGateways` cannot be set to `true` in your EnvoyProxy config if attaching to the Gateway.

{{< tabpane text=true >}}
{{% tab header="Apply from stdin" %}}

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
name: eg
spec:
gatewayClassName: eg
infrastructure:
parametersRef:
group: gateway.envoyproxy.io
kind: EnvoyProxy
name: custom-proxy-config
listeners:
- name: http
protocol: HTTP
port: 80
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:

```yaml
---
apiVersion: gateway.networking.k8s.io/v1
kind: Gateway
metadata:
name: eg
spec:
gatewayClassName: eg
infrastructure:
parametersRef:
group: gateway.envoyproxy.io
kind: EnvoyProxy
name: custom-proxy-config
listeners:
- name: http
protocol: HTTP
port: 80
```

{{% /tab %}}
{{< /tabpane >}}

You can also attach the EnvoyProxy resource to the GatewayClass using the `parametersRef` field.
This configuration is discouraged if you plan on creating multiple Gateways linking to the same
GatewayClass and would like different infrastructure configurations for each of them.

{{< tabpane text=true >}}
{{% tab header="Apply from stdin" %}}
Expand All @@ -28,7 +81,7 @@ spec:
group: gateway.envoyproxy.io
kind: EnvoyProxy
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
EOF
```

Expand All @@ -48,7 +101,7 @@ spec:
group: gateway.envoyproxy.io
kind: EnvoyProxy
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
```

{{% /tab %}}
Expand All @@ -67,7 +120,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand All @@ -87,7 +140,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -119,7 +172,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand All @@ -140,7 +193,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -168,7 +221,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand All @@ -191,7 +244,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -221,7 +274,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand All @@ -248,7 +301,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -280,7 +333,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand All @@ -305,7 +358,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -339,7 +392,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -368,7 +421,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -404,7 +457,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand All @@ -426,7 +479,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -459,7 +512,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
bootstrap:
type: Replace
Expand Down Expand Up @@ -547,7 +600,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
bootstrap:
type: Replace
Expand Down Expand Up @@ -649,7 +702,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -677,7 +730,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -713,7 +766,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
extraArgs:
- --disable-extensions envoy.access_loggers/envoy.access_loggers.wasm
Expand All @@ -730,7 +783,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
extraArgs:
- --disable-extensions envoy.access_loggers/envoy.access_loggers.wasm
Expand All @@ -756,7 +809,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: eg
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -792,7 +845,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: eg
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -835,7 +888,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: eg
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand All @@ -860,7 +913,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: eg
namespace: envoy-gateway-system
namespace: default
spec:
provider:
type: Kubernetes
Expand Down Expand Up @@ -918,7 +971,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
filterOrder:
- name: envoy.filters.http.wasm
Expand All @@ -938,7 +991,7 @@ apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: custom-proxy-config
namespace: envoy-gateway-system
namespace: default
spec:
filterOrder:
- name: envoy.filters.http.wasm
Expand Down
Loading
Loading