Skip to content

Commit 0e5fcd7

Browse files
DeeBi9guydc
authored andcommitted
docs: update prerequisites files with installation and connectivity t… (envoyproxy#5094)
* docs: update prerequisites files with installation and connectivity testing steps Signed-off-by: DeeBi9 <[email protected]> * lint Signed-off-by: DeeBi9 <[email protected]> * docs: remove the Note Signed-off-by: DeeBi9 <[email protected]> * remove redundant code Signed-off-by: DeeBi9 <[email protected]> --------- Signed-off-by: DeeBi9 <[email protected]> (cherry picked from commit 3253339) Signed-off-by: Guy Daich <[email protected]>
1 parent e02908c commit 0e5fcd7

File tree

2 files changed

+63
-17
lines changed

2 files changed

+63
-17
lines changed

site/content/en/latest/boilerplates/o11y_prerequisites.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
---
33

4-
Follow the steps from the [Quickstart](../tasks/quickstart) to install Envoy Gateway and the example manifest.
5-
Before proceeding, you should be able to query the example backend using HTTP.
4+
{{< readfile "./prerequisites.md" >}}
5+
6+
---
67

78
Envoy Gateway provides an add-ons Helm Chart, which includes all the needing components for observability.
89
By default, the [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) is disabled.
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,69 @@
11
---
22
---
33

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

7-
Verify the Gateway status:
7+
<details>
8+
<summary>Expand for instructions</summary>
89

9-
{{< tabpane text=true >}}
10-
{{% tab header="kubectl" %}}
10+
1. Install the Gateway API CRDs and Envoy Gateway using Helm:
1111

12-
```shell
13-
kubectl get gateway/eg -o yaml
14-
```
12+
```shell
13+
helm install eg oci://docker.io/envoyproxy/gateway-helm --version {{< helm-version >}} -n envoy-gateway-system --create-namespace
14+
```
1515

16-
{{% /tab %}}
17-
{{% tab header="egctl (experimental)" %}}
16+
2. Install the GatewayClass, Gateway, HTTPRoute and example app:
1817

19-
```shell
20-
egctl x status gateway -v
21-
```
18+
```shell
19+
kubectl apply -f https://github.com/envoyproxy/gateway/releases/download/{{< yaml-version >}}/quickstart.yaml -n default
20+
```
2221

23-
{{% /tab %}}
24-
{{< /tabpane >}}
22+
3. Verify Connectivity:
23+
24+
{{< tabpane text=true >}}
25+
{{% tab header="With External LoadBalancer Support" %}}
26+
27+
You can also test the same functionality by sending traffic to the External IP. To get the external IP of the
28+
Envoy service, run:
29+
30+
```shell
31+
export GATEWAY_HOST=$(kubectl get gateway/eg -o jsonpath='{.status.addresses[0].value}')
32+
```
33+
34+
**Note**: In certain environments, the load balancer may be exposed using a hostname, instead of an IP address. If so, replace
35+
`ip` in the above command with `hostname`.
36+
37+
Curl the example app through Envoy proxy:
38+
39+
```shell
40+
curl --verbose --header "Host: www.example.com" http://$GATEWAY_HOST/get
41+
```
42+
43+
{{% /tab %}}
44+
{{% tab header="Without LoadBalancer Support" %}}
45+
46+
Get the name of the Envoy service created by the example Gateway:
47+
48+
```shell
49+
export ENVOY_SERVICE=$(kubectl get svc -n envoy-gateway-system --selector=gateway.envoyproxy.io/owning-gateway-namespace=default,gateway envoyproxy.io/owning-gateway-name=eg -o jsonpath='{.items[0].metadata.name}')
50+
```
51+
52+
Port forward to the Envoy service:
53+
54+
```shell
55+
kubectl -n envoy-gateway-system port-forward service/${ENVOY_SERVICE} 8888:80 &
56+
```
57+
58+
Curl the example app through Envoy proxy:
59+
60+
```shell
61+
curl --verbose --header "Host: www.example.com" http://localhost:8888/get
62+
```
63+
64+
{{% /tab %}}
65+
{{< /tabpane >}}
66+
67+
</details>
68+
69+
---

0 commit comments

Comments
 (0)