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

Added inotify docs #62

Merged
merged 3 commits into from
Oct 17, 2024
Merged
Changes from 2 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
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 depend on the number of Flow projects you have, and the number of other apps that adds file watches.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The ideal number of watches depend on the number of Flow projects you have, and the number of other apps that adds file 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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Amanda,
Updated at: 61f7b65

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].
Loading