A tool to notify Docker contianers about changes in mounts on Bash for Windows.
Project description
Docker Bash Volume Watcher
==============================
This fork takes merofeev's `docker-windows-volume-watcher<https://github.com/merofeev/docker-windows-volume-watcher>`_ and makes it work with Bash for Windows (aka Ubuntu on Windows)
The script monitors directory bindings of Docker containers on Windows hosts and notifies containers about file changes.
The script aims to be workaround for the problem of file change events propagation on Windows hosts. Due to limitations of CIFS implementation in Linux kernel, file change events in mounted folders of host are not propagated to container by Docker for Windows. This problem renders watch mode of modern frameworks (e.g. Jekyll, ng-cli, etc.) development servers useless, since containers are not notified about file changes. This problem is described on `Docker Community Forums <https://forums.docker.com/t/file-system-watch-does-not-work-with-mounted-volumes/12038>`_.
Installation
------------
This script can be installed with pip (both Python 2 & 3 are supported).
.. code:: bat
pip install docker-bash-volume-watcher
Usage
-----
Monitor all directory bindings of all containers. The script will listen for container start/stop events and notify all running containers about file changes.
.. code:: bat
docker-volume-watcher
Monitor only bindings of container ``container_name``.
.. code:: bat
docker-volume-watcher container_name
Monitor only binding of ``container_name`` in sub directory ``/not_node_modules``.
.. code:: bat
docker-volume-watcher container_name /not_node_modules
You can also specify wildcards with ``*`` and ``?`` characters. For example: monitor only bindings of containers with names containing `myproject`.
.. code:: bat
docker-volume-watcher *myproject*
Use flag ``-v`` to enable verbose output: the script will report start/stop events of eligible containers and print all detected file changes.
Limitations
------------
* The script doesn't propagate to container file deletion events.
* The script requires ``stat`` and ``chmod`` utils to be installed in container (this should be true by default for the most of containers).
Implementation details
-----------------------
The script uses ``watchdog`` package to observe file change events of the host directory. Once file change event is fired the script reads file permissions of changed file (using `stat` util) and rewrites file permissions with the same value (using ``chmod`` util) thus triggering inotify event inside container.
"Rewrite file permissions approach" was used instead of updating file last modified time with ``touch`` util. Since touching will cause event loop: touch will trigger file change event in Windows, script will handle this event and touch file again, etc.
==============================
This fork takes merofeev's `docker-windows-volume-watcher<https://github.com/merofeev/docker-windows-volume-watcher>`_ and makes it work with Bash for Windows (aka Ubuntu on Windows)
The script monitors directory bindings of Docker containers on Windows hosts and notifies containers about file changes.
The script aims to be workaround for the problem of file change events propagation on Windows hosts. Due to limitations of CIFS implementation in Linux kernel, file change events in mounted folders of host are not propagated to container by Docker for Windows. This problem renders watch mode of modern frameworks (e.g. Jekyll, ng-cli, etc.) development servers useless, since containers are not notified about file changes. This problem is described on `Docker Community Forums <https://forums.docker.com/t/file-system-watch-does-not-work-with-mounted-volumes/12038>`_.
Installation
------------
This script can be installed with pip (both Python 2 & 3 are supported).
.. code:: bat
pip install docker-bash-volume-watcher
Usage
-----
Monitor all directory bindings of all containers. The script will listen for container start/stop events and notify all running containers about file changes.
.. code:: bat
docker-volume-watcher
Monitor only bindings of container ``container_name``.
.. code:: bat
docker-volume-watcher container_name
Monitor only binding of ``container_name`` in sub directory ``/not_node_modules``.
.. code:: bat
docker-volume-watcher container_name /not_node_modules
You can also specify wildcards with ``*`` and ``?`` characters. For example: monitor only bindings of containers with names containing `myproject`.
.. code:: bat
docker-volume-watcher *myproject*
Use flag ``-v`` to enable verbose output: the script will report start/stop events of eligible containers and print all detected file changes.
Limitations
------------
* The script doesn't propagate to container file deletion events.
* The script requires ``stat`` and ``chmod`` utils to be installed in container (this should be true by default for the most of containers).
Implementation details
-----------------------
The script uses ``watchdog`` package to observe file change events of the host directory. Once file change event is fired the script reads file permissions of changed file (using `stat` util) and rewrites file permissions with the same value (using ``chmod`` util) thus triggering inotify event inside container.
"Rewrite file permissions approach" was used instead of updating file last modified time with ``touch`` util. Since touching will cause event loop: touch will trigger file change event in Windows, script will handle this event and touch file again, etc.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for docker-bash-volume-watcher-1.0.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa53697aee66479abd663c50cc6a3c48f4242c99f912371ed09d0980209219ca |
|
MD5 | 26e0050e04cb030b78c9e56e7dba83a6 |
|
BLAKE2b-256 | 3cfc3a56983f1606e7bc58bbb04e6920d3c5412b2b585807a1e6162796a41eb4 |
Close
Hashes for docker_bash_volume_watcher-1.0.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa1580bd394a504784f223251082638ee16852cfed996c1568f2c62bfb4f5c8d |
|
MD5 | 5d8bc33bab130e9d07b6ebdedf7b0962 |
|
BLAKE2b-256 | b5b57f29a8aec5f08a4ded251b8ea24871c66e4c1bb713346f8dc9790a11a214 |