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

docs: update troubleshooting guide with latest conditions #798

Merged
merged 5 commits into from
May 24, 2024

Conversation

britaniar
Copy link
Contributor

Description of your changes

Fixes #

I have:

  • Run make reviewable to ensure this PR is ready for review.

How has this code been tested

Special notes for your reviewer

@britaniar britaniar marked this pull request as ready for review May 8, 2024 00:44
@britaniar britaniar requested a review from Arvindthiru May 8, 2024 01:27
@Arvindthiru
Copy link
Contributor

We also need to add example cases for,

  • ClusterResourcePlacementOverridden (Override API related issue)
  • ClusterResourcePlacementWorkSynchronized
  • ClusterResourcePlacementAvailable (Advanced rollout workload resources not available)

@britaniar britaniar marked this pull request as draft May 8, 2024 15:19
@britaniar britaniar force-pushed the docsTroubleshoot branch 2 times, most recently from f63f8ed to dcab9e8 Compare May 14, 2024 19:46
@Arvindthiru
Copy link
Contributor

Arvindthiru commented May 15, 2024

Couple of suggestions,

  • This TSG is huge (in terms of cognitive load) and since we will be using this as our primary TSG it would be better to split each condition into a separate .md file and add a separate index file with links to other files.
  • Please add a list of common failure scenarios for all conditions.
  • And since conditions are updated in order, we can also suggest users to look into logs for specific controllers when a condition is set to false to narrow down scope for example,
    • Scheduled condition is false something is wrong within the scheduler
    • RolloutStarted failed something went wrong in the rollout controller
    • WorkApplied is false something went wrong when applying manifest in apply controller

These suggestions can be handled in a separate PR

@britaniar britaniar marked this pull request as ready for review May 15, 2024 22:09
@ryanzhang-oss ryanzhang-oss merged commit 5832461 into Azure:main May 24, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants