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 troubleshooting guide #875

Merged
merged 13 commits into from
Jan 15, 2020
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions public/static/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@
"label": "Running DVC on Windows",
"slug": "running-dvc-on-windows"
},
{
"label": "Troubleshooting guide",
"slug": "troubleshooting"
},
{
"label": "Anonymized Usage Analytics",
"slug": "analytics"
Expand Down
17 changes: 17 additions & 0 deletions public/static/docs/user-guide/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Troubleshooting

In this section we provide help for some of the problems that DVC user might
stumble upon.

<h2 id="many-files">Too many open files error</h2>

A known problem some users run into with the `dvc pull`, `dvc fetch` and
`dvc push` commands is `[Errno 24] Too many open files` (most common for S3
remotes on MacOS). The more `--jobs` specified, the more file descriptors need
to be open on the host file system for each download thread, and the limit may
be reached, causing this error.

To solve this, it's often possible to increase the open file descriptors limit,
with `ulimit` on UNIX-like system (for example `ulimit -n 1024`), or
[increasing Handles limit](https://blogs.technet.microsoft.com/markrussinovich/2009/09/29/pushing-the-limits-of-windows-handles/)
on Windows. Otherwise, please try using a lower `JOBS` value.
7 changes: 7 additions & 0 deletions server.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ app.prepare().then(() => {
: pathname)
})
res.end()
} else if (req.headers.host === 'error.dvc.org') {
shcheklein marked this conversation as resolved.
Show resolved Hide resolved
// error.dvc.org/{hdr} -> dvc.org/doc/user-guide/troubleshooting#{hdr},
res.writeHead(301, {
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
'Cache-Control': 'no-cache',
Location: `https://dvc.org/doc/user-guide/troubleshooting#${pathname}`
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
})
res.end()
} else if (/^(code|data|remote)\.dvc\.org$/.test(req.headers.host)) {
// {code/data/remote}.dvc.org -> corresponding S3 bucket
res.writeHead(301, {
Expand Down