Skip to content

Commit

Permalink
Added inotify docs (#62)
Browse files Browse the repository at this point in the history
# Description of change

Added inotify file watcher information.
See: https://hazelcast.atlassian.net/browse/HZX-227

## Type of change

Select the type of change that you're making:

- [X] Enhancement (Adds new content)
  • Loading branch information
yuce authored Oct 17, 2024
1 parent 5070450 commit 1968d83
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/modules/deploy/pages/development-deployments.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,39 @@ With examples for:
* Using external IDP config
* Configuring to include metrics

== File Watcher Settings

Flow watches the project directories in the file system to automatically load the changes.
It uses the **inotify** mechanism on Linux.
Linux systems have a limited number of watches available by default.
Sometimes this limit is too low, so you may have to set it to a higher value.

To check the current watch limit, run the following:

[source, bash]
----
sysctl fs.inotify.max_user_watches
----

The ideal number of watches depends on the number of Flow projects you have, and the number of other apps that add file watches.
For many use cases, `250 000` would be a sensible choice.

You can set the number of file watches limit temporarily using the following commands:

[source,bash]
----
sudo sysctl fs.inotify.max_user_watches=250000
sudo sysctl -p
----

To set the limit permanently, you can run the following:

[source,bash]
----
echo fs.inotify.max_user_watches=250000 | sudo tee -a /etc/sysctl.conf
sudo sysctl -p
----

== Continue reading

Continue learning about {short-product-name} by xref:workspace:overview.adoc[setting up your workspace] or investigating how to xref:deploy:production-deployments.adoc[deploy in production].

0 comments on commit 1968d83

Please sign in to comment.