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

Add documentation around sync failure modes #6193

Open
2 of 3 tasks
lahabana opened this issue Jun 12, 2024 · 0 comments
Open
2 of 3 tasks

Add documentation around sync failure modes #6193

lahabana opened this issue Jun 12, 2024 · 0 comments
Assignees
Labels
area/docs release/required it is required that this be resolved before releasing
Milestone

Comments

@lahabana
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Does this enhancement require public documentation?

  • I have added an Acceptance Criteria item for adding and/or adjusting public documentation (if applicable)

Problem Statement

In docs it would be great to have a "failure mode" docs page which would explain what happens when different things happen.

Here are a few examples:

  • Error talking to k8s API server for some resources
  • Error in translation
  • Error in POST /config
  • Error in Konnect sync

TODO find a strict set of failure modes we want to start documenting.

Proposed Solution

No response

Additional information

No response

Acceptance Criteria

  • A docs page is added with different failure modes
@lahabana lahabana added this to the KIC v3.3.x milestone Jun 12, 2024
@lahabana lahabana added the release/required it is required that this be resolved before releasing label Jun 24, 2024
@randmonkey randmonkey self-assigned this Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs release/required it is required that this be resolved before releasing
Projects
None yet
Development

No branches or pull requests

2 participants