Update troubleshooting guide #3552
Merged
Conversation
This file contains 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
Signed-off-by: David Espejo <[email protected]>
Merge upstream branch
Signed-off-by: David Espejo <[email protected]>
Signed-off-by: David Espejo <[email protected]>
Signed-off-by: David Espejo <[email protected]>
Signed-off-by: David Espejo <[email protected]>
Signed-off-by: David Espejo <[email protected]>
2 tasks
davidmirror-ops
added
the
documentation
cosmicBboy
reviewed
Apr 20, 2023
There was a problem hiding this comment.
let's convert all the headers that use ~ to use ^ (see here)
rsts/community/troubleshoot.rst
Outdated
|
|
||
| .. tags:: Troubleshoot, Basic | ||
|
|
||
| .. admonition:: Why did we craft this guide? | ||
| The content in this section will help Flyte users isolate the most possible causes for some of the common issues that could arise while getting started with the project. |
There was a problem hiding this comment.
Suggested change
| The content in this section will help Flyte users isolate the most possible causes for some of the common issues that could arise while getting started with the project. | |
| The content in this section will help Flyte users isolate the most probable causes for some of the common issues that could arise while getting started with the project. |
|
|
||
| How Do I Debug? | ||
| """"""""""""""" | ||
| $ kubectl describe pod <PodName> -n <namespace> |
There was a problem hiding this comment.
might be worth calling out that <PodName> will typically correspond to the node execution string that you can find in the UI
|
|
||
| .. prompt:: bash $ | ||
|
|
||
| docker ps | ||
| $ kubectl logs pods -n <namespace> |
There was a problem hiding this comment.
also might be worth calling out that <namespace> will typically be the Flyte <project>-<domain>, e.g. flytesnacks-development
|
|
||
| .. code-block:: | ||
| Depending on the contents of the logs or the `Events`, you can try different things: |
There was a problem hiding this comment.
can we group all the errors here into another subheading? So similar to "Issues running workloads", maybe we can add a header in this section like "Debugging common execution errors"
Signed-off-by: David Espejo <[email protected]>
Signed-off-by: David Espejo <[email protected]>
Signed-off-by: David Espejo <[email protected]>
cosmicBboy
approved these changes
Apr 20, 2023
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.
Tracking issue
Implements the idea of #3340
Describe your changes
Check all the applicable boxes
Screenshots
Note to reviewers