Docs : Add Known Issues and Limitations in FAQ section #635

Kavish-12345 · 2025-08-16T10:35:40Z

Summary

Adds a new "Known Issues and Limitations" section to the FAQ page as requested in the community call decision.

Changes

Documented 4 current known issues from GitHub repository:
Documented current limitations.
Added community contribution guidelines.
Included links to GitHub Issues, community calls, and Slack

Addresses

Provides well-maintained enumerated list as specifically requested
Located in FAQ section as specified in issue

Fixes #621

>> - Current list of known issues >> - Limitations mentioned >> - Additional information also included

Kavish-12345 · 2025-08-16T18:06:21Z

Hi @jakobmoellerdev , could you take a look at my PR and let me know if any changes are required?

jakobmoellerdev

Thanks for opening a PR for this!

jakobmoellerdev · 2025-08-16T20:55:50Z

website/docs/docs/faq.md

+   - **Workaround**: Manual recreation of deleted resources required
+   - **GitHub Issue**: [#520](https://github.com/kro-run/kro/issues/520)
+
+   **2. RGD instances stuck in "IN_PROGRESS" status**


I believe any issue under investigation should not be part of a known issues section, we have tons of those and updating this section should be reserved only for the most frequently observed and problemnatic ones

jakobmoellerdev · 2025-08-16T20:56:34Z

website/docs/docs/faq.md

+   - **Impact**: ResourceGraphDefinition CRD and APIs are not solidified and subject to change
+   - **Recommendation**: Use only for development and testing environments
+
+   **2. API stability**


This is the same as lacking production readiness

jakobmoellerdev · 2025-08-16T20:56:42Z

website/docs/docs/faq.md

+   - **Impact**: Upgrades may require manual migration of existing ResourceGraphDefinitions
+   - **Recommendation**: Plan for potential breaking changes during upgrades
+
+   **3. Resource dependency complexity**


this is not a limitation, but a UX challenge, should not be part of this section IMO

jakobmoellerdev · 2025-08-16T20:57:16Z

website/docs/docs/faq.md

+   - **Workaround**: Manual validation of schema changes required
+   - **GitHub Issue**: [#186](https://github.com/kro-run/kro/issues/186)
+
+   **4. SNS topic creation failures**


Very specific bug report, not sure if this should be adopted here

jakobmoellerdev · 2025-08-16T20:58:04Z

website/docs/docs/faq.md

+   **3. Missing detection of CRD breaking changes**
+
+   - **Impact**: Kro does not detect breaking changes in ResourceGroup schemas when modified
+   - **Status**: Feature enhancement needed


why is this under feature enhancement needed when there when we even have an upcoming change here? #352

jakobmoellerdev · 2025-08-16T20:58:48Z

website/docs/docs/faq.md

+   **1. Kro does not detect deleted resources**
+
+   - **Impact**: Deleted resources from kro instances are not detected and recreated automatically
+   - **Status**: Open bug


this issue has not been confirmed

jakobmoellerdev · 2025-08-16T20:59:27Z

website/docs/docs/faq.md

+
+   This section is community-maintained:
+
+   - Found a recurring issue? Check if it's already tracked in our [GitHub Issues](https://github.com/kro-run/kro/issues)


I think this section should be replaced with a link to https://github.com/kro-run/kro/blob/main/CONTRIBUTING.md#reporting-bugsfeature-requests

jakobmoellerdev · 2025-08-16T20:59:56Z

website/docs/docs/faq.md

+
+
+
+   **Stay Updated**


This is duplicate maintenance of https://github.com/kro-run/kro?tab=readme-ov-file#community-participation

Kavish-12345 · 2025-08-17T17:30:16Z

@jakobmoellerdev Thank you for the guidance! I realized I had misinterpreted a few points earlier, which led to some mistakes. I’ve revised the section by removing duplicates and unconfirmed items, merging overlaps, and keeping only confirmed issues and key limitations. Requesting your review — happy to make further changes if needed.

jakobmoellerdev · 2025-08-18T17:38:13Z

website/docs/docs/faq.md

   solidified and highly subject to change.
+
+
+6. **What are the current known issues and limitations?**


I believe we can introduce a separate page for this next to FAQ and link it here, considering this will likely maintained separatey

@jakobmoellerdev Ok.

jakobmoellerdev · 2025-08-18T17:38:31Z

website/docs/docs/faq.md

+
+   This section documents the most frequently observed and problematic issues reported by the kro community.
+
+    **Current Known Issues**


Im missing a reference to the Roadmap and Dynamic Watches

jakobmoellerdev · 2025-08-18T17:39:38Z

website/docs/docs/faq.md

+   - **Impact**: Wrong API endpoints used with Fleet and other GitOps tools causing integration failures
+   - **Status**: Confirmed integration problem affecting GitOps workflows
+   - **Workaround**: Manual intervention or alternative deployment strategies  
+   - **GitHub Issue**: [#524](https://github.com/kro-run/kro/issues/524)


Im not sure if this is really the right issue / relevance. we really only deal with an inflection issue here no?

jakobmoellerdev · 2025-08-18T17:40:07Z

website/docs/docs/faq.md

+   - **Impact**: Some resources may not be created when ResourceGraphDefinitions have complex dependencies, particularly with topological sorting issues
+   - **Status**: Confirmed issue affecting multiple users
+   - **Workaround**: Simplify resource dependencies or manually verify all resources are created
+   - **GitHub Issue**: [#225](https://github.com/kro-run/kro/issues/225)


Did you verify that #225 is still valid? I think this could just be a leftover

jakobmoellerdev · 2025-08-18T17:40:58Z

website/docs/docs/faq.md

+   **2. CEL expression observability**
+   - **Limitation**: No visibility into CEL expression execution costs, evaluation performance, or debugging information
+   - **Impact**: Difficult to troubleshoot and optimize complex ResourceGraphDefinitions when CEL expressions are expensive or fail
+   - **Status**: Architectural gap in observability framework


I dont think this is a framework issue, rather something we just didnt implement in the project yet. There was even a PR but that was rejected for formality reasons

jakobmoellerdev · 2025-08-18T17:41:50Z

website/docs/docs/faq.md

+   - **Impact**: When Platform teams modify ResourceGraphDefinition schemas, there's no migration path for existing instances created by Developer teams
+   - **Status**: Major architectural limitation blocking production adoption  
+   - **Workaround**: Manual recreation of all instances when RGD schemas change
+   - **Community Impact**: Most frequently reported limitation preventing enterprise use


Why have community impact and impact? this is redundant for me

I was going through this blog

I see the following big ideas the team is going to work on.

Resource group versioning Resource change management External references and adoption Building collections (with for loop-like support) Garbage collection Enhanced status reporting Enhanced security integrations

Addressing RGD versioning is a definite requirement.

This was not the point of my comment. My point was that you have a statement "Impact" and "Community Impact" which looks / reads redundantly

Apart from that the blog you linked is from 12 NOV 2024 so I dont think you should take this as a source of truth.

for the first point I see recently there is proposal for it.

Kavish-12345 · 2025-08-21T20:59:30Z

@jakobmoellerdev Could you please give me some idea that how to structure this section and i tried to incorporate the relevant things but it's not matching the requirements for this section. Also tell me that if i have to create a separate page for this section as it will require management after this also.

jakobmoellerdev · 2025-08-29T16:32:21Z

I think I gave a rather detailed review here so im wondering what you need on top of this?

Kavish-12345 · 2025-08-31T17:18:53Z

@jakobmoellerdev Thank you for the detailed review. I was occupied with some events over the past week, but I’ll be resuming work on it tomorrow.

k8s-triage-robot · 2025-09-12T20:37:36Z

Unknown CLA label state. Rechecking for CLA labels.

Send feedback to sig-contributor-experience at kubernetes/community.

/check-cla
/easycla

linux-foundation-easycla · 2025-09-12T20:37:43Z

❌ - login: @Kavish-12345 / name: Kavish-12345 . The commit (2075c8f, 253f0bc) is not authorized under a signed CLA. Please click here to be authorized. For further assistance with EasyCLA, please submit a support request ticket.

a-hilaly

Thanks for working on this! I noticed some of the items listed might be better suited for our issue tracker rather than documentation. Several appear to be bugs or features in development rather than permanent limitations.

I'm thining ...perhaps we could mention design docs or upcoming features where we're actively seeking community feedback? That would be more forward looking and valuable for users who want to contribute to the project's direction, rather than listing current bugs that might give the wrong impression about stability.

a-hilaly · 2025-09-14T06:57:21Z

@Kavish-12345 can you please sign the CLA?

a-hilaly · 2025-09-14T07:23:21Z

/hold

a-hilaly · 2025-10-08T01:27:51Z

closing to continue the discussion in the github issue #621 (comment)

Kavish-12345 force-pushed the add-known-issues-section branch from b2f01bf to 570de89 Compare August 16, 2025 10:39

Addition of Known issues and limitations in the FAQ section

253f0bc

>> - Current list of known issues >> - Limitations mentioned >> - Additional information also included

Kavish-12345 force-pushed the add-known-issues-section branch from 570de89 to 253f0bc Compare August 16, 2025 10:40

jakobmoellerdev reviewed Aug 16, 2025

View reviewed changes

Changes as per the feedback

2075c8f

jakobmoellerdev reviewed Aug 18, 2025

View reviewed changes

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Sep 12, 2025

a-hilaly reviewed Sep 14, 2025

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 14, 2025

a-hilaly closed this Oct 8, 2025


		This section is community-maintained:

		- Found a recurring issue? Check if it's already tracked in our [GitHub Issues](https://github.com/kro-run/kro/issues)

		solidified and highly subject to change.


		6. What are the current known issues and limitations?


		This section documents the most frequently observed and problematic issues reported by the kro community.

		Current Known Issues

Uh oh!

Docs : Add Known Issues and Limitations in FAQ section #635

Docs : Add Known Issues and Limitations in FAQ section #635

Uh oh!

Conversation

Kavish-12345 commented Aug 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Addresses

Uh oh!

Kavish-12345 commented Aug 16, 2025

Uh oh!

jakobmoellerdev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kavish-12345 commented Aug 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kavish-12345 commented Aug 21, 2025

Uh oh!

jakobmoellerdev commented Aug 29, 2025

Uh oh!

Kavish-12345 commented Aug 31, 2025

Uh oh!

k8s-triage-robot commented Sep 12, 2025

Uh oh!

linux-foundation-easycla bot commented Sep 12, 2025

Uh oh!

a-hilaly left a comment

Choose a reason for hiding this comment

Uh oh!

a-hilaly commented Sep 14, 2025

Uh oh!

a-hilaly commented Sep 14, 2025

Uh oh!

a-hilaly commented Oct 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Kavish-12345 commented Aug 16, 2025 •

edited

Loading