wu-sheng opened a new pull request, #13888:
URL: https://github.com/apache/skywalking/pull/13888

   ### Fix incorrect Horizon UI setup documentation
   - [ ] Add a unit test to verify that the fix works. (N/A — documentation 
only)
   - [x] Explain briefly why the bug exists and how to fix it.
   
   The Horizon UI setup docs predated Horizon UI's settled configuration 
surface and were factually wrong on three counts:
   
   1. **Registry** — they pointed operators at the GHCR dev registry for 
production. Released images are mirrored to Docker Hub `apache/skywalking-ui` 
(tags `latest` / `horizon-<version>`); `ghcr.io/apache/skywalking-horizon-ui` 
is per-commit/dev only.
   2. **Port** — the `docker run` example used `8080`. Horizon UI's BFF binds 
**8081** (`EXPOSE 8081`).
   3. **Configuration** — they documented `SW_OAP_ADDRESS` / `SW_ADMIN_ADDRESS` 
/ `SW_ZIPKIN_ADDRESS` environment variables that **Horizon UI does not read**. 
It is configured via a mounted `horizon.yaml` (`oap.queryUrl` / `oap.adminUrl` 
/ `oap.zipkinUrl`), so the old example could not have worked.
   
   This PR corrects those and applies the same registry/version policy across 
the docs:
   
   - `setup/backend/ui-setup.md` — rewritten: Docker Hub image, port 8081, 
`horizon.yaml` config, no-default-login note, **no Horizon UI version lock** 
(OAP `11.0+` supported; compatibility is Horizon UI's responsibility), 
high-level "what Horizon provides", and links to the Horizon UI website docs 
only.
   - `ui/README.md` — drop the source-code link; describe the bundled set 
(default per-layer dashboard configs, overview / 3D infra-map setups, sidebar 
menu, i18n) at a high level.
   - `changes/changes.md` — fix the 11.0.0 breaking-change entry's registry + 
upgrade-path references; unlock the version.
   - `setup/backend/backend-telemetry.md` + 
`academy/diagnose-service-mesh-network-performance-with-ebpf.md` — Helm 
`ui.image.repository=apache/skywalking-ui`, decouple the UI tag from the OAP 
`$TAG`.
   - `guides/How-to-release.md` — distinguish Docker Hub (releases) from GHCR 
(per-commit dev).
   
   Verified against the Horizon UI source (`apache/skywalking-horizon-ui`, 
incl. `publish-image.yaml`, `horizon.example.yaml`, `docs/`) and the 
`skywalking-helm` chart (`ui-svc.yaml`: Service port `80` → targetPort `8081`, 
and `values.yaml` which documents the same registry policy).
   
   - [ ] If this pull request closes/resolves/fixes an existing issue, replace 
the issue number. Closes #<issue number>.
   - [ ] Update the [`CHANGES` 
log](https://github.com/apache/skywalking/blob/master/docs/en/changes/changes.md).
 (Documentation correction — no new functional change to log; this PR corrects 
an existing 11.0.0 entry.)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to