From c9f76564892c7cc9ec288c72e71ad231ccbbd9e9 Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Wed, 11 Sep 2019 14:53:03 -0400 Subject: [PATCH] doc: ulimit recommendations for local development (#6311) The default ulimit for open files on macOS is really small (256), which leads to "too many open files" errors during plugin launches if you're running unit tests in `drivers/docker`. Recommend setting `ulimit -n 1024`. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 799785457..bfa6996d0 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,12 @@ $ make bootstrap ... ``` +Nomad creates many file handles for communicating with tasks, log handlers, etc. +In some development environments, particularly macOS, the default number of file +descriptors is too small to run Nomad's test suite. You should set +`ulimit -n 1024` or higher in your shell. This setting is scoped to your current +shell and doesn't affect other running shells or future shells. + Afterwards type `make test`. This will run the tests. If this exits with exit status 0, then everything is working!