Skip to content

Commit 3ed05a4

Browse files
authored
docs: fix observerURL browser-reachability guidance (#688)
- namespace-management: replace svc.cluster.local example with a placeholder and add a note explaining browser-reachability and CORS - multi-cluster-connectivity: correct the reachability note and add a CORS callout in the Register Observability Plane section - multi-cluster-connectivity: add a note that the Helm command shows only Cluster Agent flags; full observer config (gateway, OIDC, CORS) should be taken from the On Your Environment guide Signed-off-by: Rashad Sirajudeen <rashad@wso2.com>
1 parent c12bde0 commit 3ed05a4

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

docs/platform-engineer-guide/multi-cluster-connectivity.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ EOF
375375

376376
### Register an Observability Plane
377377

378-
The `observerURL` must be reachable from the Control Plane cluster. In multi-cluster setups this cannot be an in-cluster `svc.cluster.local` address. Use the Observability Plane's external gateway URL or a routable DNS name instead.
378+
The `observerURL` must be reachable from the **user's browser** — the portal fetches telemetry directly from the Observer. Use the Observability Plane's external gateway URL and ensure `cors.allowedOrigins` includes the portal origin (e.g. `https://console.${DOMAIN}`) — see the [On Your Environment](../getting-started/try-it-out/on-your-environment.mdx) guide for the full gateway and CORS configuration.
379379

380380
```bash
381381
AGENT_CA=$(kubectl --context $REMOTE_CONTEXT get secret cluster-agent-tls \

docs/platform-engineer-guide/namespace-management.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,11 +328,15 @@ spec:
328328
clientCA:
329329
value: |
330330
$(echo "$OP_CA_CERT" | sed 's/^/ /')
331-
observerURL: http://observer.openchoreo-observability-plane.svc.cluster.local:8080
331+
observerURL: https://observer.<your-obs-domain>
332332
EOF`}
333333

334334
</CodeBlock>
335335

336+
:::note
337+
`observerURL` must be a browser-reachable HTTPS URL — the portal fetches telemetry directly from the Observer. Use the Observer's gateway-exposed hostname and ensure `observer.cors.allowedOrigins` includes the portal origin. See [On Your Environment](../getting-started/try-it-out/on-your-environment.mdx) for example gateway and CORS configuration.
338+
:::
339+
336340
**Verification:**
337341

338342
<CodeBlock language="bash">

0 commit comments

Comments
 (0)