Debulleting the Porch Troubleshooting pages#1024
Open
lovesprung wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for kpt-porch ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR updates troubleshooting and disaster recovery documentation to improve phrasing and consolidate some bullet lists into inline sentences.
Changes:
- Reworded several “Problem/Solutions/Common causes” entries in repository sync troubleshooting.
- Flattened nested bullet lists and converted some subheadings into bold inline labels in disaster recovery docs.
- Minor grammar/wording adjustments (“aren’t” → “are not”, etc.).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/content/en/docs/9_troubleshooting_and_faq/repository-sync/_index.md | Rephrases troubleshooting items and condenses lists into sentences. |
| docs/content/en/docs/9_troubleshooting_and_faq/disaster-recovery/_index.md | Refactors list formatting and replaces some headings with bold labels in scenarios. |
|
|
||
| #### Data stores lost: | ||
| - Kubernetes control plane: entire Kubernetes cluster deleted | ||
| **Data stores lost:** Kubernetes control plane. The entire Kubernetes cluster deleted. |
| repositories are deemed Ready | ||
| - **Porch API will be unavailable** to perform operations on package revisions | ||
| - `get` or `list` operations can be used to monitor Porch for API availability and repository status | ||
| **Data stores lost:** None. Porch will immediately begin to re-sync all repositories, resulting in a **decrease in quality of service** until all repositories are deemed Ready. **Porch API will be unavailable** to perform operations on package revisions You can use `get` or `list` operations to monitor Porch for API availability and repository status. |
| - Invalid cron expression falls back to default frequency | ||
| - Repository authentication issues | ||
| - Network connectivity problems | ||
| **Common causes** invalid cron expression falls back to default frequency, repository authentication issues or network connectivity problems. |
| **Solutions**: | ||
| - Ensure timestamp is at least 1 minute in future | ||
| - Verify namespace is correct | ||
| **Solutions**: Ensure the timestamp is at least 1 minute in future and verify that the namespace is correct. |
Comment on lines
+29
to
+31
| - **custom resource objects on the Kubernetes control plane**, such as Porch repositories (Repository objects), package variants (and by extension package variant sets) and **if** the CR cache is configured, "work-in-progress" package revisions whose lifecycle stage is "Draft", "Proposed", or "DeletionProposed" | ||
| - **Git repositories**, such as package revisions (Kpt package file contents and directory structures) | ||
| - **Package revision cache**, such as Kubernetes-related metadata for package revisions (for example, labels and annotations) and **if** the DB cache is configured, "work-in-progress" package revisions whose lifecycle stage is "Draft", "Proposed", or "DeletionProposed" |
Signed-off-by: Dominika Schweier <dominika.schweier@nokia.com>
lovesprung
force-pushed
the
debulleting_troubleshooting
branch
from
34c0c38 to
aa6156d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Title
Debulleting the Porch Troubleshooting pages
Description
Minor rewrites to make the text more readable.
Type of Change
Checklist