docs: Update troubleshooting.rst with notes about docker buildkit #2
Conversation
docs/troubleshooting.rst
Outdated
| @@ -168,3 +168,25 @@ This issue should only happen in development mode. Long story short, it can be s | |||
| tutor dev run lms ./manage.py lms waffle_switch block_structure.invalidate_cache_on_publish on --create | |||
|
|
|||
| If you'd like to learn more, please take a look at `this Github issue <https://github.com/overhangio/tutor/issues/302>`__. | |||
|
|
|||
| Reoccuring error "ERR_SOCKET_TIMEOUT" on "tutor images build mfe" | |||
There was a problem hiding this comment.
This issue can happen while building any image, not just the mfe image. I suggest the following wording:
"ERR_SOCKET_TIMEOUT" error on ``tutor images build``
Also, please remove all references to MFE below.
docs/troubleshooting.rst
Outdated
| Reoccuring error "ERR_SOCKET_TIMEOUT" on "tutor images build mfe" | ||
| ----------------------------------------------------------------- | ||
|
|
||
| This issue can happen due to a network connection issue if occurs once or twice, but if the issue persists then it is due to high resourse consumption issue related to BuildKit for building simultaneously multiple MFEs enabled. |
There was a problem hiding this comment.
Try to make shorter sentences. For instance:
If this error happens just once or twice, it may be due to a network connection issue. But if the issue persists...
However, it is incorrect to say that a socket timeout error can be caused by high resource consumption. When the build fails because of hardware, the error is different -- can't remember which one, though. See this issue for more information: overhangio/tutor-mfe#125
Please rephrase, either by changing the error message, or by changing the proposed solution.
|
Why was this PR opened in the edly-io/tutor repo and not overhangio/tutor? |
|
This was my first PR and i was now sure to open in edly-io/tutor or overhangio/tutor. |
It adds a note in the troubleshooting guide, offering solution for mitigating resource consumption issues related to BuildKit when building Multiple Front-Ends (MFEs) using Tutor in the Open edX platform. The guide includes steps to configure BuildKit for reduced resource usage in order to prevent socket timeouts.