Skip to content

Commit

Permalink
docs: (envoyproxy#3137) surrounds shell blocks with blank lines for l…
Browse files Browse the repository at this point in the history 
…inting

Signed-off-by: Eitan Suez <eitan@tetrate.io>
  • Loading branch information
Eitan Suez committed Apr 23, 2024
1 parent 2613c33 commit c73859a
Show file tree
Hide file tree
Showing 32 changed files with 297 additions and 0 deletions.
9 changes: 9 additions & 0 deletions site/content/en/latest/tasks/extensibility/envoy-patch-policy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ using a `ConfigMap`. In the next step, we will update this resource to enable En

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: v1
Expand All @@ -53,6 +54,7 @@ data:
enableEnvoyPatchPolicy: true
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -75,6 +77,7 @@ data:
extensionApis:
enableEnvoyPatchPolicy: true
```
{{% /tab %}}
{{< /tabpane >}}
Expand All @@ -95,6 +98,7 @@ the status code is `404`

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand Down Expand Up @@ -130,6 +134,7 @@ spec:
inline_string: "could not find what you are looking for"
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand Down Expand Up @@ -168,6 +173,7 @@ spec:
body:
inline_string: "could not find what you are looking for"
```

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

Expand All @@ -176,6 +182,7 @@ Then the EnvoyPatchPolicy should target a specific GatewayClass.

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand Down Expand Up @@ -211,6 +218,7 @@ spec:
inline_string: "could not find what you are looking for"
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand Down Expand Up @@ -249,6 +257,7 @@ spec:
body:
inline_string: "could not find what you are looking for"
```

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

Expand Down
3 changes: 3 additions & 0 deletions site/content/en/latest/tasks/observability/rate-limit-observability.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ we only want to sample `50%` of the trace data. We would configure it as follows

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: v1
Expand Down Expand Up @@ -64,6 +65,7 @@ data:
url: otel-svc.observability.svc.cluster.local:4318
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand Down Expand Up @@ -94,6 +96,7 @@ data:
provider:
url: otel-svc.observability.svc.cluster.local:4318
```
{{% /tab %}}
{{< /tabpane >}}
Expand Down
36 changes: 36 additions & 0 deletions site/content/en/latest/tasks/operations/customize-envoyproxy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ First, you need to add ParametersRef in GatewayClass, and refer to EnvoyProxy Co

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.networking.k8s.io/v1
Expand All @@ -32,6 +33,7 @@ spec:
namespace: envoy-gateway-system
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -50,6 +52,7 @@ spec:
name: custom-proxy-config
namespace: envoy-gateway-system
```
{{% /tab %}}
{{< /tabpane >}}
Expand All @@ -59,6 +62,7 @@ You can customize the EnvoyProxy Deployment Replicas via EnvoyProxy Config like:
{{< tabpane text=true >}}
{{% tab header="Apply from stdin" %}}
```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -74,6 +78,7 @@ spec:
replicas: 2
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -92,6 +97,7 @@ spec:
envoyDeployment:
replicas: 2
```
{{% /tab %}}
{{< /tabpane >}}
Expand All @@ -108,6 +114,7 @@ You can customize the EnvoyProxy Image via EnvoyProxy Config like:

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -124,6 +131,7 @@ spec:
image: envoyproxy/envoy:v1.25-latest
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -143,6 +151,7 @@ spec:
container:
image: envoyproxy/envoy:v1.25-latest
```
{{% /tab %}}
{{< /tabpane >}}
Expand All @@ -154,6 +163,7 @@ You can customize the EnvoyProxy Pod Annotations via EnvoyProxy Config like:
{{< tabpane text=true >}}
{{% tab header="Apply from stdin" %}}
```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -172,6 +182,7 @@ spec:
custom2: deploy-annotation2
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -193,6 +204,7 @@ spec:
custom1: deploy-annotation1
custom2: deploy-annotation2
```
{{% /tab %}}
{{< /tabpane >}}
Expand All @@ -204,6 +216,7 @@ You can customize the EnvoyProxy Deployment Resources via EnvoyProxy Config like
{{< tabpane text=true >}}
{{% tab header="Apply from stdin" %}}
```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -226,6 +239,7 @@ spec:
memory: 1Gi
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -251,6 +265,7 @@ spec:
cpu: 500m
memory: 1Gi
```
{{% /tab %}}
{{< /tabpane >}}
Expand All @@ -260,6 +275,7 @@ You can customize the EnvoyProxy Deployment Env via EnvoyProxy Config like:
{{< tabpane text=true >}}
{{% tab header="Apply from stdin" %}}
```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -280,6 +296,7 @@ spec:
value: env_b_value
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -303,6 +320,7 @@ spec:
- name: env_b
value: env_b_value
```
{{% /tab %}}
{{< /tabpane >}}
Expand All @@ -316,6 +334,7 @@ You can customize the EnvoyProxy Deployment Volumes or VolumeMounts via EnvoyPro

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -340,6 +359,7 @@ spec:
secretName: envoy-cert
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand Down Expand Up @@ -367,6 +387,7 @@ spec:
secret:
secretName: envoy-cert
```

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

Expand All @@ -378,6 +399,7 @@ You can customize the EnvoyProxy Service Annotations via EnvoyProxy Config like:

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -395,6 +417,7 @@ spec:
custom2: svc-annotation2
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -415,6 +438,7 @@ spec:
custom1: svc-annotation1
custom2: svc-annotation2
```

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

Expand All @@ -430,6 +454,7 @@ There are two ways to customize it:

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand Down Expand Up @@ -513,6 +538,7 @@ spec:
name: runtime-0
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand Down Expand Up @@ -599,6 +625,7 @@ spec:
resource_api_version: V3
name: runtime-0
```

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

Expand All @@ -617,6 +644,7 @@ Once confirmed, you can apply it via EnvoyProxy Config as shown below:

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -640,6 +668,7 @@ spec:
type: Resource
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -666,6 +695,7 @@ spec:
type: Utilization
type: Resource
```

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

Expand All @@ -678,6 +708,7 @@ For example, the following configuration will add `--disable-extensions` arg in

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand All @@ -690,6 +721,7 @@ spec:
- --disable-extensions envoy.access_loggers/envoy.access_loggers.wasm
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand All @@ -705,6 +737,7 @@ spec:
extraArgs:
- --disable-extensions envoy.access_loggers/envoy.access_loggers.wasm
```

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

Expand All @@ -716,6 +749,7 @@ For example, the following configuration will add resource limits to the `envoy`

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

```shell
cat <<EOF | kubectl apply -f -
apiVersion: gateway.envoyproxy.io/v1alpha1
Expand Down Expand Up @@ -747,6 +781,7 @@ spec:
memory: 1024Mi
EOF
```

{{% /tab %}}
{{% tab header="Apply from file" %}}
Save and apply the following resource to your cluster:
Expand Down Expand Up @@ -781,6 +816,7 @@ spec:
cpu: 200m
memory: 1024Mi
```

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

Expand Down
Loading

0 comments on commit c73859a

Please sign in to comment.