Skip to content

Commit 4d64993

Browse files
committed
docs(monitoring): add yaml and platform ui tabs to connector secret section
1 parent b882ef4 commit 4d64993

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

platform/maintenance/monitoring/fleet/install-observability-gateway.mdx

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ sidebar_position: 2
55
description: Create a fleet observability connector that deploys the Write Gateway and Query Proxy for fleet monitoring.
66
---
77

8+
import Tabs from "@theme/Tabs";
9+
import TabItem from "@theme/TabItem";
10+
import Flow, { Step } from "@site/src/components/Flow";
11+
import Button from "@site/src/components/Button";
12+
import Label from "@site/src/components/Label";
13+
814
The observability gateway runs in the vCluster Platform namespace. It contains two
915
containers:
1016

@@ -35,6 +41,15 @@ Create one fleet observability connector in the Platform namespace. The fleet co
3541
must use the name `fleet-observability` and the label
3642
`loft.sh/fleet-observability-connector: "true"`.
3743

44+
<Tabs
45+
defaultValue="yaml"
46+
values={[
47+
{ label: "YAML", value: "yaml" },
48+
{ label: "Platform UI", value: "ui" },
49+
]}
50+
>
51+
<TabItem value="yaml">
52+
3853
```yaml title="fleet-observability-connector.yaml"
3954
apiVersion: v1
4055
kind: Secret
@@ -56,6 +71,38 @@ Apply the Secret:
5671
kubectl apply -f fleet-observability-connector.yaml
5772
```
5873

74+
</TabItem>
75+
<TabItem value="ui">
76+
77+
<Flow>
78+
<Step>
79+
Click <Label>Connectors</Label> and select the <Label>Observability</Label> tab.
80+
</Step>
81+
<Step>
82+
Click <Button>Connect Observability</Button>.
83+
</Step>
84+
<Step>
85+
In the <Label>Display name</Label> field, enter a human-readable name for the connector.
86+
The <Label>Observability Connector ID</Label> is auto-generated from the display name.
87+
For the fleet connector, use a display name that resolves to the ID `fleet-observability`.
88+
</Step>
89+
<Step>
90+
In the <Label>Metrics Backend OTLP Endpoint</Label> field, enter the OTLP endpoint that receives metrics from the Write Gateway.
91+
</Step>
92+
<Step>
93+
In the <Label>Metrics Backend PromQL Endpoint</Label> field, enter the Prometheus HTTP API endpoint queried by the Query Proxy.
94+
</Step>
95+
<Step>
96+
Optionally configure TLS for the metrics backend and the gateway. See [Connector keys](#connector-keys) for the available settings.
97+
</Step>
98+
<Step>
99+
Click <Button>Connect Observability</Button>.
100+
</Step>
101+
</Flow>
102+
103+
</TabItem>
104+
</Tabs>
105+
59106
Platform reconciles the following resources:
60107

61108
- `Deployment/gateway-fleet-observability`

0 commit comments

Comments
 (0)