Skip to content

Commit 9c6688e

Browse files
Nadine2016Nadine2016
authored
Docs small updates (#10650)
1 parent 52a70ed commit 9c6688e

File tree

9 files changed

+134
-17
lines changed

9 files changed

+134
-17
lines changed

‎changelog/v1.19.0-beta11/docs-small-fixes.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
changelog:
2+
- type: NON_USER_FACING
3+
resolvesIssue: true
4+
description: >-
5+
Removes extproc note, fixes readfile shortcode. Adds in draft for GG UI.

‎docs/content/guides/observability/ui/_index.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Gloo UI
3+
weight:
4+
description:
5+
---
6+
7+
{{< children >}}

‎docs/content/guides/observability/ui/setup.txt

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
title: Set up the Gloo UI
3+
weight:
4+
description: Install the Gloo UI to get an at-a-glance view of the configuration, health, and compliance status of your Gloo Gateway setup and the workloads in your cluster.
5+
---
6+
Install the Gloo UI to get an at-a-glance view of the configuration, health, and compliance status of your Gloo Gateway setup and the workloads in your cluster.
7+
8+
To learn more about the features of the Gloo UI, see [About the Gloo UI]({{< versioned_link_path fromRoot="/guides/observability/ui/explore#about-the-gloo-ui" >}}).
9+
10+
## Before you begin
11+
12+
Install GG
13+
14+
## Set up the Gloo UI
15+
16+
Use these instructions to install the Gloo UI in the same cluster as Gloo Gateway. The Gloo UI analyzes your Gloo Gateway setup and provides metrics and insights to you.
17+
18+
1. Set the name of your cluster and your Gloo Gateway license key as an environment variable.
19+
```sh
20+
export CLUSTER_NAME=<cluster-name>
21+
export GLOO_GATEWAY_LICENSE_KEY=<license-key>
22+
```
23+
24+
2. Add the Helm repo for the Gloo UI.
25+
```sh
26+
helm repo add gloo-platform https://storage.googleapis.com/gloo-platform/helm-charts
27+
helm repo update
28+
```
29+
30+
3. Install the custom resources for the Gloo UI.
31+
```sh
32+
helm upgrade -i gloo-platform-crds gloo-platform/gloo-platform-crds \
33+
--namespace=gloo-system \
34+
--version={{< readfile file="/static/content/version-platform.md" markdown="true">}} \
35+
--set installEnterpriseCrds=false
36+
```
37+
38+
4. Install the Gloo UI and configure it for Gloo Gateway.
39+
```yaml
40+
helm upgrade -i gloo-platform gloo-platform/gloo-platform \
41+
--namespace gloo-system \
42+
--version={{< readfile file="static/content/version-platform.md" markdown="true">}} \
43+
-f - <<EOF
44+
common:
45+
adminNamespace: "gloo-system"
46+
cluster: $CLUSTER_NAME
47+
featureGates:
48+
insightsConfiguration: true
49+
glooInsightsEngine:
50+
enabled: true
51+
glooAnalyzer:
52+
enabled: true
53+
glooUi:
54+
enabled: true
55+
licensing:
56+
glooGatewayLicenseKey: $GLOO_GATEWAY_LICENSE_KEY
57+
prometheus:
58+
enabled: true
59+
telemetryCollector:
60+
enabled: true
61+
mode: deployment
62+
replicaCount: 1
63+
EOF
64+
```
65+
66+
5. Verify that the Gloo UI components are successfully installed.
67+
```sh
68+
kubectl get pods -n gloo-system
69+
```
70+
71+
Example output:
72+
{{< highlight yaml "hl_lines=4-6" >}}
73+
NAME READY STATUS RESTARTS AGE
74+
extauth-f7695bf7f-f6dkt 1/1 Running 0 10m
75+
gloo-587b79d556-tpvfj 1/1 Running 0 10m
76+
gloo-mesh-ui-66db8d9584-kgjld 3/3 Running 0 72m
77+
gloo-telemetry-collector-68b8cf6f49-zhx87 1/1 Running 0 57m
78+
prometheus-server-7484d8bfd-tx5s4 2/2 Running 0 72m
79+
rate-limit-557dcb857f-9zq2t 1/1 Running 0 10m
80+
redis-5d6c6bcd4-cnmbm 1/1 Running 0 10m
81+
{{< /highlight >}}
82+
83+
84+
## Visualize traffic
85+
86+
1. Follow the petstore [hello world example]({{< versioned_link_path fromRoot="/guides/traffic_management/hello_world/" >}}). This example deploys the petstore sample app and exposes a route to the app on your gateway proxy.
87+
88+
2. Send a few requests to the httpbin app.
89+
```sh
90+
for i in {1..10}; do curl $(glooctl proxy url --name gateway-proxy)/all-pets; done
91+
```
92+
93+
7. Open the Gloo UI.
94+
1. Port-forward the Gloo UI pod.
95+
```sh
96+
kubectl port-forward deployment/gloo-mesh-ui -n gloo-system 8090
97+
```
98+
2. Open the Gloo UI dashboard.
99+
```sh
100+
open http://localhost:8090/dashboard
101+
```
102+
103+
![Gloo UI dashboard]({{% versioned_link_path fromRoot="/img/ui-dashboard.png" %}})
104+
105+
8. Go to **Observability** > **Graph** to see the Gloo UI Graph. Select your cluster from the **Cluster** drop-down list, and the `httpbin` and `gloo-system` namespaces from the **Namespace** drop-down list. Verify that you see requests from the gateway proxy to the httpbin app. Note that it might take a few seconds for the graph to show the requests that you sent.
106+
107+
![Gloo UI Graph]({{< versioned_link_path fromRoot="/img/ui-graph.png" >}})
108+
109+
110+
111+
## Next
112+
113+
Continue with [exploring the features of the Gloo UI]({{< versioned_link_path fromRoot="/guides/observability/ui/explore" >}}).

‎docs/content/guides/traffic_management/extproc/about.md

-4
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@ With external processing, you can implement an external processing server that c
1212
External processing is an Enterprise-only feature.
1313
{{% /notice %}}
1414

15-
{{% notice warning %}}
16-
Envoy's external processing filter is considered a work in progress and has an unknown security posture. Use caution when using this feature in production environments. For more information, see the [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_proc_filter#external-processing).
17-
{{% /notice %}}
18-
1915
### How it works
2016

2117
The following diagram shows an example for how request header manipulation works when an external processing server is used.

‎docs/content/guides/traffic_management/extproc/header-manipulation.md

-5
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@ Set up an external processing (ExtProc) server that manipulates request headers
1010
External processing is an Enterprise-only feature.
1111
{{% /notice %}}
1212

13-
{{% notice warning %}}
14-
Envoy's external processing filter is considered a work in progress and has an unknown security posture. Use caution when using this feature in production environments. For more information, see the [Envoy documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/ext_proc_filter#external-processing).
15-
Note that as of Envoy 1.32, header manipulation via ExtProc does not support the [`append_action`](https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/base.proto#envoy-v3-api-msg-config-core-v3-headervalueoption) field.
16-
{{% /notice %}}
17-
1813
1. Before you begin, install [Gloo Gateway Enterprise]({{% versioned_link_path fromRoot="/installation/enterprise/" %}}) in your cluster.
1914

2015
2. Set up the ExtProc server. This example uses a prebuilt ExtProc server that manipulates request and response headers based on instructions that are sent in an `instructions` header.

‎docs/content/img/ui-dashboard.png

820 KB
Loading

‎docs/content/img/ui-graph.png

1.53 MB
Loading

‎docs/content/static/content/version-platform.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.7.0-rc2

‎docs/layouts/shortcodes/readfile.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
{{- else -}}
88

9-
{{$file := .Get "file"}}
10-
{{ if (fileExists $file ) -}}
11-
{{- if eq (.Get "markdown") "true" -}}
12-
{{- $file | readFile | markdownify -}}
13-
{{- else -}}
14-
{{ $file | readFile | safeHTML }}
15-
{{- end -}}
16-
{{- end -}}
9+
{{$file := .Get "file"}}
10+
{{- if (fileExists $file ) -}}
11+
{{- if eq (.Get "markdown") "true" -}}
12+
{{- $file | readFile | markdownify -}}
13+
{{- else -}}
14+
{{- $file | readFile | safeHTML -}}
15+
{{- end -}}
16+
{{- end -}}
1717

1818
{{- end -}}

0 commit comments

Comments
 (0)