istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

documentation URL leads to 404 for istio Analysis objects in cluster

Open stefanandres opened this issue 7 months ago • 6 comments

Is this the right place to submit this?

  • [x] This is not a security vulnerability or a crashing bug
  • [x] This is not a question about how to use Istio

Bug Description

Hey, I've enabled Analysis for our istiod. After we've enabled it, we correctly get a populated status field like:

❯ k describe gw sandres-test-gw2
Name:         sandres-test-gw2
[...]
Status:
  Observed Generation:  1
  Validation Messages:
    Documentation URL:  https://istio.io/v1.26/docs/reference/config/analysis/ist0145/
    Level:              ERROR
    Type:
      Code:  IST0145

The documentation URL leads to a 404 though. I assume this is a bug.

Version

$ istioctl version
client version: 1.26.0
control plane version: 1.26.0
data plane version: 1.26.0 (377 proxies)

❯ kubectl version --short
error: unknown flag: --short
See 'kubectl version --help' for usage.

Additional Information

No response

stefanandres avatar May 13 '25 12:05 stefanandres

this's caused by not every code has a detail page.

https://istio.io/latest/docs/reference/config/analysis/

zirain avatar May 13 '25 13:05 zirain

That makes sense. I have no good idea how to mitigate this UX issue. I suppose the deployment itself doesn't know what page has actual content and can decide accordingly to display the main or the detailed page.

stefanandres avatar May 13 '25 13:05 stefanandres

TBH, I think we should have a page for every analyzer; especially as we use the URLs. We could mitigate this in the short term by using redirects, but that isn't hugely helpful and would be a burden to backport to older versions.

craigbox avatar May 15 '25 08:05 craigbox

(moved to the docs repo)

The FR here is thus to add Markdown pages for each analyzer that has been added since the initial docs were written. (Or since the last working bee: see https://github.com/istio/istio/issues/39911)

craigbox avatar May 15 '25 09:05 craigbox

Is this issue resolved or I should work on it @craigbox ?

Sukuna0007Abhi avatar May 21 '25 18:05 Sukuna0007Abhi

@Sukuna0007Abhi There's no PR referring to this issue, so I have no more knowledge than you do about anyone working on this!

craigbox avatar May 26 '25 23:05 craigbox