Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Autogenerated reference doc for policies is misleading #2167

Open
Automaat opened this issue Feb 7, 2025 · 4 comments
Open

Autogenerated reference doc for policies is misleading #2167

Automaat opened this issue Feb 7, 2025 · 4 comments
Labels
kind/bug A bug triage/accepted The issue was reviewed and is complete enough to start working on it

Comments

@Automaat
Copy link
Contributor

Automaat commented Feb 7, 2025

Kuma Version

all

Describe the bug

Right now when we autogenerate reference doc for policy we do it from generic API for policy, so all targetRefs can accept all kinds, also we list all fields from targetRef. This ends up with a situation where our customers try to build policies based on this reference, but they end up debugging their policies based on errors from validators.

Expected behavior

We should properly generate this reference, or we should generate reference only for default fields which contains actual configuration of given policy

Additional context (optional)

https://kongstrong.slack.com/archives/C0164PPUSFP/p1738887785829129

https://kuma.io/docs/2.9.x/policies/meshloadbalancingstrategy/#all-policy-options

@Automaat Automaat added kind/bug A bug triage/pending This issue will be looked at on the next triage meeting labels Feb 7, 2025
@michaelbeaumont
Copy link
Contributor

I think we could fix the CRDs, the source of everything.

@lahabana
Copy link
Contributor

lahabana commented Feb 7, 2025

@Automaat this is more a Kuma issue no?

@Automaat
Copy link
Contributor Author

@lahabana If we only render stuff that is fully generated by kuma, then probably this should be a Kuma issue

@lukidzi
Copy link
Contributor

lukidzi commented Feb 10, 2025

Triage: For now. we are going to remove targetRef from this place and we can link to the targetRef docs. Future, should we have policy-specific targetRef docs(manually or automatically )? After removing an open issue to improve policy specific targetRef

@lukidzi lukidzi added triage/accepted The issue was reviewed and is complete enough to start working on it and removed triage/pending This issue will be looked at on the next triage meeting labels Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug A bug triage/accepted The issue was reviewed and is complete enough to start working on it
Projects
None yet
Development

No branches or pull requests

4 participants