Skip to content
Open
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Add warning about open file limits to readme
  • Loading branch information
piemonkey committed Oct 17, 2023
commit c25bede3878f652687c3b57c2352295ff215c137
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Setting up your environment is done in three easy steps:
2. Then, configure how requests are dispatched in `config/dispatcher.ex`
3. Lastly, simply start the docker-compose.

> [!WARNING]
> Many of the containers used have issues with high limits on open file descriptors, so you might need [to work around this](#containers-stuck-while-starting-using-100-cpu)

#### Hooking things up with docker-compose

Alter the `docker-compose.yml` file so it contains all microservices you need. The example content should be clear, but you can find more information in the [Docker Compose documentation](https://docs.docker.com/compose/). Don't remove the `identifier` and `db` container, they are respectively the entry-point and the database of your application. Don't forget to link the necessary microservices to the dispatcher and the database to the microservices.
Expand All @@ -32,3 +35,29 @@ You can shut down using `docker-compose stop` and remove everything using `docke
## Tutorials

To help you find your feet with your first semantic works projects, we've collected [a few tutorials](TUTORIALS.md).

## Troubleshooting

### Containers stuck while starting, using 100% CPU
Some docker images used in mu-project, notably those based on sbcl (lisp) and elixir images, are very slow and CPU intensive to start if the limits of open file descriptors are very high for the container. This leads to a process using 100% of a CPU for some time before that container becomes usable. This can be worked around by setting the defaults for new containers in the docker daemon config (/etc/docker/daemon.json (create it if it doesn't exist)):

```json
{
"default-ulimits": {
"nofile": {
"Hard": 104583,
"Name": "nofile",
"Soft": 104583
}
}
}
```

Or, if you want these high defaults for some reason, you can set per-container limits in a docker-compose file for each of the mu-project services:

```yml
ulimits:
nofile:
soft: 104583
hard: 104583
```